VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes
makVrf::DtVrfGuiApplication Class Reference

The root IG for VR-Forces. Inherits from makVrv::DtVrfApplication. More...

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

Public Types

enum  ObserverMode { PvdAndStealthMode = 0, PvdMode, StealthMode }
 
typedef std::map< std::string,
std::string > 
ObserverModeBindings
 
- Public Types inherited from makVrv::DtVrvApplication
typedef boost::function< void(DtVrvApplicationConfiguration
&, int argc, char **argv)> 
ConfigurationTransform
 Type for a function object that transforms an app config in some way. More...
 
typedef boost::function< void(DtDeInitializer
&, DtDe
&, DtVrvApplicationConfiguration &)> 
ApplicationTransform
 Type for a function object that transforms an DtDeInitializer, DtDe or DtVrvApplicationConfiguration in some way. More...
 

Public Member Functions

 DtVrfGuiApplication (makVrv::DtVrvApplicationConfiguration &config)
 Constructor to the VRFGUI application. More...
 
virtual ~DtVrfGuiApplication ()
 Destructor to the VRFGUI application. More...
 
virtual void initialize (int argc, char **argv)
 Initializes the application with the given command line options. More...
 
virtual void assemble ()
 Assembles the application and signals the pre and post of the assembly process. More...
 
virtual void run ()
 Runs the application. Signals deInitialized if application has started successfully. More...
 
virtual DtString layoutSettingsFileClassName () const
 Returns the class name from the layout settings file. More...
 
virtual std::string userScenarioDirectory ()
 
virtual std::string userTerrainDirectory ()
 
void setPluginApplication (const std::string &)
 Sets the plugin application name. More...
 
const std::string & pluginApplication () const
 Gets the plugin application name. More...
 
virtual void setLoadSystemPlugins (bool)
 If set to false does not load any plugins from the plugins directory. Default is true. More...
 
virtual bool loadSystemPlugins () const
 
virtual makVrv::DtUnicode applicationName () const
 Returns the application name as defined in the configuration. More...
 
virtual void writeGuiConfiguration ()
 Override to send out pre/post write gui configuration signals. More...
 
virtual void loadSavedGuiState ()
 Override to not load if not loading gui saved state. More...
 
virtual bool getShowStartupScreen () const
 Return false to now show Vantage version of the startup screen. More...
 
virtual bool usingAbsoluteTimeStamps () const
 Returns true if driver is using absolute time stamping. More...
 
virtual bool usingAsynchIO () const
 Returns true if driver is using asynchronous io. More...
 
virtual makVrv::DtVrlinkDrivergetVrlinkDriver () const
 Gets the communications driver. More...
 
virtual DtSimulationAddress frontEndSimulationAddress () const
 The front end simulation address of this front-end. More...
 
virtual bool vrlDriverHasBooleanValue (const std::string &, bool *hasValue=NULL) const
 
virtual bool vrlDriverHasBooleanValue (makVrv::DtVrlinkDriver *, const std::string &, bool *hasValue=NULL) const
 
virtual int vrlDriverHasIntegerValue (const std::string &, bool *hasValue=NULL) const
 
virtual int vrlDriverHasIntegerValue (makVrv::DtVrlinkDriver *, const std::string &, bool *hasValue=NULL) const
 
virtual double vrlDriverHasDoubleValue (const std::string &, bool *hasValue=NULL) const
 
virtual double vrlDriverHasDoubleValue (makVrv::DtVrlinkDriver *, const std::string &, bool *hasValue=NULL) const
 
virtual std::string vrlDriverHasStringValue (const std::string &, bool *hasValue=NULL) const
 
virtual std::string vrlDriverHasStringValue (makVrv::DtVrlinkDriver *, const std::string &, bool *hasValue=NULL) const
 
void setVrfSvnRevision (const std::string &s)
 
const std::string & vrfSvnRevision () const
 
void setVrvSvnRevision (const std::string &s)
 
const std::string & vrvSvnRevision () const
 
virtual bool terrainIsValid (int terrainPathOffset=0)
 Returns true if there is a valid terrain (patches, ocean layer, featuer layer) More...
 
virtual std::string language () const
 Language code application is using. More...
 
- Public Member Functions inherited from makVrv::DtVrvApplication
 DtVrvApplication ()
 Constructor. More...
 
 DtVrvApplication (const DtVrvApplicationConfiguration &appConfig)
 
virtual ~DtVrvApplication ()
 Destructor. More...
 
DtVrvApplicationConfigurationconfiguration ()
 DtVrvApplicationConfiguration accessor. More...
 
DtPageConfigurationmasterModePageConfiguration ()
 Get the page configuration which may be altered by plugins. More...
 
DtPageConfigurationslaveModePageConfiguration ()
 
DtMenuConfigurationmasterModeMenuConfiguration ()
 Get the menu configuration which may be altered by plugins. More...
 
DtMenuConfigurationslaveModeMenuConfiguration ()
 
DtToolbarConfigurationmasterModeToolbarConfiguration ()
 Get the toolbar configuration which may be altered by plugins. More...
 
DtToolbarConfigurationslaveModeToolbarConfiguration ()
 
DtDede ()
 DtDe accessor. More...
 
virtual DtPluginManagerpluginManager ()
 Provide access to the plugin manager. More...
 
virtual void slot_sceneTerrainLoaded (const DtUnicode &terrain)
 slots for the DtScene signals so the scenes/terrains can get added to the recent terrains list More...
 
virtual void slot_sceneTerrainSaved (const std::string &terrain)
 
virtual void slot_sceneToBeLoaded (const std::string &terrain)
 
virtual void slot_sceneLoaded (const std::string &terrain)
 
virtual void slot_sceneSaved (const std::string &terrain)
 
virtual std::list< std::string > & getRecentTerrains ()
 
virtual void setShowStartupScreen (bool show)
 
virtual void installCommandLineProcessor (DtVrvCommandLineProcessor *commandLineProcessor)
 Add a configuration transformer that runs at command line processor level priority. More...
 
virtual void installPrePluginTransform (const ApplicationTransform &transform, const std::string &id)
 Add a transformer that runs before plug-ins are loaded. More...
 
virtual void installPostPluginTransform (const ApplicationTransform &transform, const std::string &id)
 Add a transformer that runs after plug-ins are loaded. More...
 
virtual void installPostAssembleTransform (const ApplicationTransform &transform, const std::string &id)
 Add a transformer that runs after the application is assembled and before the DtDe is initialized. More...
 

Static Public Member Functions

static bool applicationIsTerminating (makVrv::DtDe &)
 Will return true if the application is destructing. More...
 
static DtVrfGuiApplicationapp (makVrv::DtDe &)
 
static makVrv::DtDetheDe ()
 
static void setNoSpotReportDefinitionLoading (bool val)
 Sets whether or not to use VLD memory tracking. Only enabled is USE_VLD_MEMORY_TRACKING is enabled. More...
 
static bool noSpotReportDefinitionLoading ()
 
static void setSpotReportElementDefinitionHierFilesOrDirs (const std::vector< std::string > &filesOrDirs)
 Sets the name of additional spot report elements definition hierarchy (.hier) files (or dirs with .hier files) to merge after the spot report element definitions are loaded. More...
 
static const std::vector
< std::string > & 
spotReportElementDefinitionHierFilesOrDirs ()
 
static void setSpotReportElementDefinitionLeafFilesOrDirs (const std::vector< std::string > &filesOrDirs)
 Sets the name of additional spot report element definition hierarchy (.leaf) files (or dirs with .leaf files) to merge after the spot report element definitions are loaded. More...
 
static const std::vector
< std::string > & 
spotReportElementDefinitionLeafFilesOrDirs ()
 
static void setIgnoreLayoutGeometryOnInitialLoad (bool)
 Sets whether or not to ignore setting layout geometry on initial load regardless of what it is set at and to always start maximized. More...
 
static bool ignoreLayoutGeometryOnInitialLoad ()
 
static void setShowPerspective (const std::string &)
 Sets the initial perspective to show for ground truth. More...
 
static void setQtDesignerPluginSupport (bool)
 Sets whether or not to allow Qt designer plugin support from the applicaiton. Default is true. This must be set at initialization time. More...
 
static bool qtDesignerPluginSupport ()
 
static void setGuiConfiguration (const std::string &)
 Sets the gui configuration file to use. More...
 
static void setObserverModeBindings (const ObserverModeBindings &modes)
 Sets the observer mode bindings to a different set of bindings. More...
 
static const ObserverModeBindingsobserverModeBindings ()
 Gets the current observer mode bindings that are set. More...
 
static const std::vector
< std::string > & 
additionalPluginsToLoad ()
 Gets a list of additional plugins to be loaded or were loaded by loadPluginModules() More...
 
static void setAdditionalPluginsToLoad (const std::vector< std::string > &)
 Sets the list of additional plugins to be loaded by loadPluginModules() More...
 
static bool loadDefaultPlugins ()
 Gets whether the default plugins should be loaded or not. More...
 
static void setLoadDefaultPlugins (bool)
 Sets whether the default plugins were loaded or not. More...
 
static bool checkPluginVersions ()
 Gets whether to check the plugin versions or not. More...
 
static void setCheckPluginVersions (bool)
 Sets whether to check the plugin versions or not. More...
 
static const std::string & transport ()
 Gets the transport string. More...
 
static void setTransport (const std::string &)
 Sets the transport string. More...
 
static const std::string & loadScenario ()
 Gets the currently loaded scenario name. More...
 
static void setLoadScenario (const std::string &)
 Sets the currently loaded scenario name. More...
 
