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.

Inheritance diagram for DtScenarioBatch:

[legend]

Public Member Functions
	DtScenarioBatch ()

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

virtual	~DtScenarioBatch ()

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

DtScenarioBatch &	operator= (const DtScenarioBatch &orig)

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

virtual DtScenarioBatchRecordList &	batchRecords ()

virtual const DtScenarioBatchRecordList &	batchRecords () const

virtual void	setUseLoggerControl (bool flag)

virtual bool	useLoggerControl () const

virtual void	setLoggerFilesPath (const DtString &path)

virtual const DtString &	loggerFilesPath () const

virtual int	totalRunCount () const

virtual double	totalRunTime () const

virtual bool	readFromFile (const DtFilename &filename)

virtual const DtFilename &	filename () 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	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

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

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

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

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:

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation