Command-line arguments
[GridLAB-D Core]

---

Detailed Description

The command-line argument processing module processes arguments as they are encountered.

The following command-line toggles are supported

• --warn toggles the warning mode
• --check toggles calls to module check functions
• --debug toggles debug messages
• --debugger enables the debugger and turns on debug messages
• --dumpall toggles a complete model dump when the simulation exits
• --quiet toggles all messages except error and fatal messages
• --profile toggles performance profiling

The following command-line processes can be called

• --license prints the software license
• --dsttest performs a daylight saving time definitions in tzinfo.txt
• --unitstest performs a test of the units in unitfile.txt
• --randtest performs a test of the random number generators
• --testall file performs module selftests of modules those listed in file
• --test run the internal core self-test routines
• --define define a global variable
• --libinfo module prints information about the module
• --xsd module[:object] prints the xsd of a module or object
• --kml=file output kml (Google Earth) file of model

The following system options may be changed

• --threadcount n changes the number of thread to use during simulation (default is 0, meaning as many as useful)
• --output file saves dump output to file (default is gridlabd.glm)
• --environment app start the app as the processing environment (default is batch)
• --xmlencoding num sets the XML encoding (8, 16, or 32)

The following are only supported on Linux systems

• --pidfile[=filename] creates a process id file while GridLAB-D is running (default is gridlabd.pid)
• --redirect stream[:file] redirects output stream to file
• --server runs in server mode (pidfile and redirects all output)

Functions
STATUS	cmdarg_load (int argc, char *argv[])
	Load and process the command-line arguments.
STATUS	load_module_list (FILE *fd, int *test_mod_num)

---

Function Documentation

STATUS cmdarg_load	(	int	argc,
		char *	argv[]
	)

Load and process the command-line arguments.

Returns:

a STATUS value

Arguments are processed immediately as they are seen. This means that models are loaded when they are encountered, and in relation to the other flags. Thus

    gridlabd --warn model1 --warn model2

will load model1 with warnings on, and model2 with warnings off.

Parameters:

argc	the number of arguments in argv
argv	a list pointers to the argument string

Definition at line 87 of file cmdarg.c.

References FAILED, global_command_line, global_dump(), global_setvar(), legal_license(), legal_notice(), load_module_list(), loadall(), module_cmdargs(), module_libinfo(), output_error(), output_fatal(), output_redirect(), output_warning(), output_xsd(), random_test(), SUCCESS, timestamp_test(), TRUE, and unit_test().

Referenced by main().

---

GridLAB-D^TM Version 1.0

An open-source project initiated by the US Department of Energy