The .ini File
- Abraham Toribio II
Click the following links to view specific components:
XPRafts .ini file
The file format consists of a number of lines of the form:
[Block_name]
VARIABLE=VALUE
BLOCK_NAME is a header for the VARIABLE & VALUE that follows it must be one of: [Main], [Config], [Par], [Settings], [Display], [Status], [Temp] or [Comments].
VARIABLE is not case-sensitive. VALUE is a string of characters relevant to the variable and is also not case-sensitive (see descriptions below). Comments may be included in the file by inserting a pound (#) character anywhere on a line. Any characters on a line following the pound are ignored.
Example:
[MAIN]
VERSION=6.0 Sentinel
EDITOR=notepad.exe
TEMPDIR=C:\XPS\XP-Rafts2000\temp
DIRECTORY=C:\XPS\XP-Rafts2000
ENGINE=C:\XPS\XP-Rafts2000\RAFTSENGW.EXE
CNF=C:\XPS\XP-Rafts2000\XP-RAFTS2000.CNF
CVTHPGL=C:\XPS\XP-Rafts2000\CVTHPGL.BAT
HELP=C:\XPS\XP-Rafts2000\XP-RAFTS2000.HLP
WORKDIRECTORY=C:\XPS\XP-Rafts2000\WORK
DBDEF=C:\XPS\XP-Rafts2000\XPDBDEFN.MDB
MSGBOX=C:\XPS\XP-Rafts2000\MSGBOX
APP=RAFXP
[PAR]
MAXNODES=1000
MAXCATCH=750
MAXUSERPIPE=20
MAXRETPER=7
MAXINLETPOINTS=30
MAXOVERFLOWS=5
[CONFIG]
OPT_DB_KEY = ON
OPT_DB_MEM = ON
OPT_IDX_ACCESS = ON
OPT_DIRTYOBJ =ON
OPT_PART_REC =ON
IO_BUF_SIZE = 4096
MAX_NODES = 500
MAX_LINKS = 500
MAX_TEXTS = 50
MAX_PICTS = 10
MAX_DBCARDS = 20000
CACHE_SIZE = 16
PROJECTS = ON
DATE_FORMAT = dd/mm/yy
COLOUR=SYSTEM
OPT_RAF_NODE_ADV_BTN=OFF
OPT_RAF_SIMPLE_OSD_ADV_BTN=OFF
OPT_RAF_OSD_ADVANCED=OFF
[STATUS]
FILE1=C:\dev\xp\xp-rafts\Caljan01.xp
FILE2=C:\dev\xp\xp-rafts\data.xp
[TEMP]
[ENGINE]
[WEB]
MAIN=http://www.xpsoftware.com
PRODUCT=http://www.xpsoftware.com/products
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_RAF_NODE_ADV_BTN
Use: | |
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: |
OPT_RAF_SIMPLE_OSD_ADV_BTN
Use: | |
Value: | ON (default), OFF - ON enables faster access. |
Description: | |
Memory: | None. |
Comments: |
OPT_RAF_OSD_ADVANCED
Use: | |
Value: | ON (default), OFF - ON enables faster access. |
Description: | |
Memory: | None. |
Comments: |
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_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. |
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_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. |
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. |
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. |
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_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 |
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_LINKS
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_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 |
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. |
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 |
APP_FLAGS
Use: | Change the configuration of XP-SWMM. |
Value: | "" (default), "E" - EXTRAN Mode only, "M" - Malaysian Mode (Int'l only), "U" – UDD Only. |
Description: | Restrict XP-SWMM32 to EXTRAN, UDD or enable the Malaysian Hydrology. |
Memory: | None. |
Comments: | None. |
PROJECTS
Use: | Allow grouping of XP files into projects of up to 100 files. |
Value: | ON (default), OFF |
Description: | See THE PROJECT MENU . |
Memory: | None. |
Comments: | None. |
EDITOR
Use: | Default Editor used by Browse and for reporting errors and warnings. |
Value: | NOTEPAD.EXE (default), or any text editor. |
Description: | The editor used when the Browse menu command is used for viewing text files and for reporting errors and warnings. EDITPAD.EXE and NOTEPAD.EXE (Notepad+), "postcard-ware" programs are automatically installed but must be selected by the user, you can also used Wordpad, Word, Word Perfect, etc.. |
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. |
ENGINE
Use: | Change the engine used by XP-Rafts2000. |
Value: | RATENGINE.EXE (default). Including the full path to this file. |
Description: | By default XP- Rafts2000 uses RAFTSENGINE.EXE as its engine (invoked when solve is selected). |
Memory: | None. |
Comments: |
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. |