VR-Forces 4.2 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes
makVrf::DtVrfSaveScenarioHandler Class Reference

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

Inheritance diagram for makVrf::DtVrfSaveScenarioHandler:
Inheritance graph
[legend]

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
virtual std::string scenarioExtentInformation () const
 Returns a string representation of the scenario extent for all current entities in the scenario.
const DtScenarioscenario () const
DtFilename savedFilename () const
virtual std::string defaultObserverView () const
 Default observer view handling.
virtual void setDefaultObserverView (const std::string &)
 Default observer view handling.

Static Public Member Functions

static DtVrfSaveScenarioHandlerinstance (makVrv::DtDe &de)
 Returns instance of the messager.

Public Attributes

boost::signal< void(DtScenario *)> signal_scenarioInformationAboutToBeSaved
 Signal sent right before the front-end scenario information is saved including the overlays, selection groups, GUI settings and saved observer views.
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
virtual bool saveOverlays (const QString &scenarioName, QString &overlayName) const
virtual bool saveGuiSettings (const QString &scenarioname, QString &guiSettingsName) const
 Save out gui settings file.
virtual bool saveObserverViews (const QString &scenarioname, QString &observerSettingsName) const
 Save out observer views file.

Static Protected Member Functions

static bool preserveMappings (void *)

Protected Attributes

makVrv::DtDe & myDe
QString myStartingDirectory
DtScenariomyScenario
double myLastSavedSimTime
std::string myDefaultObserverView

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 std::string makVrf::DtVrfSaveScenarioHandler::defaultObserverView ( ) const
virtual

Default observer view handling.

virtual void makVrf::DtVrfSaveScenarioHandler::setDefaultObserverView ( const std::string &  )
virtual

Default observer view handling.

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
virtual std::string makVrf::DtVrfSaveScenarioHandler::scenarioExtentInformation ( ) const
virtual

Returns a string representation of the scenario extent for all current entities in the scenario.

Format is geometric center with the altitude of the highest entity being the altitude, and the half size of the maximum of the width and height of the extent box encompassed by the entities

const DtScenario* makVrf::DtVrfSaveScenarioHandler::scenario ( ) const
inline
DtFilename makVrf::DtVrfSaveScenarioHandler::savedFilename ( ) const
virtual QString makVrf::DtVrfSaveScenarioHandler::createFilterList ( ) const
protectedvirtual
virtual QString makVrf::DtVrfSaveScenarioHandler::startingDirectory ( ) const
protectedvirtual
virtual QString makVrf::DtVrfSaveScenarioHandler::relativePath ( ) const
protectedvirtual
virtual QString makVrf::DtVrfSaveScenarioHandler::dataFolder ( ) const
protectedvirtual
static bool makVrf::DtVrfSaveScenarioHandler::preserveMappings ( void *  )
staticprotected
virtual bool makVrf::DtVrfSaveScenarioHandler::processPreserveMappings ( )
protectedvirtual
virtual bool makVrf::DtVrfSaveScenarioHandler::saveSelectionGroups ( const QString &  scenarioName,
QString &  selectionGroups 
) const
protectedvirtual
virtual bool makVrf::DtVrfSaveScenarioHandler::saveOverlays ( const QString &  scenarioName,
QString &  overlayName 
) const
protectedvirtual
virtual bool makVrf::DtVrfSaveScenarioHandler::saveGuiSettings ( const QString &  scenarioname,
QString &  guiSettingsName 
) const
protectedvirtual

Save out gui settings file.

virtual bool makVrf::DtVrfSaveScenarioHandler::saveObserverViews ( const QString &  scenarioname,
QString &  observerSettingsName 
) const
protectedvirtual

Save out observer views file.

Member Data Documentation

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

Signal sent right before the front-end scenario information is saved including the overlays, selection groups, GUI settings and saved observer views.

This will signal before signal_scenarioAboutToBeSaved.

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
std::string makVrf::DtVrfSaveScenarioHandler::myDefaultObserverView
protected

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

Document ID: Generated on Sun Nov 24 19:49:21 EST 2013 from SVN revision 133924
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)