class DtScenarioBatchIterator
More...
class DtScenarioBatchIterator
An instance of DtScenarioBatchIterator provides an iterator over scenarios constructed from a scenario batch. This class is responsible for constructing the scenarios from the data in the batch.
| DtScenarioBatchIterator::DtScenarioBatchIterator |
( |
| ) |
|
| virtual DtScenarioBatchIterator::~DtScenarioBatchIterator |
( |
| ) |
|
|
virtual |
Not implemented. Do not use.
| virtual bool DtScenarioBatchIterator::init |
( |
| ) |
|
|
virtual |
| virtual void DtScenarioBatchIterator::setScenarioBatch |
( |
const DtScenarioBatch & |
batch | ) |
|
|
virtual |
Sets the scenario batch to iterate over.
Resets the current iteration to the start.
| virtual void DtScenarioBatchIterator::reset |
( |
| ) |
|
|
virtual |
Resets the iterator to the beginning of the batch.
| virtual const DtScenario* DtScenarioBatchIterator::nextRun |
( |
| ) |
|
|
virtual |
Constructs and returns a pointer to the scenario representing the next run in the batch.
Returns NULL if no more scenarios are left.
| virtual const DtScenario* DtScenarioBatchIterator::currentScenario |
( |
| ) |
const |
|
virtual |
Returns a pointer to the current scenario.
| virtual const DtScenarioBatch* DtScenarioBatchIterator::scenarioBatch |
( |
| ) |
const |
|
virtual |
Returns a pointer to the scenario batch being used.
| virtual int DtScenarioBatchIterator::runCount |
( |
| ) |
const |
|
virtual |
Total number of runs for current batch.
| virtual int DtScenarioBatchIterator::currentRunNumber |
( |
| ) |
const |
|
virtual |
| virtual double DtScenarioBatchIterator::totalTime |
( |
| ) |
const |
|
virtual |
Total runtime for all scenario runs in current batch.
| virtual double DtScenarioBatchIterator::elapsedTime |
( |
| ) |
const |
|
virtual |
Time for all runs that have been completed in current batch.
| virtual double DtScenarioBatchIterator::timeToGo |
( |
| ) |
const |
|
virtual |
Time remaining for all uncompleted runs in current batch.
| virtual double DtScenarioBatchIterator::percentTimeComplete |
( |
| ) |
const |
|
virtual |
Percent (by time) of completeness of the current batch.
| virtual void DtScenarioBatchIterator::nextScenario |
( |
| ) |
|
|
virtual |
Sets internal variables so the next time nextRun() is called it will move onto the next scenario in the batch rather than the next run in the current scenario.
| virtual bool DtScenarioBatchIterator::constructCurrentScenario |
( |
| ) |
|
|
protectedvirtual |
Reads the scenario file for the current record and modifies it according to entries in the current record and places the result in currentScenario.
| virtual void DtScenarioBatchIterator::calculateTotals |
( |
| ) |
|
|
protectedvirtual |
Calculates the total number of runs and the total time for the current batch.
| DtListItem* DtScenarioBatchIterator::myCurrentRecordItem |
|
protected |
| DtScenario* DtScenarioBatchIterator::myCurrentScenario |
|
protected |
| int DtScenarioBatchIterator::myRunNumber |
|
protected |
| int DtScenarioBatchIterator::myRunCount |
|
protected |
| int DtScenarioBatchIterator::myTotalRuns |
|
protected |
total count since start of batch
| double DtScenarioBatchIterator::myTotalTime |
|
protected |
| double DtScenarioBatchIterator::myElapsedTime |
|
protected |
Total time of all scenario runs. (seconds)
| const int DtScenarioBatchIterator::theUseComputerGeneratedSeed |
|
staticprotected |
Time of all scenario runs completed. (seconds)
The documentation for this class was generated from the following file: