makVrf::DtVrfSaveScenarioHandler Class Reference

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

Inheritance diagram for makVrf::DtVrfSaveScenarioHandler:

List of all members.

Public Member Functions
	DtVrfSaveScenarioHandler (makVrv::DtDe &)
virtual	~DtVrfSaveScenarioHandler ()
virtual bool	saveScenarioAs ()
virtual bool	saveScenario (bool forceOverwrite=false)
	If force overwrite is true, and checkpointing, force an overwrite of the existing scenario file.
virtual void	setScenario (const DtScenario *)
virtual bool	saveScenario (const QString &s, bool setAsSaved=true)
	Saves the specified scenario, and, if optional flag is true, sets last saved filename to supplied filename.
virtual QString	makeRelativeTo (QString origFile, QString path) const
virtual void	checkpointScenario (const QString &baseFilename, bool forceOverwrite=false)
virtual QString	checkpointIdentifier (const QString &filename) const
virtual QString	getTimeString (double time) const
const DtScenario *	scenario () const
DtFilename	savedFilename () const
Static Public Member Functions
static DtVrfSaveScenarioHandler &	instance (makVrv::DtDe &de)
	Returns instance of the messager.
Public Attributes
boost::signal< void(DtScenario *)>	signal_scenarioAboutToBeSaved
	Signal sent right before the message is sent to the simulation engines to save the scenario.
Protected Member Functions
virtual QString	createFilterList () const
virtual QString	startingDirectory () const
virtual QString	relativePath () const
virtual QString	dataFolder () const
virtual bool	processPreserveMappings ()
virtual bool	saveSelectionGroups (const QString &scenarioName, QString &selectionGroups) const
	Not yet implemented but provided to give names to save to support 2D scenario loads.
virtual bool	saveOverlays (const QString &scenarioName, QString &overlayName) const
virtual bool	saveGuiSettings (const QString &scenarioname, QString &guiSettingsName) const
	Save out gui settings file.
Static Protected Member Functions
static bool	preserveMappings (void *)
Protected Attributes
makVrv::DtDe &	myDe
QString	myStartingDirectory
DtScenario *	myScenario
double	myLastSavedSimTime

---

Detailed Description

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

---

Constructor & Destructor Documentation

makVrf::DtVrfSaveScenarioHandler::DtVrfSaveScenarioHandler

(

makVrv::DtDe &

)

virtual makVrf::DtVrfSaveScenarioHandler::~DtVrfSaveScenarioHandler

(

)

[virtual]

---

Member Function Documentation

static DtVrfSaveScenarioHandler& makVrf::DtVrfSaveScenarioHandler::instance

(

makVrv::DtDe &

de

)

[static]

Returns instance of the messager.

virtual bool makVrf::DtVrfSaveScenarioHandler::saveScenarioAs

(

)

[virtual]

virtual bool makVrf::DtVrfSaveScenarioHandler::saveScenario

(

bool

forceOverwrite = false

)

[virtual]

If force overwrite is true, and checkpointing, force an overwrite of the existing scenario file.

virtual void makVrf::DtVrfSaveScenarioHandler::setScenario

(

const DtScenario *

)

[virtual]

virtual bool makVrf::DtVrfSaveScenarioHandler::saveScenario	(	const QString &	s,
		bool	setAsSaved = true
	)		[virtual]

Saves the specified scenario, and, if optional flag is true, sets last saved filename to supplied filename.

virtual QString makVrf::DtVrfSaveScenarioHandler::makeRelativeTo	(	QString	origFile,
		QString	path
	)		const [virtual]

virtual void makVrf::DtVrfSaveScenarioHandler::checkpointScenario	(	const QString &	baseFilename,
		bool	forceOverwrite = false
	)		[virtual]

virtual QString makVrf::DtVrfSaveScenarioHandler::checkpointIdentifier

(

const QString &

filename

)

const [virtual]

virtual QString makVrf::DtVrfSaveScenarioHandler::getTimeString

(

double

time

)

const [virtual]

const DtScenario* makVrf::DtVrfSaveScenarioHandler::scenario

(

)

const [inline]

DtFilename makVrf::DtVrfSaveScenarioHandler::savedFilename

(

)

const

virtual QString makVrf::DtVrfSaveScenarioHandler::createFilterList

(

)

const [protected, virtual]

virtual QString makVrf::DtVrfSaveScenarioHandler::startingDirectory

(

)

const [protected, virtual]

virtual QString makVrf::DtVrfSaveScenarioHandler::relativePath

(

)

const [protected, virtual]

virtual QString makVrf::DtVrfSaveScenarioHandler::dataFolder

(

)

const [protected, virtual]

static bool makVrf::DtVrfSaveScenarioHandler::preserveMappings

(

void *

)

[static, protected]

virtual bool makVrf::DtVrfSaveScenarioHandler::processPreserveMappings

(

)

[protected, virtual]

virtual bool makVrf::DtVrfSaveScenarioHandler::saveSelectionGroups	(	const QString &	scenarioName,
		QString &	selectionGroups
	)		const [protected, virtual]

Not yet implemented but provided to give names to save to support 2D scenario loads.

virtual bool makVrf::DtVrfSaveScenarioHandler::saveOverlays	(	const QString &	scenarioName,
		QString &	overlayName
	)		const [protected, virtual]

virtual bool makVrf::DtVrfSaveScenarioHandler::saveGuiSettings	(	const QString &	scenarioname,
		QString &	guiSettingsName
	)		const [protected, virtual]

Save out gui settings file.

---

Member Data Documentation

boost::signal<void (DtScenario*)> makVrf::DtVrfSaveScenarioHandler::signal_scenarioAboutToBeSaved

Signal sent right before the message is sent to the simulation engines to save the scenario.

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

QString makVrf::DtVrfSaveScenarioHandler::myStartingDirectory [protected]

DtScenario* makVrf::DtVrfSaveScenarioHandler::myScenario [protected]

double makVrf::DtVrfSaveScenarioHandler::myLastSavedSimTime [protected]

---

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

• include/vrfGuiCoreQt/DtVrfSaveScenarioHandler.h