The following topics provide details on the available variables for the swmxp.ini file. 


[SETTINGS]

Use:

Display of the current options permitted for this copy of XP-SWMM/XP-STORM.

Value:

Not to be edited by the user. All items should be 0 or 1.

Description:

These items are either 1 or 0 as yes or no. It is an echo of what is found in the SWMXP.XCF or XPSTORM.XCF file.

Memory:

None.

Comments:

None.

[ENGINE]

Use:

Header for any Configuration Parameters to use for every model run.

Value:

List of Configuration Parameters.

Description:

Place any configuration parameters you wish to always use in this section.

Memory:

None.

Comments:

None.

[COMMENTS]

Use:

Header for comments that follow.

Value:

Lines of text.

Description:

This is the block that contains explanations of the variables and values in the SWMXP.INI file.

Memory:

None.

Comments:

None.

[FIELD DEFAULTS]

Use:

Header for the user defined defaults for XP-SWMM/XP-STORM variables.

Value:

XPX field names and default values.

Description:

Allows the user to specify the field defaults to use in lieu of the current existing values embedded in the program. Uses the syntax of XPX fieldname=value.

Memory:

None.

Comments:

None.

[RECENT FILE LIST]

Use:

Superceded by [STATUS].

Value:

File and Path Names.

Description:

Automatically displays the file and path names of the last 4 .XP files opened. This file list is displayed in the File menu of the program.

Memory:

None.

Comments:

None.

[MRU_count]

Use:

Maximum number of files that can be displayed in the Recent Files list.

Value:

Integer.

Description:

Automatically displays the file and path names of the last MRU_COUNT .XP files opened. This file list is also displayed in the opening banner.

Memory:

None.

Comments:

None.

[STATUS]

Use:

Header for the last MRU_COUNT files opened.

Value:

File and Path Names.

Description:

Automatically displays the file and path names of the last MRU_COUNT .XP files opened. This file list is displayed in the opening banner.

Memory:

None.

Comments:

None.

[FIELD PRECISION]

Used to specify display precision of fields. In the first line NUM_FIELDS specifies the number of fields specified. Two lines are required for each field. PREC_FLD_1 is used to declare the field name. PREC_VAL_1 defines the display precision.

Sample for adjusting the Runoff Area to 5 digits after the decimal:

[FIELD PRECISION]
NUM_FIELDS=1
PREC_FLD_1=R_WAREA
PREC_VAL_1=5

[MAIN]

VERSION

Use:

Display of the current version of the XP interface.

Value:

Current version number.

Description:

Automatically displays version number, do not edit.

Memory:

None.

Comments:

None.

ENGINE_VER

Use:

Display of the current version of the SWMM analysis engine.

Value:

Current version number.

Description:

Automatically displays version number, do not edit.

Memory:

None.

Comments:

None.

EDITOR

Use:

Default Editor used by Browse and for reporting errors and warnings.

Value:

NOTEPAD++.EXE (default)

Description:

Notedpad++ is the default text editor used when the Browse menu command is prompted for viewing text files and for reporting errors and warnings, as shown in the image below. This text editor includes the Compare plugin. You can download Notepad++ on this website.

You may change the text editor in the INI file (or Application Settings) by modifying the line:

[MAIN]
EDITOR=C:\Program Files (x86)\Innovyze\xpswmm2019.1\Utilities\NotepadPlusPlus\Notepad++.exe

Memory:

Program dependent.

Comments:

None.

TEMPDIR

Use:

Location of temporary files.

Value:

The name of any directory.

Description:

Used to locate the temporary files such as the DB, XP, ZZ etc. files.

Memory:

None.

Comments:

None.

DIRECTORY

Use:

Location of home directory or installation directory.

Value:

The name of any directory.

Description:

Used for files such as the XP, BAK, SYF, SYT, SYR OUT etc. files used by the model.

Memory:

None.

Comments:

None.

SWMXP

Use:

Location of resource files used by the main executable.

Value:

The name of any directory.

Description:

Used for files such as the BIN, RSC, HLP etc. files used by the main executable.

Memory:

None.

Comments:

Setup during the installation process and should not normally be changed.

ENGINE

Use:

Change the engine used by the program.

Value:

null (default), or SOLVE.BAT (including the full path to this file.

Description:

Inversions prior to 6.0 the interface used SWMENG.DLL as its engine (invoked when solve is selected). If speed of execution is critical or the automatic calibration option is being used the DOS engine can be invoked by enabling the Solve=DOS command.

Memory:

None.

Comments:

Important to use the UNLOCK program contained in SOLVE.BAT to delete the LOCK file when execution terminates or the interface will not know the DOS engine has finished running.

MSGBOX

Use:

Display of the current version of the SWMM analysis engine.

Value:

Current version number.

Description:

Automatically displays version number, do not edit.

Memory:

None.

Comments:

None.

CNF

Use:

Display of the current version of the XPSWMM analysis engine.

Value:

Current version number.

Description:

Automatically displays version number, do not edit.

Memory:

None.

Comments:

None.

CVTHPGL

Use:

Obsolete item as of version 8.0. Contains the file and pathname assigned to the HPGL conversion program.

Value:

c:\xps\xp-swmm\cvthpgl.exe or wherever the program has been installed.

Description:

Contains file and path of the HPGL conversion utility.

Memory:

None.

Comments:

None.

HELP

Use:

Contains the file and pathname assigned to this help file.

Value:

c:\xps\xp-swmm\xpswmm.hlp or wherever the help file has been installed.

Description:

File and Pathname of the Help file.

Memory:

None.

Comments:

None.

PLOT_EXE

Use:

Contains the file and pathname assigned to the profile plotting routine.

Value:

c:\xps\xpprofileplot.exe or wherever it is installed.

Description:

Launches the program contained in the value as the profile-plotting program.

Memory:

None.

Comments:

None.

WORKDIRECTORY

Use:

Display the last directory used for XP models.

Value:

File and path name.

Description:

Automatically displays the last directory and makes it the current directory.

Memory:

None.

Comments:

None.

GIS_EXE

Use:

Contains the file and pathname assigned to the GIS Link item in the Tools menu.

Value:

c:\xps\xp-swmm\gis.exe or wherever the module was installed.

Description:

Launches the PCSWMM GIS for XPSWMM module.

Memory:

None.

Comments:

Other application could be substituted.

[Config]

OPT_DB_KEY

Use:

Used for optimizing database searches.

Value:

ON (default), OFF - ON enables access optimizations.

Description:

This optimization creates a binary tree index of database keys, which significantly decreases the time in searching for database records. The index requires extra memory to operate. If insufficient memory is available, a message will appear whenever a database is created or opened, and the index will not be created.

Memory:

About 4k per 1000 database records, or 50k per 1000 nodes.

Comments:

Use this option, as memory requirement is small.

OPT_DB_MEM

Use:

Used for optimizing database I/O.

Value:

ON (default), OFF - ON enables a memory load.

Description:

The entire database is maintained in memory, generally in expanded or extended memory where available. This option will improve any database access substantially, but requires a large amount of memory. However, the option removes the need for a ram drive to store the database work file, as it is now directly in memory. If insufficient memory is available, a message will appear whenever a database is created or opened, and a work file will be used instead.

Memory:

About 130k per 1000 database records, or about 1.5Mb per 1000 nodes.

Comments:

Use this option if extended/expanded memory is available.

OPT_DIRTYOBJ

Use:

Optimize saving of network objects.

Value:

ON (default), OFF - ON enables saving of dirty objects only.

Description:

Only saves the nodes & links that have been altered - this optimizes saving the network. An internal flag is maintained for each object which indicates if the object’s graphical attributes have altered from the time the database was opened.

Memory:

None.

Comments:

Always use this option.

Use:

Allows the user to show or hide link labels

Value:

ON (default)or OFF.

Description:

Object labels are normally showing. A button on the toolstrip allows an interface to this value.

Memory:

None.

Comments:

None.

OPT_DRAW_NO_LABELS

Use:

Allows the user to show or hide object labels

Value:

ON or OFF (default).

Description:

Object labels are normally showing. Other options exist to individually show/hide object names.

Memory:

None.

Comments:

None.

OPT_DRAW_NO_LABELS

Use:

Allows the user to show or hide object labels

Value:

ON or OFF (default).

Description:

Object labels are normally showing. Other options exist to individually show/hide object names.

Memory:

None.

Comments:

None.

OPT_DRAW_NODE_LABELS

Use:

Allows the user to show or hide node labels

Value:

ON (default) or OFF.

Description:

Object labels are normally showing. A button on the toolstrip allows an interface to this value.

Memory:

None.

Comments:

None.

OPT_FAST_DRAW

Use:

Speeds up recalculation of object boundaries.

Value:

ON (default) or OFF.

Description:

Allows faster redrawing by retrieving object boundaries.

Memory:

None.

Comments:

None.

OPT_IDX_ACCESS

Use:

Optimize internal access to network objects.

Value:

ON (default), OFF - ON enables faster access.

Description:

This options uses a binary index to access objects internally, speeding access times significantly. No significant additional memory is required.

Memory:

None.

Comments:

Always use this option.

OPT_OBJ_NAME_ACCESS

Use:

Speeds up idx access from xpx.

Value:

ON (default), OFF.

Description:

ON enables faster import of XPX files

Memory:

None.

Comments:

None.

OPT_PART_REC

Use:

Optimize database record I/O by accessing partial records.

Value:

ON (default), OFF - ON enables accessing partial records.

Description:

Internally, accessing a database field always required accessing the whole record first. This optimization allows accessing any field within the database record directly, saving the amount of data transfer required.

Memory:

None.

Comments:

Always use this option.

OPT_REDRAW

Use:

Optimizing network redraw by restoring screen image.

Value:

ON (default), OFF - ON enables image restores.

Description:

Network display can now occur in two ways: regeneration or restore. Regeneration is the mode used up to now, which causes every network object’s display to be regenerated when the network window is redrawn. Restore mode restores a saved bit-mapped image of the network window, which takes a constant amount of time and is much quicker than a regenerate, but requires more memory. Restore is used as much as possible when the network window needs to be updated. The Redraw menu command now forces a regeneration to occur. If insufficient memory is available, a message will appear the first time a database is opened or created, and the option will be disabled.

Memory:

1 byte per screen pixel; for VGA(640x480), 300k.

Comments:

Use this option if extended/expanded memory is available.

IO_BUF_SIZE

Use:

Optimize database temporary buffer transfer times.

Value:

0 - 32767 (4096 by default).

Description:

The size of the temporary database file buffer (in bytes). This option allows the user to speed up database loads and saves by setting the size of the temporary file buffer. There is an optimum size which depends on the local file system. If insufficient memory is available, a smaller buffer size will be used.

Memory:

The buffer size, but allocated dynamically during the Load or Save operation.

Comments:

Always use this option, as the memory requirements are transient. The default buffer size should provide reasonable performance for most file systems.

MAX_DBCARDS

Use:

Set the maximum number of database records.

Value:

0 - 200000 (10 times MAX_LINKS by default).

Description:

Sets the maximum number of database records that XP may contain at any time.

Memory:

6k per 1000 database records, or about 10k per 1000 nodes. There is an additional work file requirement of 130k per 1000 database records, or about 1.8Mb per 1000 nodes, which is a disk file requirement normally, but may be a direct memory requirement if OPT_DB_MEM is ON.

Comments:

None

Use:

Set the maximum number of links for the network.

Value:

0 - 32767 (10 by default).

Description:

Sets the maximum number of links that the XP network can contain.

Memory:

Approx. 250k per 1000 links for the extended version.

Comments:

This value if set beyond the licensed value will be reset automatically.

MAX_NODES

Use:

Set the maximum number of nodes for the network.

Value:

0 - 32767 (10 by default).

Description:

Sets the maximum number of nodes that the XP network can contain.

Memory:

Approx. 250k per 1000 nodes.

Comments:

This value if set beyond the licensed value will be reset automatically

MAX_PICTS

Use:

Set the maximum number of background pictures for the network.

Value:

0 - 32767 (20 by default).

Description:

Sets the maximum number of background picture objects that the XP network can contain.

Memory:

130k per 1000 pictures for the extended version.


110k per 1000 pictures for the standard version.

Comments:

None

MAX_TEXTS

Use:

Set the maximum number of text strings for the network.

Value:

0 - 32767 (20 by default).

Description:

Sets the maximum number of text annotation objects that the XP network can contain.

Memory:

250k per 1000 texts for the extended version.


150k per 1000 texts for the standard version.

Comments:

None

CACHE_SIZE

Use:

Set the size of a special database cache.

Value:

0 - 32767 (16 by default).

Description:

Sets the maximum number of database records in a special cache that XP may use. The special cache optimizes database record access by reducing the number of file transfers required to the database work file.

Memory:

130 bytes per cache record.

Comments:

None

CALIBRATE

Use:

Turns on or Off the Automatic Calibration Module.

Value:

ON or OFF (default).

Description:

Module requires purchase from Innovyze.

Memory:

None.

Comments:

None.

PROJECTS

Use:

Allow grouping of XP files into projects of up to 100 files.

Value:

ON, OFF (default)

Description:

See Project Menu.

Memory:

None.

Comments:

None.

SOLVE

Use:

Directs the software to the selection of available compiled analysis engines.

Value:

WIN (default), DLL, or DOS.

Description:

Selects the type of compiled SWMM analysis engine. Latest engine is of type WIN and is a true Windows executable.

Memory:

None.

Comments:

None.

DATE_FORMAT

Use:

Used for defining a country-specific format for date.

Value:

mm-dd-yy month-day-year format


dd-mm-yy day-month-year format


yy-mm-dd year-month-day format


Two digit numbers must be supplied for days and months. Years may be two or four digit. If years are two digits, the 20th century is assumed. The separator between digits may be any non-digit character, so that the first format could be entered as mm/dd/yy which requires a forward slash character to be used as the separator in the actual date.

Description:

The definition is used to configure the program for various countries. Any date entered in a dialog must conform to the format defined by this variable.

Memory:

None.

Comments:

Year 2000 compliance requires 4-digit year entry. This variable is not usually modified.

COLOR

Use:

Allows the background color of to be set by the user.

Value:

=XP (default) or =SYSTEM.

Description:

Selecting system allows the user to pick a background color by changing the item in the Appearance Tab in the Display Properties in the Windows operating system.

Memory:

None.

Comments:

None.

APP_FLAGS

Use:

Change the configuration.

Value:

“” (default), “E” - EXTRAN Mode only, “M” - Malaysian Mode (Int’l only), “U” – UDD Only.

Description:

Restrict XP-SWMM to EXTRAN, UDD or enable the Malaysian Hydrology.

Memory:

None.

Comments:

None.

YEAR_XX

Use:

Forces 2 digit years to be in the 21st century.

Value:

2000 or 1900.

Description:

Default is off or 1900, allowing 2 digit years to be assumed to be in the 20th century.

Memory:

None.

Comments:

None.

[Web]

main

Use:

Contains the http address of the website assigned to the Innovyze Home Page item in the help menu.

Value:

http://www.innovyze.com

Description:

Launches your default browser and directs it to the Innovyze website.

Memory:

None.

Comments:

None.

[DISPLAY]

FONTNAME

Use:

Name of the font used in most dialogs.

Value:

System Font Name.

Description:

Changes the weight of text in XPSWMM dialogs. Not recommended to be altered by the user.

Memory:

None.

Comments:

None.

FONTSIZE

Use:

Font size of the font used in most dialogs.

Value:

Positive Integer.

Description:

Changes the size of text in XPSWMM dialogs. Not recommended to be altered by the user.

Memory:

None.

Comments:

None.

FONTWT

Use:

Weight of the font used in most dialogs.

Value:

Positive Integer.

Description:

Changes the weight of text in XP-SWMM dialogs. Not recommended to be altered by the user.

Memory:

None.

Comments:

None.

[FIELD_DEFINITION_OVERRIDES]

Use:

Display of the current field definition overrides made by the user.

Value:

As indicated by the user in the Application Settings, or as edited in the swmxp.ini file.

Description:

Overrides the default value of the field definition in the application to a user-defined value.

Memory:

None.

Comments:

Example of this section as it appears in the swmxp.ini file when overrides have been made.