static const std::string & useFileCommChannel ()
 If empty use this file comm channel as a listener in the scenario manager class. More...
 
static void setUseFileCommChannel (const std::string &)
 
static void setLayoutSettingsFile (const std::string &)
 UI Layout settings file to use (base name at which default_ will be prepended and .uisx appended) More...
 
static std::string layoutSettingsFile ()
 
static const std::string & loadSimulationObjectGroup ()
 Gets the currently loaded simulation object group name. More...
 
static void setLoadSimulationObjectGroup (const std::string &)
 Sets the currently loaded simulation object group name. More...
 
static void setDefaultSimulationModelSet (const std::string &)
 Sets the default simulation model set to use. Will override any setting within the session settings file. More...
 
static const std::string & defaultSimulationModelSet ()
 
static ObserverMode observerMode ()
 Gets the current observer mode. More...
 
static void setObserverMode (ObserverMode)
 Sets the current observer mode. More...
 
static void setUserScenarioDirectory (const std::string &)
 Sets the user scenario directory. More...
 
static void setUserTerrainDirectory (const std::string &)
 Sets the user terrain directory. More...
 
static void setShouldLoadGuiSavedState (bool)
 Set to false to not load gui saved state. More...
 
static bool shouldLoadGuiSavedState ()
 
- Static Public Member Functions inherited from makVrv::DtVrvApplication
static DtVrvApplicationget_last_instance ()
 Returns the last DtVrvApplication created, regardless of DtDe. More...
 
static void ShowSplashScreen (const std::string &imageName)
 Show a brief splash screen. More...
 
static void ShowErrorMessage (const std::string &message, DtException *ex=0)
 Show a brief splash screen. More...
 
static DtVrvApplicationfindFromDe (DtDe &)
 If an IG is created by an application you can find the IG application which created/owns it. More...
 
static bool parseDisplayEngineParameter (const std::string &argument, int &port, std::string &address, std::string &displayConfig)
 Parse a display engine command line argument. More...
 
static std::string displayEngineParameterFormatting ()
 Get the format of the display engine parameter. More...
 
static void setShowErrorMessageDialog (bool show)
 set the show error message dialog flag. If true errors will show a dialog, if false they will print to console. More...
 
static bool showErrorMessageDialog ()
 get the show error message dialog flag. If true errors will show a dialog, if false they will print to console. More...
 
static void handleFileError (const std::string &filename, const std::string &fileType)
 Handle when a file specified on the command line can't be read. More...
 
static void bindViews (const std::vector< std::string > &filenames, makVrv::DtDeInitializer::ObserverStateMap &aMap)
 Places all views into the supplied observer view map and binds to the supplied observer view. More...
 
static bool loadObserverStateRecords (const std::string &file, makArchives::DtObserverStateRecordsList &list)
 Loads up observer state records from filename into specified list. More...
 
static void loadViews (const std::vector< std::string > &filenames, makVrv::DtDeInitializer::ObserverStateMap &aMap)
 Places all views into the supplied observer view map. More...
 

Public Attributes

boost::signals2::signal< void(makVrv::DtDe
&, makVrv::DtMenuConfiguration &)> 
signal_preAssemble
 
boost::signals2::signal< void(makVrv::DtDe
&, makVrv::DtMenuConfiguration &)> 
signal_postAssemble
 
boost::signals2::signal< void(makVrv::DtDe &)> signal_deInitialized
 
boost::signals2::signal< void()> signal_preLoadPlugins
 
boost::signals2::signal< void()> signal_postLoadPlugins
 
boost::signals2::signal< void()> signal_preWriteGuiConfiguration
 
boost::signals2::signal< void()> signal_postWriteGuiConfiguration
 
boost::signals2::signal< void(std::string)> signal_terrainSaved
 
boost::signals2::signal< void(std::string)> signal_simTerrainSaved
 
boost::signals2::signal< void()> signal_defaultLayoutLoaded
 
boost::signals2::signal< void()> signal_vrfApplicationInitialized
 
boost::signals2::signal< void()> signal_qtExtensionsPreInitialize
 Signals sent via the qt extension initialization. More...
 
boost::signals2::signal< void()> signal_qtExtensionsPostInitialize
 

Protected Member Functions

virtual void loadPluginModules ()
 Override to set up additional plugins to load. More...
 
virtual void loadPluginModulesExt ()
 Reimplement this method to load additional plugin modules (read from the .xml files) after all core plugin modules. More...
 
virtual void initializePluginManager ()
 Initializes the plugin manager. More...
 
virtual void initializePluginsForCommandLineArguments (int argc, char **argv)
 Called to load plugins and initilize for command line arguments only. More...
 
virtual void bindObserverModes (const ObserverModeBindings &modes)
 Given the list, binds the observers (if they exist) to the visual mode. More...
 
virtual DtVrfGuiPluginManagercreatePluginManager ()
 Creates and returns the plugin manager for VRF plugins. More...
 
virtual void dePostInitialize ()
 Called during the post initialize process of the de, initialize some things before drivers get initialized. More...
 
virtual void setupForObserverMode ()
 Called to set up Gui configuration and settings based on current observer mode selection. More...
 
virtual void setupForPvdMode ()
 Sets up GUI for PVD mode only. Experimental as of 4.0. More...
 
virtual void setupForStealthMode ()
 Sets up for Stealth only. Experimental as of 4.0. More...
 
virtual bool updateCurrentGuiConfiguration ()
 Updates the current GUI configuration with the current UI layout status. More...
 
- Protected Member Functions inherited from makVrv::DtVrvApplication
virtual void createDefaultDisplayEngineConfiguration ()
 Create default engine configurations if none exist. More...
 
virtual DtDisplayConfiguration embeddedMasterDisplayConfig ()
 Helper method that returns an embedded display config. More...
 
virtual void createDefaultObserverConfiguration ()
 Create default observer configurations if none exist. More...
 
virtual void addRecentTerrain (const std::string &terrain)
 add a terrain/scene to the list of recent terrains. More...
 

Protected Attributes

DtVrfGuiPluginManagermyVrfGuiPluginManager
 
std::string myPluginApplication
 
std::string myVrfSvnRevision
 
std::string myVrvSvnRevision
 
bool myLoadSystemPlugins
 
- Protected Attributes inherited from makVrv::DtVrvApplication
DtVrvApplicationConfiguration myConfiguration
 
DtDeInitializer myInitializer
 
DtVrvCommandLineProcessormyCommandLineProcessor
 
DtDemyDe
 
DtPluginManagermyPluginManager
 
DtEventLoopmyEventLoop
 
InitializerTransformList myPrePluginTransforms
 
InitializerTransformList myPostPluginTransforms
 
InitializerTransformList myPostAssembleTransforms
 
DtSignalConnectionManagermyConnections
 
bool myIsSceneLoading
 

Static Protected Attributes

static ObserverModeBindings theObserverModeBindings
 
static std::vector< std::string > theAdditionalPluginsToLoad
 
static bool theLoadDefaultPlugins
 
static bool theCheckPluginVersions
 
static std::string theTransport
 
static std::string theLoadScenario
 
static std::string theLayoutSettingsFile
 
static std::string theLoadSimulationObjectGroup
 
static std::string theUseFileCommChannel
 
static std::string theGuiConfiguration
 
static std::string theShowPerspective
 
static std::string theDefaultSimulationModelSet
 
static std::string theUserScenarioDirectory
 
static std::string theUserTerrainDirectory
 
static ObserverMode theObserverMode
 
static bool theLoadGuiSavedState
 
static bool theIgnoreLayoutGeometryOnInitialLoad
 
static bool theQtDesignerPluginSupport
 
static bool theNoSpotDefinitionLoading
 
static std::vector< std::string > theSpotReportElementDefinitionHierFilesOrDirs
 
static std::vector< std::string > theSpotReportElementDefinitionLeafFilesOrDirs
 
- Static Protected Attributes inherited from makVrv::DtVrvApplication
static DtVrvApplicationsLastAppInstance
 
static bool theShowErrorMessageDialog
 

Additional Inherited Members

- Static Public Attributes inherited from makVrv::DtVrvApplication
static const int MAX_RECENT_TERRAIN_COUNT = 20
 
- Protected Types inherited from makVrv::DtVrvApplication
typedef std::list< std::pair
< std::string,
ApplicationTransform > > 
InitializerTransformList
 

Detailed Description

The root IG for VR-Forces. Inherits from makVrv::DtVrfApplication.

Member Typedef Documentation

typedef std::map<std::string, std::string> makVrf::DtVrfGuiApplication::ObserverModeBindings

Member Enumeration Documentation

Enumerator
PvdAndStealthMode 
PvdMode 
StealthMode 

Constructor & Destructor Documentation

makVrf::DtVrfGuiApplication::DtVrfGuiApplication ( makVrv::DtVrvApplicationConfiguration config)

Constructor to the VRFGUI application.

Parameters
configConfiguration to load
virtual makVrf::DtVrfGuiApplication::~DtVrfGuiApplication ( )
virtual

Destructor to the VRFGUI application.

Member Function Documentation

static bool makVrf::DtVrfGuiApplication::applicationIsTerminating ( makVrv::DtDe )
static

Will return true if the application is destructing.

virtual void makVrf::DtVrfGuiApplication::initialize ( int  argc,
char **  argv 
)
virtual

Initializes the application with the given command line options.

Parameters
argccommand line args
argvcommand line args

Reimplemented from makVrv::DtVrvApplication.

Reimplemented in DtSimulationObjectEditorApplication, and DtParameterAlteringApplication.

virtual void makVrf::DtVrfGuiApplication::assemble ( )
virtual

Assembles the application and signals the pre and post of the assembly process.

Reimplemented from makVrv::DtVrvApplication.

Reimplemented in DtParameterAlteringApplication.

virtual void makVrf::DtVrfGuiApplication::run ( )
virtual

Runs the application. Signals deInitialized if application has started successfully.

Reimplemented from makVrv::DtVrvApplication.

Reimplemented in DtParameterAlteringApplication.

static DtVrfGuiApplication* makVrf::DtVrfGuiApplication::app ( makVrv::DtDe )
static
Returns
A pointer to the application object
static makVrv::DtDe* makVrf::DtVrfGuiApplication::theDe ( )
static
Returns
The system global singleton de. Access to this de is not thread safe. Use with caution
static void makVrf::DtVrfGuiApplication::setNoSpotReportDefinitionLoading ( bool  val)
static

Sets whether or not to use VLD memory tracking. Only enabled is USE_VLD_MEMORY_TRACKING is enabled.

Set whether to use appData directory to load spot report element definitions

static bool makVrf::DtVrfGuiApplication::noSpotReportDefinitionLoading ( )
static
static void makVrf::DtVrfGuiApplication::setSpotReportElementDefinitionHierFilesOrDirs ( const std::vector< std::string > &  filesOrDirs)
static

Sets the name of additional spot report elements definition hierarchy (.hier) files (or dirs with .hier files) to merge after the spot report element definitions are loaded.

static const std::vector<std::string>& makVrf::DtVrfGuiApplication::spotReportElementDefinitionHierFilesOrDirs ( )
static
static void makVrf::DtVrfGuiApplication::setSpotReportElementDefinitionLeafFilesOrDirs ( const std::vector< std::string > &  filesOrDirs)
static

Sets the name of additional spot report element definition hierarchy (.leaf) files (or dirs with .leaf files) to merge after the spot report element definitions are loaded.

static const std::vector<std::string>& makVrf::DtVrfGuiApplication::spotReportElementDefinitionLeafFilesOrDirs ( )
static
static void makVrf::DtVrfGuiApplication::setIgnoreLayoutGeometryOnInitialLoad ( bool  )
static

Sets whether or not to ignore setting layout geometry on initial load regardless of what it is set at and to always start maximized.

static bool makVrf::DtVrfGuiApplication::ignoreLayoutGeometryOnInitialLoad ( )
static
static void makVrf::DtVrfGuiApplication::setShowPerspective ( const std::string &  )
static

Sets the initial perspective to show for ground truth.

Current valid values are Friendly, Opposing, Neutral, None. This is the same as selecting the particular value from the pulldown in the spot report options dialog. This will show ground truth and spot reports for the given object

static void makVrf::DtVrfGuiApplication::setQtDesignerPluginSupport ( bool  )
static

Sets whether or not to allow Qt designer plugin support from the applicaiton. Default is true. This must be set at initialization time.

static bool makVrf::DtVrfGuiApplication::qtDesignerPluginSupport ( )
static
static void makVrf::DtVrfGuiApplication::setGuiConfiguration ( const std::string &  )
static

Sets the gui configuration file to use.

If the file does not exist then the default built in configuration will be used. Assumed to be in the settings directory unless a directory is specified

static void makVrf::DtVrfGuiApplication::setObserverModeBindings ( const ObserverModeBindings modes)
static

Sets the observer mode bindings to a different set of bindings.

Parameters
modesModes to set the observer to
static const ObserverModeBindings& makVrf::DtVrfGuiApplication::observerModeBindings ( )
static

Gets the current observer mode bindings that are set.

Returns
Current observer mode bindings.
static const std::vector<std::string>& makVrf::DtVrfGuiApplication::additionalPluginsToLoad ( )
static

Gets a list of additional plugins to be loaded or were loaded by loadPluginModules()

Returns
a std::vector of std::string with the name of the plugins
static void makVrf::DtVrfGuiApplication::setAdditionalPluginsToLoad ( const std::vector< std::string > &  )
static

Sets the list of additional plugins to be loaded by loadPluginModules()

Parameters
aVectora std::vector of std::string with the name of the plugins
static bool makVrf::DtVrfGuiApplication::loadDefaultPlugins ( )
static

Gets whether the default plugins should be loaded or not.

Returns
true if it was set to true, false otherwise
static void makVrf::DtVrfGuiApplication::setLoadDefaultPlugins ( bool  )
static

Sets whether the default plugins were loaded or not.

Parameters
valueof true or false
static bool makVrf::DtVrfGuiApplication::checkPluginVersions ( )
static

Gets whether to check the plugin versions or not.

Returns
true if should check plugin versions, false otherwise
static void makVrf::DtVrfGuiApplication::setCheckPluginVersions ( bool  )
static

