 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
class DtScenarioBatch: More...
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(). | |
Protected Attributes | |
| DtRwBoolean | myHideSimWindow |
| DtRwBoolean | myUseLoggerControl |
| DtRwString | myLoggerFilesPath |
| DtScenarioBatchRecordList | myBatchRecords |
| DtFilename | myFilename |
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.
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
| 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.
DtRwBoolean DtScenarioBatch::myHideSimWindow [protected] |
DtRwBoolean DtScenarioBatch::myUseLoggerControl [protected] |
DtRwString DtScenarioBatch::myLoggerFilesPath [protected] |
DtFilename DtScenarioBatch::myFilename [protected] |