DtScenarioBatchRecord Class Reference

class DtScenarioBatchRecord: More...

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	setSmsFilename (const DtFilename &filename)
	Set/get sms file name.
virtual const DtFilename &	smsFilename () 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 DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual bool	overrideRandomNumberSeed () const
	Returns true if random number seed in scenario file should be overridden, false if not.
virtual bool	overrideSmsFile () const
	Returns true if sms file should be overriden.
virtual bool	useSimulationDuration () const
	Returns true if the simulation duration needs to be used for timeout.
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Protected Attributes
DtRwInt	myNumberOfRuns
DtRwInt	myRandomNumberSeedEntry
DtRwString	myScenarioFileRwEntry
DtRwString	mySmsFileRwEntry
DtRwClockTime	mySimulationRunDuration
	Only one time is valid – simulation or wall clock time.
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
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

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 (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
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

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::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 ( 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 DtReaderWriter::SearchPaths &  searchPaths, const DtVariableBindingsList &  variableBindings  )

virtual

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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/scenarioBatchRecord.h