Sets whether to check the plugin versions or not.

Parameters
valuetrue or false
static const std::string& makVrf::DtVrfGuiApplication::transport ( )
static

Gets the transport string.

Returns
String of the transport
static void makVrf::DtVrfGuiApplication::setTransport ( const std::string &  )
static

Sets the transport string.

Parameters
valuethe transport
static const std::string& makVrf::DtVrfGuiApplication::loadScenario ( )
static

Gets the currently loaded scenario name.

Will return an empty string if no scenario is loaded.

Returns
the name of the scenario loaded
static void makVrf::DtVrfGuiApplication::setLoadScenario ( const std::string &  )
static

Sets the currently loaded scenario name.

Parameters
valuethe name of the scenario loaded
static const std::string& makVrf::DtVrfGuiApplication::useFileCommChannel ( )
static

If empty use this file comm channel as a listener in the scenario manager class.

static void makVrf::DtVrfGuiApplication::setUseFileCommChannel ( const std::string &  )
static
static void makVrf::DtVrfGuiApplication::setLayoutSettingsFile ( const std::string &  )
static

UI Layout settings file to use (base name at which default_ will be prepended and .uisx appended)

static std::string makVrf::DtVrfGuiApplication::layoutSettingsFile ( )
static
virtual DtString makVrf::DtVrfGuiApplication::layoutSettingsFileClassName ( ) const
virtual

Returns the class name from the layout settings file.

static const std::string& makVrf::DtVrfGuiApplication::loadSimulationObjectGroup ( )
static

Gets the currently loaded simulation object group name.

Will return an empty string if no simulation object group is loaded.

Returns
the name of the simulation object group loaded
static void makVrf::DtVrfGuiApplication::setLoadSimulationObjectGroup ( const std::string &  )
static

Sets the currently loaded simulation object group name.

Parameters
valuethe name of the simulation object group loaded
static void makVrf::DtVrfGuiApplication::setDefaultSimulationModelSet ( const std::string &  )
static

Sets the default simulation model set to use. Will override any setting within the session settings file.

static const std::string& makVrf::DtVrfGuiApplication::defaultSimulationModelSet ( )
static
static ObserverMode makVrf::DtVrfGuiApplication::observerMode ( )
static

Gets the current observer mode.

Returns
The observer mode
static void makVrf::DtVrfGuiApplication::setObserverMode ( ObserverMode  )
static

Sets the current observer mode.

Parameters
valueThe observer mode
static void makVrf::DtVrfGuiApplication::setUserScenarioDirectory ( const std::string &  )
static

Sets the user scenario directory.

Use the application class method to return the actual directory as the de is needed for the path configuration to get a resolved user scenario path (if the given path is blank, which means default)

virtual std::string makVrf::DtVrfGuiApplication::userScenarioDirectory ( )
virtual
static void makVrf::DtVrfGuiApplication::setUserTerrainDirectory ( const std::string &  )
static

Sets the user terrain directory.

Use the application class method to return the actual directory as the de is needed for the path configuration to get a resolved user scenario path (if the given path is blank, which means default)

virtual std::string makVrf::DtVrfGuiApplication::userTerrainDirectory ( )
virtual
void makVrf::DtVrfGuiApplication::setPluginApplication ( const std::string &  )

Sets the plugin application name.

Parameters
valuestring name
const std::string& makVrf::DtVrfGuiApplication::pluginApplication ( ) const

Gets the plugin application name.

Returns
String name of plugin application
static void makVrf::DtVrfGuiApplication::setShouldLoadGuiSavedState ( bool  )
static

Set to false to not load gui saved state.

This must be called before the application object initialized

static bool makVrf::DtVrfGuiApplication::shouldLoadGuiSavedState ( )
static
virtual void makVrf::DtVrfGuiApplication::setLoadSystemPlugins ( bool  )
virtual

If set to false does not load any plugins from the plugins directory. Default is true.

virtual bool makVrf::DtVrfGuiApplication::loadSystemPlugins ( ) const
virtual
virtual makVrv::DtUnicode makVrf::DtVrfGuiApplication::applicationName ( ) const
virtual

Returns the application name as defined in the configuration.

virtual void makVrf::DtVrfGuiApplication::writeGuiConfiguration ( )
virtual

Override to send out pre/post write gui configuration signals.

Reimplemented from makVrv::DtVrvApplication.

virtual void makVrf::DtVrfGuiApplication::loadSavedGuiState ( )
virtual

Override to not load if not loading gui saved state.

Reimplemented from makVrv::DtVrvApplication.

virtual bool makVrf::DtVrfGuiApplication::getShowStartupScreen ( ) const
virtual

Return false to now show Vantage version of the startup screen.

Reimplemented from makVrv::DtVrvApplication.

virtual bool makVrf::DtVrfGuiApplication::usingAbsoluteTimeStamps ( ) const
virtual

Returns true if driver is using absolute time stamping.

virtual bool makVrf::DtVrfGuiApplication::usingAsynchIO ( ) const
virtual

Returns true if driver is using asynchronous io.

virtual makVrv::DtVrlinkDriver* makVrf::DtVrfGuiApplication::getVrlinkDriver ( ) const
virtual

Gets the communications driver.

virtual DtSimulationAddress makVrf::DtVrfGuiApplication::frontEndSimulationAddress ( ) const
virtual

The front end simulation address of this front-end.

virtual bool makVrf::DtVrfGuiApplication::vrlDriverHasBooleanValue ( const std::string &  ,
bool hasValue = NULL 
) const
virtual
virtual bool makVrf::DtVrfGuiApplication::vrlDriverHasBooleanValue ( makVrv::DtVrlinkDriver ,
const std::string &  ,
bool hasValue = NULL 
) const
virtual
virtual int makVrf::DtVrfGuiApplication::vrlDriverHasIntegerValue ( const std::string &  ,
bool hasValue = NULL 
) const
virtual
virtual int makVrf::DtVrfGuiApplication::vrlDriverHasIntegerValue ( makVrv::DtVrlinkDriver ,
const std::string &  ,
bool hasValue = NULL 
) const
virtual
virtual double makVrf::DtVrfGuiApplication::vrlDriverHasDoubleValue ( const std::string &  ,
bool hasValue = NULL 
) const
virtual
virtual double makVrf::DtVrfGuiApplication::vrlDriverHasDoubleValue ( makVrv::DtVrlinkDriver ,
const std::string &  ,
bool hasValue = NULL 
) const
virtual
virtual std::string makVrf::DtVrfGuiApplication::vrlDriverHasStringValue ( const std::string &  ,
bool hasValue = NULL 
) const
virtual
virtual std::string makVrf::DtVrfGuiApplication::vrlDriverHasStringValue ( makVrv::DtVrlinkDriver ,
const std::string &  ,
bool hasValue = NULL 
) const
virtual
void makVrf::DtVrfGuiApplication::setVrfSvnRevision ( const std::string &  s)
inline
const std::string& makVrf::DtVrfGuiApplication::vrfSvnRevision ( ) const
inline
void makVrf::DtVrfGuiApplication::setVrvSvnRevision ( const std::string &  s)
inline
const std::string& makVrf::DtVrfGuiApplication::vrvSvnRevision ( ) const
inline
virtual bool makVrf::DtVrfGuiApplication::terrainIsValid ( int  terrainPathOffset = 0)
virtual

Returns true if there is a valid terrain (patches, ocean layer, featuer layer)

virtual std::string makVrf::DtVrfGuiApplication::language ( ) const
virtual

Language code application is using.

virtual void makVrf::DtVrfGuiApplication::loadPluginModules ( )
protectedvirtual

Override to set up additional plugins to load.

Based on what is returned if one were to call additionalPluginsToLoad() to see what would be loaded.

Reimplemented from makVrv::DtVrvApplication.

Reimplemented in DtSimulationObjectEditorApplication.

virtual void makVrf::DtVrfGuiApplication::loadPluginModulesExt ( )
protectedvirtual

Reimplement this method to load additional plugin modules (read from the .xml files) after all core plugin modules.

This way the plugins do not have to call individual init() methods in core plugin modules to make sure they get initialized first

Reimplemented in DtParameterAlteringApplication.

virtual void makVrf::DtVrfGuiApplication::initializePluginManager ( )
protectedvirtual

Initializes the plugin manager.

virtual void makVrf::DtVrfGuiApplication::initializePluginsForCommandLineArguments ( int  argc,
char **  argv 
)
protectedvirtual

Called to load plugins and initilize for command line arguments only.

virtual void makVrf::DtVrfGuiApplication::bindObserverModes ( const ObserverModeBindings modes)
protectedvirtual

Given the list, binds the observers (if they exist) to the visual mode.

Parameters
modesObserverModeBindings list
virtual DtVrfGuiPluginManager* makVrf::DtVrfGuiApplication::createPluginManager ( )
protectedvirtual

Creates and returns the plugin manager for VRF plugins.

Will work with the configuration to determine which additional plugins to load. Will use the plugins directory as the source for reading in .xml files that will determine which additional plugins to load

Returns
Pointer to the plugin manager
virtual void makVrf::DtVrfGuiApplication::dePostInitialize ( )
protectedvirtual

Called during the post initialize process of the de, initialize some things before drivers get initialized.

Reimplemented in DtParameterAlteringApplication.

virtual void makVrf::DtVrfGuiApplication::setupForObserverMode ( )
protectedvirtual

Called to set up Gui configuration and settings based on current observer mode selection.

Experimental as of 4.0

virtual void makVrf::DtVrfGuiApplication::setupForPvdMode ( )
protectedvirtual

Sets up GUI for PVD mode only. Experimental as of 4.0.

virtual void makVrf::DtVrfGuiApplication::setupForStealthMode ( )
protectedvirtual

Sets up for Stealth only. Experimental as of 4.0.

virtual bool makVrf::DtVrfGuiApplication::updateCurrentGuiConfiguration ( )
protectedvirtual

Updates the current GUI configuration with the current UI layout status.

Reimplemented from makVrv::DtVrvApplication.

Reimplemented in DtParameterAlteringApplication.

Member Data Documentation

boost::signals2::signal<void (makVrv::DtDe&, makVrv::DtMenuConfiguration&)> makVrf::DtVrfGuiApplication::signal_preAssemble
boost::signals2::signal<void (makVrv::DtDe&, makVrv::DtMenuConfiguration&)> makVrf::DtVrfGuiApplication::signal_postAssemble
boost::signals2::signal<void (makVrv::DtDe&)> makVrf::DtVrfGuiApplication::signal_deInitialized
boost::signals2::signal<void ()> makVrf::DtVrfGuiApplication::signal_preLoadPlugins
boost::signals2::signal<void ()> makVrf::DtVrfGuiApplication::signal_postLoadPlugins
boost::signals2::signal<void ()> makVrf::DtVrfGuiApplication::signal_preWriteGuiConfiguration
boost::signals2::signal<void ()> makVrf::DtVrfGuiApplication::signal_postWriteGuiConfiguration
boost::signals2::signal<void (std::string)> makVrf::DtVrfGuiApplication::signal_terrainSaved
boost::signals2::signal<void (std::string)> makVrf::DtVrfGuiApplication::signal_simTerrainSaved
boost::signals2::signal<void ()> makVrf::DtVrfGuiApplication::signal_defaultLayoutLoaded
boost::signals2::signal<void ()> makVrf::DtVrfGuiApplication::signal_vrfApplicationInitialized
boost::signals2::signal<void ()> makVrf::DtVrfGuiApplication::signal_qtExtensionsPreInitialize

Signals sent via the qt extension initialization.

boost::signals2::signal<void ()> makVrf::DtVrfGuiApplication::signal_qtExtensionsPostInitialize
ObserverModeBindings makVrf::DtVrfGuiApplication::theObserverModeBindings
staticprotected
std::vector<std::string> makVrf::DtVrfGuiApplication::theAdditionalPluginsToLoad
staticprotected
bool makVrf::DtVrfGuiApplication::theLoadDefaultPlugins
staticprotected
bool makVrf::DtVrfGuiApplication::theCheckPluginVersions
staticprotected
std::string makVrf::DtVrfGuiApplication::theTransport
staticprotected
std::string makVrf::DtVrfGuiApplication::theLoadScenario
staticprotected
std::string makVrf::DtVrfGuiApplication::theLayoutSettingsFile
staticprotected
std::string makVrf::DtVrfGuiApplication::theLoadSimulationObjectGroup
staticprotected
std::string makVrf::DtVrfGuiApplication::theUseFileCommChannel
staticprotected
std::string makVrf::DtVrfGuiApplication::theGuiConfiguration
staticprotected
std::string makVrf::DtVrfGuiApplication::theShowPerspective
staticprotected
std::string makVrf::DtVrfGuiApplication::theDefaultSimulationModelSet
staticprotected
std::string makVrf::DtVrfGuiApplication::theUserScenarioDirectory
staticprotected
std::string makVrf::DtVrfGuiApplication::theUserTerrainDirectory
staticprotected
ObserverMode makVrf::DtVrfGuiApplication::theObserverMode
staticprotected
bool makVrf::DtVrfGuiApplication::theLoadGuiSavedState
staticprotected
bool makVrf::DtVrfGuiApplication::theIgnoreLayoutGeometryOnInitialLoad
staticprotected
bool makVrf::DtVrfGuiApplication::theQtDesignerPluginSupport
staticprotected
bool makVrf::DtVrfGuiApplication::theNoSpotDefinitionLoading
staticprotected
std::vector<std::string> makVrf::DtVrfGuiApplication::theSpotReportElementDefinitionHierFilesOrDirs
staticprotected
std::vector<std::string> makVrf::DtVrfGuiApplication::theSpotReportElementDefinitionLeafFilesOrDirs
staticprotected
DtVrfGuiPluginManager* makVrf::DtVrfGuiApplication::myVrfGuiPluginManager
protected
std::string makVrf::DtVrfGuiApplication::myPluginApplication
protected
std::string makVrf::DtVrfGuiApplication::myVrfSvnRevision
protected
std::string makVrf::DtVrfGuiApplication::myVrvSvnRevision
protected
bool makVrf::DtVrfGuiApplication::myLoadSystemPlugins
protected

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

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)