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).

Inheritance diagram for DtScenarioBatchRecord:

[legend]

Public Member Functions
	DtScenarioBatchRecord ()

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

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

virtual	~DtScenarioBatchRecord ()

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

DtScenarioBatchRecord &	operator= (const DtScenarioBatchRecord &orig)

virtual DtScenarioBatchRecord *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const

virtual void	setNumberOfRuns (int count)

virtual int	numberOfRuns () const

virtual void	setRandomNumberSeedEntry (const int entry)

virtual const int	randomNumberSeedEntry () const

virtual void	setScenarioFilename (const DtFilename &filename)

virtual const DtFilename &	scenarioFilename () const

virtual void	setSmsFilename (const DtFilename &filename)

virtual const DtFilename &	smsFilename () const

virtual void	setRunDuration (const DtRwClockTime &duration)

virtual const DtRwClockTime &	runDuration () const

virtual void	setSimulationRunDuration (const DtRwClockTime &duration)

virtual const DtRwClockTime &	simulationRunDuration () const

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

virtual bool	overrideRandomNumberSeed () const

virtual bool	overrideSmsFile () const

virtual bool	useSimulationDuration () const

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	postGetSelf ()

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual void	reset ()

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual const char *	readerWriterType () const

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	wasUpdatedSince (DtTime t) const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	putData (std::string &fp, int indentLevel=0)

virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Protected Attributes
DtRwInt	myNumberOfRuns

DtRwInt	myRandomNumberSeedEntry

DtRwString	myScenarioFileRwEntry

DtRwString	mySmsFileRwEntry

DtRwClockTime	mySimulationRunDuration

DtRwClockTime	myRunDuration

DtFilename	myScenarioFile

DtFilename	mySmsFile

Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName

DtReaderWriterRegistry	myRegistry

DtReaderWriterRegistry *	myParentRegistry

bool	myValueSpecified

bool	myReadOnlyFlag

bool	myIsVariableReference

DtSymbolString	myVariableName

bool	myVariableIsBound

DtReaderWriter *	myDefaultValue

aliasContainer	myAliases

bool	myInvalid

bool	myChangedFlag

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer

typedef std::vector < DtSymbolString >::iterator	aliasIter

typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter

typedef std::vector< DtFilename >	SearchPaths

typedef std::pair < DtSymbolString, DtString >	DtVariableNameType

typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()

Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)

static const DtVariableBindingsList &	nullVariableReference ()

static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)

static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)

static void	setPutIndent (bool)

static bool	putIndent ()

static const char *	theXmlType ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue

static DtGetSelfCallbackInfo	thePostGetSelfCallback

static DtPutSelfCallbackInfo	thePrePutSelfCallback

static const DtVariableBindingsList	theEmptyVariableBindingsList

static bool	theCreatorFcnSet

static DtReaderWriterFactory *	theFactory

static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

static bool	thePutIndent

static DtOutputStream *	theOutputStream

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::setSmsFilename ( const DtFilename & filename )

virtual

Set/get sms file name.

virtual const DtFilename& DtScenarioBatchRecord::smsFilename ( ) 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	(	std::string &	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 DtReaderWriter::SearchPaths &	searchPaths,
		const DtVariableBindingsList &	variableBindings
	)

virtual

Top level to read itself from an input stream. searchPath is passed down to all DtReaderWriter members in its DtReaderWriterRegistry (collection of child DtReaderWriter nodes). If a given member in the registry is of type DtReaderWriterFile, and the searchPath is specified with a non-NULL string, then file to be read in is searched for in the given path.

Reimplemented from DtReaderWriter.

virtual bool DtScenarioBatchRecord::overrideRandomNumberSeed ( ) const

virtual

Returns true if random number seed in scenario file should be overridden, false if not.

virtual bool DtScenarioBatchRecord::overrideSmsFile ( ) const

virtual

Returns true if sms file should be overriden.

virtual bool DtScenarioBatchRecord::useSimulationDuration ( ) const

virtual

Returns true if the simulation duration needs to be used for timeout.

Member Data Documentation

DtRwInt DtScenarioBatchRecord::myNumberOfRuns

protected

DtRwInt DtScenarioBatchRecord::myRandomNumberSeedEntry

protected

DtRwString DtScenarioBatchRecord::myScenarioFileRwEntry

protected

DtRwString DtScenarioBatchRecord::mySmsFileRwEntry

protected

DtRwClockTime DtScenarioBatchRecord::mySimulationRunDuration

protected

Only one time is valid – simulation or wall clock time.

DtRwClockTime DtScenarioBatchRecord::myRunDuration

protected

DtFilename DtScenarioBatchRecord::myScenarioFile

protected

DtFilename DtScenarioBatchRecord::mySmsFile

protected

The documentation for this class was generated from the following file:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfutil/scenarioBatchRecord.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation