SWMM5 Delphi GUI Uinifile.pas Summary

 Extended Summary of the Uinifile.pas Unit

The Uinifile.pas unit provides functionality for reading and writing initialization data for the SWMM application. This data includes various preferences, default property values, layout settings, and map/legend configurations. The module handles two main categories of INI files:

1. The global EPASWMM5.INI file (located in a folder typically called epaswmm5.ini).
2. A project-specific INI file (which can store or retrieve settings relevant to a particular SWMM project).

Below is a detailed summary of the principal components and routines within the unit.

---

1. Main Responsibilities

1. Reading and writing user-interface style and program preferences to the global epaswmm5.ini.
2. Reading and saving default property values (e.g., default conduit roughness, subcatchment infiltration options, ID label prefixes, etc.).
3. Remembering the size and position of the Main Form and the Property Editor form.
4. Managing the map legend defaults (colors, intervals).
5. Managing MRU (Most Recently Used) project file lists.
6. Handling calibration data file references, print page setup details, and date/time format preferences.

---

2. Key Data & Structures

1. TIniFile objects:

   • Created for reading/writing from/to epaswmm5.ini (the main SWMM INI file).
   • Also used for project-specific .ini files that store per-project settings.

2. Project Default Properties:

   • The global Project object (in Uglobals) has arrays DefProp[ ] for default properties of each SWMM object type (e.g., SUBCATCH, JUNCTION, CONDUIT, etc.).
   • The unit reads these from [Defaults] sections in an INI file or writes them back.

3. Window Layout:

   • The top, left, width, and height of the Main Form (MainForm) and the Property Editor (PropEditForm) are read and stored in the INI file.

4. Graph and Profile Plot Options:

   • The module writes/reads GraphOptions and ProfileOptions to/from the INI file to remember user customizations regarding line styles, colors, grid lines, legend properties, etc.

5. Map Legends:

   • For subcatchment, node, and link view variables, the user can have color intervals that get loaded/saved.
   • Color arrays, like MapSubcatchColor[], MapNodeColor[], MapLinkColor[], get stored in [Legends] sections.

6. Calibration:

   • The array CalibData[] (defined in Uglobals) references up to 12 calibration data file paths. These can be saved or retrieved from [Calibration] in the INI file.

---

3. Major Procedures & Functions

3.1 Reading and Writing the Main SWMM INI File

1. ReadStyleName

   • Reads the currently used VCL UI style from [Preferences] → StyleName.
   • Ensures the style name matches a recognized style in TStyleManager.StyleNames.

2. ReadIniFile

   • Creates a TIniFile object for epaswmm5.ini.
   • Reads:
     1. Graph options: 3D display, color settings, axis grids, line/point styles, etc.
     2. Profile plot options.
     3. Directories: e.g., DataDir and TempDir.
     4. Preferences: fonts, blinking highlight, confirm delete, auto-backup, etc.
     5. MRU file list.
     6. Property Editor form placement.
     7. Display precision for subcatch/node/link output variables.

3. SaveIniFile

   • Writes back to epaswmm5.ini:
     1. Graph & ProfilePlot options.
     2. Directories & preferences.
     3. MRU list.
     4. Property Editor coordinates & size.
     5. Display precision for model variables.

4. ReadMainFormSize / SaveMainFormSize

   • Manage the position, size, and window state of the main SWMM form.

---

3.2 Handling Program Defaults

1. ReadDefaults

   • Initializes default property data for objects like subcatchments, junctions, etc. from factory definitions in Uproject (like DefSubcatch, DefJunction, etc.).
   • Then loads any overrides from epaswmm5.ini using the function LoadDefaultsFromFile.

2. SaveDefaults

   • Uses SaveDefaultsToFile to store the default properties (prefixes, infiltration default, etc.) to epaswmm5.ini.

3. LoadDefaultsFromFile(theIniFile: TIniFile)

   • A local procedure reading Labels (ID prefixes & increments) and [Defaults] from the TIniFile.
   • Also sets infiltration parameter arrays (Horton, Green-Ampt, etc.) if user changed infiltration in [Defaults].

4. SaveDefaultsToFile(theIniFile: TIniFile)

   • Writes these default properties back to the given INI file.

---

3.3 Project-Specific INI Handling

1. ReadProjIniFile(const Fname: String)

   • If a user has a separate project INI (e.g., myproject.ini), this routine reads map display options (like whether subcatch IDs appear or subcatch polygons are visible), legend color intervals, default infiltration parameters, page layout info (for printing), calibration file references, and more from that file.

2. SaveProjIniFile(const Fname: String)

   • Saves the same sets of information above into a .ini file next to the project file. This includes:
     • [Map] display settings, [Backdrop] flags, [Legends], [Labels], [Page] layout, [Calibration], [Graph] date/time format, [Results] saved status, etc.

---

4. Additional Implementation Details

• InitMapLegends: Called upon reading defaults, assigns factory defaults to color intervals and color arrays for subcatch/node/link legend displays.
• CheckGraphSeriesOptions: Ensures user-specified line styles or point sizes stay in valid ranges.
• ExtractValues: Helper that tokenizes a string of numbers (with commas) into floats, storing them in an array. Used for reading the [Legends] intervals.

---

5. Summary of the Workflow

1. On startup or closing, the main SWMM form calls ReadIniFile and SaveIniFile to handle global preferences.
2. When opening a new SWMM project, the user’s project .ini file might be read with ReadProjIniFile.
3. When saving or closing the project, SaveProjIniFile writes out all current settings for map views, defaults, page layout, etc.
4. When the user modifies defaults or style in the main UI, the updated settings get stored to the correct place (either the global or project .ini file) so that changes persist between sessions.

Therefore, Uinifile.pas is essentially the preference manager for both the general SWMM environment (the main INI) and for the current project’s specialized settings (the project-level INI).