makVrf::DtVrfBatchScenarioManager Class Reference

The class that will contain information about the currently loaded scenario. More...

Inheritance diagram for makVrf::DtVrfBatchScenarioManager:

List of all members.

Public Types
enum	State {   StateIdle, StateRunStart, StateLoading, StateRunning,   StateRunComplete, StateRunBatchComplete, StateErrorLoading, StateClosing }
	Enumerations for state of batch run. More...
Public Member Functions
	DtVrfBatchScenarioManager (makVrv::DtDe &)
virtual	~DtVrfBatchScenarioManager ()
virtual void	loadBatchScenario (QWidget *)
	Creates and shows the batch load scenario dialog.
virtual QFileDialog *	createLoadBatchScenarioDialog (QWidget *)
virtual bool	loadBatchScenario (const QString &batch)
virtual bool	runBatch ()
	Starts up the batch run.
bool	isBatchRunning () const
DtScenarioBatchIterator *	batchIterator () const
bool	runningBatchScenario () const
virtual void	nextScenarioRun ()
	Call this function to move onto the next scenario run in the batch (if there is one)
virtual void	nextScenario ()
	Call this function to move onto the next scenario in the batch even if there are runs left in the current scenario.
virtual bool	close ()
	Stops the currently running batch scenario.
Static Public Member Functions
static DtVrfBatchScenarioManager &	instance (makVrv::DtDe &de)
	Returns instance of the messager.
Public Attributes
boost::signal< void()>	signal_stateRunStart
boost::signal< void()>	signal_nextRunAboutToStart
	Sent after the last scenario has closed and next one is about to start.
boost::signal< void()>	signal_batchRunComplete
	Sent when all batch files have been run.
boost::signal< void()>	signal_errorLoadingScenario
boost::signal< void()>	signal_scenarioRunComplete
	Signalled when a scenario run is complete.
Protected Member Functions
virtual void	tick ()
virtual void	idle ()
	Called in idle state.
virtual void	startNextBatchScenario ()
	Starts by running the next batch.
virtual void	loading ()
	Iterated over while waiting for scenario to load.
virtual void	running ()
	Called when batch is running.
virtual double	currentSimulationTime () const
	Returns the current simulation time from the first back-end in the remote control list.
virtual DtFilename	constructLoggerFilename (const DtScenario *scenario)
virtual void	allBackendsClosed ()
	Schedules next run.
virtual void	loadScenarioError (const std::string &error, bool showMessage=true)
	Called when there is an error loading the scenario.
virtual void	slot_scenarioLoadComplete ()
	Called after scenario is loaded.
virtual QString	batchRunTitle (const DtScenario *) const
virtual void	setMainWindowTitle (const QString &)
virtual QString	mainWindowTitle () const
Protected Attributes
DtScenarioBatchIterator *	myBatchIterator
makVrv::DtDe &	myDe
QString	myBatchFile
bool	myRunning
DtVrfScenarioRemapFunction *	myRemap
double	myRunStartTime
State	myState
QString	myOriginalTitle

---

Detailed Description

The class that will contain information about the currently loaded scenario.

---

Member Enumeration Documentation

enum makVrf::DtVrfBatchScenarioManager::State

Enumerations for state of batch run.

Enumerator:

StateIdle
StateRunStart
StateLoading
StateRunning
StateRunComplete
StateRunBatchComplete
StateErrorLoading
StateClosing

---

Constructor & Destructor Documentation

makVrf::DtVrfBatchScenarioManager::DtVrfBatchScenarioManager

(

makVrv::DtDe &

)

virtual makVrf::DtVrfBatchScenarioManager::~DtVrfBatchScenarioManager

(

)

[virtual]

---

Member Function Documentation

static DtVrfBatchScenarioManager& makVrf::DtVrfBatchScenarioManager::instance

(

makVrv::DtDe &

de

)

[static]

Returns instance of the messager.

virtual void makVrf::DtVrfBatchScenarioManager::loadBatchScenario

(

QWidget *

)

[virtual]

Creates and shows the batch load scenario dialog.

virtual QFileDialog* makVrf::DtVrfBatchScenarioManager::createLoadBatchScenarioDialog

(

QWidget *

)

[virtual]

virtual bool makVrf::DtVrfBatchScenarioManager::loadBatchScenario

(

const QString &

batch

)

[virtual]

