DtBatchManager Class Reference

class DtBatchManager More...

Public Types
enum	State {   StateIdle, StateRunStart, StateLoading, StateRunning,   StateRunComplete }
	Enumerations for state of batch run. More...

Public Member Functions
	DtBatchManager (DtCgf *cgf)
virtual	~DtBatchManager ()
virtual bool	init ()
	Instantiates the DtScenarioBatchIterator and DtRemoteLoggerController classes.
virtual void	tick ()
	Monitors the execution of the scenario and starts a new one if necessary.
virtual bool	loadBatch (const DtFilename &batchFileName)
	Load batch from a file.
virtual bool	loadBatch (const DtScenarioBatch &batch)
	Load batch from a DtScenarioBatch.
virtual bool	runBatch ()
	Puts the Batch Manager in run mode.
virtual bool	stopBatch ()
	Aborts running of batch prematurely.
virtual bool	running ()
	True if batch is currently running.
virtual bool	done ()
	True if batch has completed normally.
DtBatchManager::State	state () const
	Returns state of batch manager.
virtual const DtScenarioBatchIterator *	batchIterator ()
	accessor for the Batch Iterator used in this batch manager.

Protected Member Functions
	DtBatchManager ()
	Not implemented. Do not use.
	DtBatchManager (const DtBatchManager &orig)
DtBatchManager &	operator= (const DtBatchManager &orig)
virtual DtFilename	constructLoggerFilename (const DtScenario *scenario)
	Constructs a filename for the logger file to record the given scenario in.

Protected Attributes
DtScenarioBatchIterator *	myBatchIterator
DtRemoteLoggerController *	myLoggerControl
DtCgf *	myCgf
DtBatchManager::State	myState
bool	myRunning
bool	myDone
DtTime	myRunStartTime

Detailed Description

class DtBatchManager

Instances of DtBatchManager control the execution of scenario batch files in a back-end application. It requires a pointer to an existing Cgf class and should be ticked alongside the Cgf class. It also uses a DtRemoteLoggerController to send out logger control PDUs when that option has been turned on in the batch file.

Member Enumeration Documentation

enum DtBatchManager::State

Enumerations for state of batch run.

Enumerator:

StateIdle
StateRunStart
StateLoading
StateRunning
StateRunComplete

Constructor & Destructor Documentation

DtBatchManager::DtBatchManager

(

DtCgf *

cgf

)

virtual DtBatchManager::~DtBatchManager ( )

virtual

DtBatchManager::DtBatchManager ( )

protected

Not implemented. Do not use.

DtBatchManager::DtBatchManager ( const DtBatchManager &  orig )

protected

Member Function Documentation

virtual bool DtBatchManager::init ( )

virtual

Instantiates the DtScenarioBatchIterator and DtRemoteLoggerController classes.

virtual void DtBatchManager::tick ( )

virtual

Monitors the execution of the scenario and starts a new one if necessary.

virtual bool DtBatchManager::loadBatch ( const DtFilename &  batchFileName )

virtual

Load batch from a file.

virtual bool DtBatchManager::loadBatch ( const DtScenarioBatch &  batch )

virtual

Load batch from a DtScenarioBatch.

virtual bool DtBatchManager::runBatch ( )

virtual

Puts the Batch Manager in run mode.

Running of first scenario in the batch will start on next tick.

virtual bool DtBatchManager::stopBatch ( )

virtual

Aborts running of batch prematurely.

virtual bool DtBatchManager::running ( )

virtual

True if batch is currently running.

virtual bool DtBatchManager::done ( )

virtual

True if batch has completed normally.

DtBatchManager::State DtBatchManager::state

(

)

const

Returns state of batch manager.

virtual const DtScenarioBatchIterator* DtBatchManager::batchIterator ( )

virtual

accessor for the Batch Iterator used in this batch manager.

DtBatchManager& DtBatchManager::operator= ( const DtBatchManager &  orig )

protected

virtual DtFilename DtBatchManager::constructLoggerFilename ( const DtScenario *  scenario )

protectedvirtual

Constructs a filename for the logger file to record the given scenario in.

Member Data Documentation

DtScenarioBatchIterator* DtBatchManager::myBatchIterator

protected

DtRemoteLoggerController* DtBatchManager::myLoggerControl

protected

DtCgf* DtBatchManager::myCgf

protected

DtBatchManager::State DtBatchManager::myState

protected

bool DtBatchManager::myRunning

protected

bool DtBatchManager::myDone

protected

DtTime DtBatchManager::myRunStartTime

protected

---

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

• include/vrfcgf/batchMgr.h