DtScenarioBatch Class Reference

class DtScenarioBatch: More...

Inheritance diagram for DtScenarioBatch:

Public Member Functions
	DtScenarioBatch ()
	default constructor
	DtScenarioBatch (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	real constructor
virtual	~DtScenarioBatch ()
	destructor
	DtScenarioBatch (const DtScenarioBatch &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtScenarioBatch &	operator= (const DtScenarioBatch &orig)
	assignment operator
virtual DtScenarioBatch *	clone (DtReaderWriterRegistry *parentRegistry=0) const
	Clone function.
virtual DtScenarioBatchRecordList &	batchRecords ()
	Returns list of batch scenario records (DtScenarioBatchRecords*).
virtual const DtScenarioBatchRecordList &	batchRecords () const
virtual void	setUseLoggerControl (bool flag)
	Set/get the use-logger-control flag.
virtual bool	useLoggerControl () const
virtual void	setLoggerFilesPath (const DtString &path)
	Set/get the path to the logger files generated as a result of the batch runs (if the use-logger-control is true).
virtual const DtString &	loggerFilesPath () const
virtual int	totalRunCount () const
	Returns the total number of runs in the batch.
virtual double	totalRunTime () const
	Returns the total number of seconds runtime for all scenarios in the batch.
virtual bool	readFromFile (const DtFilename &filename)
	Reads scenario batch from file.
virtual const DtFilename &	filename () const
	Returns the filename this object was set from using readFromFile().
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	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
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 void	addAlias (const DtString &alias)
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
DtRwBoolean	myHideSimWindow
DtRwBoolean	myUseLoggerControl
DtRwString	myLoggerFilesPath
DtScenarioBatchRecordList	myBatchRecords
DtFilename	myFilename
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 DtScenarioBatch:

An instance of DtScenarioBatch represents a batch composed of a number of scenario runs, designed to be run in sequence, varying the runs with a few parameters. DtScenarioBatches can be initialized from a Batch Scenario File (.bsn), in which a list of scenarios are given, with the number of runs to perform on each.

Constructor & Destructor Documentation

DtScenarioBatch::DtScenarioBatch

(

)

default constructor

DtScenarioBatch::DtScenarioBatch	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

real constructor

virtual DtScenarioBatch::~DtScenarioBatch ( )

virtual

destructor

DtScenarioBatch::DtScenarioBatch	(	const DtScenarioBatch &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

Member Function Documentation

DtScenarioBatch& DtScenarioBatch::operator=

(

const DtScenarioBatch &

orig

)

assignment operator

virtual DtScenarioBatch* DtScenarioBatch::clone ( DtReaderWriterRegistry *  parentRegistry = 0 ) const

virtual

Clone function.

Returns newly created instance of a DtScenarioBatch, cloned from ourself.

virtual DtScenarioBatchRecordList& DtScenarioBatch::batchRecords ( )

virtual

Returns list of batch scenario records (DtScenarioBatchRecords*).

virtual const DtScenarioBatchRecordList& DtScenarioBatch::batchRecords ( ) const

virtual

virtual void DtScenarioBatch::setUseLoggerControl ( bool  flag )

virtual

Set/get the use-logger-control flag.

Indicates whether or not logger control messages should be sent out on the net.

virtual bool DtScenarioBatch::useLoggerControl ( ) const

virtual

virtual void DtScenarioBatch::setLoggerFilesPath ( const DtString &  path )

virtual

Set/get the path to the logger files generated as a result of the batch runs (if the use-logger-control is true).

virtual const DtString& DtScenarioBatch::loggerFilesPath ( ) const

virtual

virtual int DtScenarioBatch::totalRunCount ( ) const

virtual

Returns the total number of runs in the batch.

(recall that a single record can represent multiple runs.)

virtual double DtScenarioBatch::totalRunTime ( ) const

virtual

Returns the total number of seconds runtime for all scenarios in the batch.

virtual bool DtScenarioBatch::readFromFile ( const DtFilename &  filename )

virtual

Reads scenario batch from file.

virtual const DtFilename& DtScenarioBatch::filename ( ) const

virtual

Returns the filename this object was set from using readFromFile().

Returns a null string if readFromFile was never called.

Member Data Documentation

DtRwBoolean DtScenarioBatch::myHideSimWindow

protected

DtRwBoolean DtScenarioBatch::myUseLoggerControl

protected

DtRwString DtScenarioBatch::myLoggerFilesPath

protected

DtScenarioBatchRecordList DtScenarioBatch::myBatchRecords

protected

DtFilename DtScenarioBatch::myFilename

protected

---

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

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