Inheritance diagram for DtScenarioBatchRecord:

Public Member Functions
	DtScenarioBatchRecord ()
	default constructor
	DtScenarioBatchRecord (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	real constructor
	DtScenarioBatchRecord (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
virtual	~DtScenarioBatchRecord ()
	destructor
	DtScenarioBatchRecord (const DtScenarioBatchRecord &orig, DtReaderWriterRegistry *const parentRegistry=NULL)
	copy constructor
DtScenarioBatchRecord &	operator= (const DtScenarioBatchRecord &orig)
	assignment operator
virtual DtScenarioBatchRecord *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void	setNumberOfRuns (int count)
	Set/get the number of runs.
virtual int	numberOfRuns () const
virtual void	setRandomNumberSeedEntry (const int entry)
	Set/get random number seed entry.
virtual const int	randomNumberSeedEntry () const
virtual void	setScenarioFilename (const DtFilename &filename)
	Set/get scenario filename.
virtual const DtFilename &	scenarioFilename () const
virtual void	setParameterFilename (const DtFilename &filename)
	Set/get parameter file name.
virtual const DtFilename &	parameterFilename () const
virtual void	setRunDuration (const DtRwClockTime &duration)
	Set/get simulation end time entry.
virtual const DtRwClockTime &	runDuration () const
virtual void	setSimulationRunDuration (const DtRwClockTime &duration)
	Set/get simulation end time entry.
virtual const DtRwClockTime &	simulationRunDuration () const
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())
	Override to convert between read/write strings and DtFilenames, for the scenario file and parameter file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
virtual bool	overrideRandomNumberSeed () const
	Returns true if random number seed in scenario file should be overridden, false if not.
virtual bool	overrideParameterFile () const
	Returns true if parameter file should be overriden.
virtual bool	useSimulationDuration () const
	Returns true if the simulation duration needs to be used for timeout.
Protected Attributes
DtRwInt	myNumberOfRuns
DtRwInt	myRandomNumberSeedEntry
DtRwString	myScenarioFileRwEntry
DtRwString	myParameterFileRwEntry
DtRwClockTime	mySimulationRunDuration
	Only one time is valid -- simulation or wall clock time.
DtRwClockTime	myRunDuration
DtFilename	myScenarioFile
DtFilename	myParameterFile

Detailed Description

class DtScenarioBatchRecord:

Instances of DtScenarioBatchRecord are used to contain all of the information necessary to set up a batch run of a given scenario (the scenario filename, # of runs, random # seed, etc).

Constructor & Destructor Documentation

DtScenarioBatchRecord::DtScenarioBatchRecord ( )

default constructor

DtScenarioBatchRecord::DtScenarioBatchRecord	(	const DtString &	name,
		DtReaderWriterRegistry *const	parentRegistry = `NULL`
	)

real constructor

DtScenarioBatchRecord::DtScenarioBatchRecord	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *const	parentRegistry = `NULL`
	)

virtual DtScenarioBatchRecord::~DtScenarioBatchRecord ( ) [virtual]

destructor

DtScenarioBatchRecord::DtScenarioBatchRecord	(	const DtScenarioBatchRecord &	orig,
		DtReaderWriterRegistry *const	parentRegistry = `NULL`
	)

copy constructor

Member Function Documentation

DtScenarioBatchRecord& DtScenarioBatchRecord::operator= ( const DtScenarioBatchRecord & orig )

assignment operator

virtual DtScenarioBatchRecord* DtScenarioBatchRecord::clone ( DtReaderWriterRegistry * parentRegistry = NULL ) const [virtual]

virtual void DtScenarioBatchRecord::setNumberOfRuns ( int count ) [virtual]

Set/get the number of runs.

virtual int DtScenarioBatchRecord::numberOfRuns ( ) const [virtual]

virtual void DtScenarioBatchRecord::setRandomNumberSeedEntry ( const int entry ) [virtual]

Set/get random number seed entry.

If specified, overrides the random number seed specified in the scenario file. If a value of -1, uses a computer generated random number seed for each run.

virtual const int DtScenarioBatchRecord::randomNumberSeedEntry ( ) const [virtual]

virtual void DtScenarioBatchRecord::setScenarioFilename ( const DtFilename & filename ) [virtual]

Set/get scenario filename.

virtual const DtFilename& DtScenarioBatchRecord::scenarioFilename ( ) const [virtual]

virtual void DtScenarioBatchRecord::setParameterFilename ( const DtFilename & filename ) [virtual]

Set/get parameter file name.

virtual const DtFilename& DtScenarioBatchRecord::parameterFilename ( ) const [virtual]

virtual void DtScenarioBatchRecord::setRunDuration ( const DtRwClockTime & duration ) [virtual]

Set/get simulation end time entry.

Time at which the scenario run will be stopped (in terms of wall clock time).

virtual const DtRwClockTime& DtScenarioBatchRecord::runDuration ( ) const [virtual]

virtual void DtScenarioBatchRecord::setSimulationRunDuration ( const DtRwClockTime & duration ) [virtual]

Set/get simulation end time entry.

Time at which the scenario run will be stopped (in terms of simulation time).

virtual const DtRwClockTime& DtScenarioBatchRecord::simulationRunDuration ( ) const [virtual]

virtual void DtScenarioBatchRecord::putSelf	(	FILE *	fp,
		int	indentLevel = `0`,
		bool	writeUnspecified = `false`,
		const DtFilename &	path = `DtReaderWriter::appPath()`
	)		`[virtual]`

Override to convert between read/write strings and DtFilenames, for the scenario file and parameter file.

Reimplemented from DtReaderWriter.

virtual void DtScenarioBatchRecord::getSelf	(	DtlObjPtr	args,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		`[virtual]`