software maintenance

Result Tables =
Documentation

Noise Calculations are a valuable tool when presented with quality Documentation and Graphics to clarify the findings to the client and to the public. SoundPLAN's Documentation and Graphics are second to none. They set the standard.

We discuss the Documentation in this area of the web because it is so important. However, it is not a separate module, but is part of every SoundPLAN program and available to every user.

Documentation Requirements

•Noise maps for big areas should be divided into logical units.
•SoundPLAN's input data is organized in logical units called Geo-Files and Situations. Situations can contain one or more Geo-Files.
•When many files are used and the probablity of many file revisions is high, the user should have the discipline (and the software should provide the facilities) to enter file description information from data entry through to the final printout and plotted graphics. SoundPLAN is unique in its capabilities of allowing entry description information for all steps of completing a project.
•Only when the data are properly documented can different operators continue working with a noise mapping project in the future (i.e. to update it for the periodic updates END suggests).
•ISO 9000 compliance requires data origin and use be retraceable.

Documenting the Data

SoundPLAN writes all data for noise simulations in Geo-Files which can be compiled to form Situations.

Each Geo File and each Situation File allow several levels of documentation.

Documenting the content of Situations with all files used, dates of last revision, etc.

Objects in the Geo-Files have a clear structure. For example, an entire road is defined as an object, with one road name and multiple section names. Kilometer posts help identify where parameters change along the road. Emission levels, road surface, road width, etc., can change at any parameter without requiring a new object. Emission levels can be automatically documented graphically from the Geo-DB to the Graphics. The kilometer posts along the road can also be used to reference other parameters, such as the height of noise protection walls.

All calculations in a SoundPLAN project are hosted in a table. Each calculation has its own entry with built-in documentation of all parameters used in the calculation (i.e. the file used, which standard with which setting, etc.). Last but not least, each calculation has a text field for entering a descriptive text.

When any result file generated by a SoundPLAN calculation is opened, some information about the file is displayed: File name, description, revision date and size.

When result files are opened, the RUN information always documents the project, the run description, all files used in the calculation and all parameters that influenced the calculation.

A complete Run Info description can look like the screen captures above, with a description of the entire project, the run description, run parameters and the files that have been loaded into the calculation.

Documenting the Project with Tables

Tables are used to document all aspects of a single calculation, ranging from a simple receiver list to a full protocol. The top portion of the following screenshot shows a list of receivers. The bottom part shows details of the receiver highlighted in the top portion. These tables are called Master-Detail tables. The master provides the source or the receiver. The details include a variety of content. The screenshot shows tabs for detail information for the spectrum of the sound pressure level at the receiver, 24hour distribution of the noise level at the receiver, contributions of sources to the receiver, averaged propagation break down for the main propagation parameters, source contributions mapped over the 24 hours of the day, spectral information of each source contribution, contribution of user defined groups of sources, and the diagrams as seen in the screenshot.

Because more information is written to the database than can be printed on a single page, SoundPLAN's Documentation comes with a formatting section allowing the user to choose which columns to print and to customize the layout. Each column is assigend a set width if using the total width (REST), ensuring the table will fit the page. The user can also customize the table settings with legends and number of titles, and the page layout with headers and footers.

After using the flexible, extensive formatting, preview your report and print it. Any formatting can be saved as templates to save time and effort on future projects. Just select the data file, load the template, print and done!

Last modification: 15 January 2004