virtual bool makVrf::DtVrfBatchScenarioManager::runBatch

(

)

[virtual]

Starts up the batch run.

bool makVrf::DtVrfBatchScenarioManager::isBatchRunning

(

)

const [inline]

DtScenarioBatchIterator* makVrf::DtVrfBatchScenarioManager::batchIterator

(

)

const [inline]

bool makVrf::DtVrfBatchScenarioManager::runningBatchScenario

(

)

const [inline]

virtual void makVrf::DtVrfBatchScenarioManager::nextScenarioRun

(

)

[virtual]

Call this function to move onto the next scenario run in the batch (if there is one)

virtual void makVrf::DtVrfBatchScenarioManager::nextScenario

(

)

[virtual]

Call this function to move onto the next scenario in the batch even if there are runs left in the current scenario.

virtual bool makVrf::DtVrfBatchScenarioManager::close

(

)

[virtual]

Stops the currently running batch scenario.

virtual void makVrf::DtVrfBatchScenarioManager::tick

(

)

[protected, virtual]

virtual void makVrf::DtVrfBatchScenarioManager::idle

(

)

[protected, virtual]

Called in idle state.

virtual void makVrf::DtVrfBatchScenarioManager::startNextBatchScenario

(

)

[protected, virtual]

Starts by running the next batch.

virtual void makVrf::DtVrfBatchScenarioManager::loading

(

)

[protected, virtual]

Iterated over while waiting for scenario to load.

Will call slot_scenarioLoadComplete callback when loaded

virtual void makVrf::DtVrfBatchScenarioManager::running

(

)

[protected, virtual]

Called when batch is running.

Will check time to see if current batch is over and next batch needs to be run

virtual double makVrf::DtVrfBatchScenarioManager::currentSimulationTime

(

)

const [protected, virtual]

Returns the current simulation time from the first back-end in the remote control list.

virtual DtFilename makVrf::DtVrfBatchScenarioManager::constructLoggerFilename

(

const DtScenario *

scenario

)

[protected, virtual]

virtual void makVrf::DtVrfBatchScenarioManager::allBackendsClosed

(

)

[protected, virtual]

Schedules next run.

virtual void makVrf::DtVrfBatchScenarioManager::loadScenarioError	(	const std::string &	error,
		bool	showMessage = true
	)		[protected, virtual]

Called when there is an error loading the scenario.

virtual void makVrf::DtVrfBatchScenarioManager::slot_scenarioLoadComplete

(

)

[protected, virtual]

Called after scenario is loaded.

virtual QString makVrf::DtVrfBatchScenarioManager::batchRunTitle

(

const DtScenario *

)

const [protected, virtual]

virtual void makVrf::DtVrfBatchScenarioManager::setMainWindowTitle

(

const QString &

)

[protected, virtual]

virtual QString makVrf::DtVrfBatchScenarioManager::mainWindowTitle

(

)

const [protected, virtual]

---

Member Data Documentation

boost::signal<void ()> makVrf::DtVrfBatchScenarioManager::signal_stateRunStart

boost::signal<void ()> makVrf::DtVrfBatchScenarioManager::signal_nextRunAboutToStart

Sent after the last scenario has closed and next one is about to start.

boost::signal<void ()> makVrf::DtVrfBatchScenarioManager::signal_batchRunComplete

Sent when all batch files have been run.

boost::signal<void ()> makVrf::DtVrfBatchScenarioManager::signal_errorLoadingScenario

boost::signal<void ()> makVrf::DtVrfBatchScenarioManager::signal_scenarioRunComplete

Signalled when a scenario run is complete.

DtScenarioBatchIterator* makVrf::DtVrfBatchScenarioManager::myBatchIterator [protected]

makVrv::DtDe& makVrf::DtVrfBatchScenarioManager::myDe [protected]

QString makVrf::DtVrfBatchScenarioManager::myBatchFile [protected]

bool makVrf::DtVrfBatchScenarioManager::myRunning [protected]

DtVrfScenarioRemapFunction* makVrf::DtVrfBatchScenarioManager::myRemap [protected]

double makVrf::DtVrfBatchScenarioManager::myRunStartTime [protected]

State makVrf::DtVrfBatchScenarioManager::myState [protected]

QString makVrf::DtVrfBatchScenarioManager::myOriginalTitle [protected]

---

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

• include/vrfGuiCoreQt/DtVrfBatchScenarioManager.h