CommandLineParameters Struct Reference

Auxiliary strucuture used to interpret and store command line parameters. More...

#include <commandLineParameters.h>

Collaboration diagram for CommandLineParameters:

Public Member Functions
	CommandLineParameters ()
	Constructor. Creates an empty parameter set.
bool	parse (const QStringList &params)
	Interprets command line parameters received by the application, filling structre attributes with user values or default values when not given.

Public Attributes
QString	execFileName
	The name of the executable file.
QString	configFileName
	Configuration file name.
QString	modelFileName
	Model definition file name.
QString	userParameters
	User supplied model parameters.
QString	userOptions
	User supplied options table to be merged with Simulation.options.
QString	logDir
	User supplied value for the $LOG macro.
QString	inputDir
	User supplied value for the $INPUT macro.
QString	outputDir
	User supplied value for the $OUTPUT macro.
QString	logFileName
	Log file name if provided by the user. Overrides config file option if not empty.
bool	monitor
	Forces the monitor server to be started. Overrides config file options.
bool	noMonitor
	Prevents the monitor server to be started. Overrides config file options.
bool	localMonitor
	Forces the monitor server to be started, listening on localhost. Overrides config file options.
unsigned	localServerPort
	The port that should be used for listening if localMonitor is true (0 for any port).
QString	connectionFileName
	User supplied server connection information file.
int	waitForConnection
	Simulation loading waits for first client connection timeout in msec. -1 = no waiting, 0 = infinite waiting.
bool	printVersion
	Shows the GeMA version information and quits.
bool	printBversion
	Shows used BLAS version information and quits.
bool	printPversion
	Shows the GeMA + plugin version information and quits.
bool	quietMode
	Log only warnings and errors. Overrides config file logger level options.
bool	verboseMode
	Log every possible message. Overrides config file logger level options.
bool	noConsoleMode
	No console logging. Overrides config file option.
bool	regressionMode
	Logger value tags are enabled to aid in regression test comparisons.
int	statsLevel
	The progress level definition. A value from 0 to 4 or -1 if not defined. Overrides config file settings.
bool	memoryMode
	DEPRECATED. Forces logging of memory messages. Overrides config file logger level options.
bool	noMemoryMode
	DEPRECATED. Prevents logging of memory messages. Overrides config file logger level options.
bool	timeMode
	DEPRECATED. Forces logging of time messages. Overrides config file logger level options.
bool	noTimeMode
	DEPRECATED. Prevents logging of time messages. Overrides config file logger level options.
bool	serverMode
	Forces sending log messages to the monitor server. Overrides config file options.
bool	noServerMode
	Prevents sending log messages to the monitor server. Overrides config file options.
bool	restore
	Flag indicating a restore request. Forwarded to the dumpLib (from the script libs).
int	restoreState
	The desired restore state number. 0 if not filled. Forwarded to the dumpLib (from the script libs).
QString	restoreTag
	The name of the state tag to be restored. Forwarded to the dumpLib (from the script libs).
bool	restoreList
	Request forwarded to the dumpLib (from the script libs) to show the list of available restore states.
QString	restoreFile
	Name of the dump control file forwarded to the dumpLib (from the script libs).
bool	noParRestore
	Request forwarded to the dumpLib (from the script libs) to prevent user parameters from being recovered from the restored state.
QString	dumpAbort
	Request forwarded to the dumpLib (from the script libs) to provoke an abort at the given step enabling restore regression tests.
bool	noDump
	Request forwarded to the dumpLib (from the script libs) to prevent any file dumping.

Private Member Functions
bool	parseParams (const QStringList &params, QString &err)
	Parses command line parameters. Returns false and fills err if errors where found. Returns false but keeps err empty if the user requested help about program usage.
bool	checkParams (QString &err)
	Checks if required parameters where given and fills default values.
void	showUsage () const
	Show a warning message describing the accepted parameters.
void	showVersion () const
	Print version information.
void	printMessage (QString msg) const
	Show message to the user.

Detailed Description

Auxiliary strucuture used to interpret and store command line parameters.

Member Function Documentation

parse()

bool CommandLineParameters::parse

(

const QStringList &

params

)

Interprets command line parameters received by the application, filling structre attributes with user values or default values when not given.

See showUsage() for a documentation of the accepted parameters. If bad parameters are given, shows a warning message and returns false to indicate that the application should exit.

Parameters

params

List of command line parameters

---

The documentation for this struct was generated from the following files:

• inc/commandLineParameters.h
• src/commandLineParameters.cpp