VR-Forces 5.0.1 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtParameterAlteringApplication Class Referenceabstract

Fairly specific application used by entity editor and opd editor as a common class for modifying parameter databases.

Related Examples
Inheritance diagram for DtParameterAlteringApplication:
Inheritance graph
[legend]

Public Member Functions

 DtParameterAlteringApplication (makVrv::DtVrvApplicationConfiguration &config)
 
virtual ~DtParameterAlteringApplication ()
 
virtual void initialize (int argc, char **argv)
 
virtual std::string startupValue (const std::string &) const
 
virtual void setStartupValue (const std::string &key, const std::string &value)
 
virtual void run ()
 
virtual void setMainWindowCreatorFunction (makVrv::DtDeMainWindowProvider *)
 
virtual void addParameterType (const char *controllerName, const char *likeUi, DtSimObjectParametersCreatorFcn fcn=NULL)
 
virtual void addController (const char *controllerName, const char *descriptorName, DtComponentDescriptorCreatorFcn fcn=NULL)
 
virtual void addSensor (const char *sensorName, const char *descriptorName, DtComponentDescriptorCreatorFcn fcn=NULL)
 
virtual void addActuator (const char *actuatorName, const char *descriptorName, DtComponentDescriptorCreatorFcn fcn=NULL)
 
virtual void addUserExtentsion (const DtString &type, DtVrfSRUserExtensionCreatorFcn fcn)
 
virtual DtReaderWriterClassDocDBparameterDocDB () const
 
- Public Member Functions inherited from makVrf::DtVrfGuiApplication
 DtVrfGuiApplication (makVrv::DtVrvApplicationConfiguration &config)
 
virtual ~DtVrfGuiApplication ()
 
virtual DtString layoutSettingsFileClassName () const
 
virtual std::string userScenarioDirectory ()
 
void setPluginApplication (const std::string &)
 
const std::string & pluginApplication () const
 
virtual void setLoadSystemPlugins (bool)
 
virtual bool loadSystemPlugins () const
 
virtual makVrv::DtUnicode applicationName () const
 
virtual void writeGuiConfiguration ()
 
virtual void loadSavedGuiState ()
 
virtual bool getShowStartupScreen () const
 
virtual bool usingAbsoluteTimeStamps () const
 
virtual std::string restoreDefaultLayout (const DtString &layoutTemplate="Scenario_Creation")
 
virtual bool usingAsynchIO () const
 
virtual makVrv::DtVrlinkDrivergetVrlinkDriver () const
 
virtual DtSimulationAddress frontEndSimulationAddress () const
 
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)
 
virtual std::string language () const
 
virtual void checkOrCreateModelDefinition (const std::string &definition, const std::string &filePath)
 
- Public Member Functions inherited from makVrv::DtVrvApplication
 DtVrvApplication ()
 
 DtVrvApplication (const DtVrvApplicationConfiguration &appConfig)
 
virtual ~DtVrvApplication ()
 
DtVrvApplicationConfigurationconfiguration ()
 
DtPageConfigurationmasterModePageConfiguration ()
 
DtPageConfigurationslaveModePageConfiguration ()
 
DtMenuConfigurationmasterModeMenuConfiguration ()
 
DtMenuConfigurationslaveModeMenuConfiguration ()
 
DtToolbarConfigurationmasterModeToolbarConfiguration ()
 
DtToolbarConfigurationslaveModeToolbarConfiguration ()
 
DtDede ()
 
virtual DtPluginManagerpluginManager ()
 
virtual void slot_sceneTerrainLoaded (const DtUnicode &terrain)
 
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)
 
virtual void installPrePluginTransform (const ApplicationTransform &transform, const std::string &id)
 
virtual void installPostPluginTransform (const ApplicationTransform &transform, const std::string &id)
 
virtual void installPostAssembleTransform (const ApplicationTransform &transform, const std::string &id)
 

Static Public Member Functions

static
DtParameterAlteringApplication
app (makVrv::DtDe &)
 
- Static Public Member Functions inherited from makVrf::DtVrfGuiApplication
static bool applicationIsTerminating (makVrv::DtDe &)
 
static DtVrfGuiApplicationapp (makVrv::DtDe &)
 
static makVrv::DtDetheDe ()
 
static void SetQtDesignerMode (bool)
 
static bool QtDesignerMode ()
 
static void setNoSpotReportDefinitionLoading (bool val)
 
static bool noSpotReportDefinitionLoading ()
 
static void setSpotReportElementDefinitionHierFilesOrDirs (const std::vector< std::string > &filesOrDirs)
 
static const std::vector
< std::string > & 
spotReportElementDefinitionHierFilesOrDirs ()
 
static void setSpotReportElementDefinitionLeafFilesOrDirs (const std::vector< std::string > &filesOrDirs)
 
static const std::vector
< std::string > & 
spotReportElementDefinitionLeafFilesOrDirs ()
 
static void setIgnoreLayoutGeometryOnInitialLoad (bool)
 
static bool ignoreLayoutGeometryOnInitialLoad ()
 
static void setShowPerspective (const std::string &)
 
static void setQtDesignerPluginSupport (bool)
 
static bool qtDesignerPluginSupport ()
 
static void setGuiConfiguration (const std::string &)
 
static void setObserverModeBindings (const ObserverModeBindings &modes)
 
static const ObserverModeBindingsobserverModeBindings ()
 
static const std::vector
< std::string > & 
additionalPluginsToLoad ()
 
static void setAdditionalPluginsToLoad (const std::vector< std::string > &)
 
static bool loadDefaultPlugins ()
 
static void setLoadDefaultPlugins (bool)
 
static bool checkPluginVersions ()
 
static void setCheckPluginVersions (bool)
 
static const std::string & transport ()
 
static void setTransport (const std::string &)
 
static const std::string & loadScenario ()
 
static void setLoadScenario (const std::string &)
 
static const std::string & useFileCommChannel ()
 
static void setUseFileCommChannel (const std::string &)
 
static void setLayoutSettingsFile (const std::string &)
 
static std::string layoutSettingsFile ()
 
static const std::string & loadSimulationObjectGroup ()
 
static void setLoadSimulationObjectGroup (const std::string &)
 
static void setDefaultSimulationModelSet (const std::string &)
 
static const std::string & defaultSimulationModelSet ()
 
static ObserverMode observerMode ()
 
static void setObserverMode (ObserverMode)
 
static void setUserScenarioDirectory (const std::string &)
 
static void setShouldLoadGuiSavedState (bool)
 
static bool shouldLoadGuiSavedState ()
 
- Static Public Member Functions inherited from makVrv::DtVrvApplication
static DtVrvApplicationget_last_instance ()
 
static void ShowSplashScreen (const std::string &imageName)
 
static void ShowErrorMessage (const std::string &message, DtException *ex=0)
 
static DtVrvApplicationfindFromDe (DtDe &)
 
static bool parseDisplayEngineParameter (const std::string &argument, int &port, std::string &address, std::string &displayConfig)
 
static std::string displayEngineParameterFormatting ()
 
static void setShowErrorMessageDialog (bool show)
 
static bool showErrorMessageDialog ()
 
static void handleFileError (const std::string &filename, const std::string &fileType)
 
static void bindViews (const std::vector< std::string > &filenames, makVrv::DtDeInitializer::ObserverStateMap &aMap)
 
static bool loadObserverStateRecords (const std::string &file, makArchives::DtObserverStateRecordsList &list)
 
static void loadViews (const std::vector< std::string > &filenames, makVrv::DtDeInitializer::ObserverStateMap &aMap)
 

Protected Member Functions

virtual void setupMenu ()=0
 
virtual void loadTranslationFiles (const std::string &)
 
virtual void assemble ()
 
virtual void dePostInitialize ()
 
virtual void loadPluginModulesExt ()
 
virtual bool updateCurrentGuiConfiguration ()
 
virtual bool loadParameterDocDB (DtReaderWriterClassDocDB &parameterDocDB)
 
virtual DtReaderWriterClassDocDBcreateParameterDocDB () const
 
- Protected Member Functions inherited from makVrf::DtVrfGuiApplication
virtual void loadPluginModules ()
 
virtual void initializePluginManager ()
 
virtual void initializePluginsForCommandLineArguments (int argc, char **argv)
 
virtual void bindObserverModes (const ObserverModeBindings &modes)
 
virtual DtVrfGuiPluginManagercreatePluginManager ()
 
virtual void setupForObserverMode ()
 
virtual void setupForPvdMode ()
 
virtual void setupForStealthMode ()
 
virtual void initializeWithVRFSymbolDecorations (const std::string &)
 
- Protected Member Functions inherited from makVrv::DtVrvApplication
virtual void createDefaultDisplayEngineConfiguration ()
 
virtual DtDisplayConfiguration embeddedMasterDisplayConfig ()
 
virtual void createDefaultObserverConfiguration ()
 
virtual void addRecentTerrain (const std::string &terrain)
 

Protected Attributes

std::map< std::string,
std::string > 
myStartupValues
 
std::map< DtString, DtVectormyVisualPlacements
 
bool myUpdateGuiConfiguration
 
DtReaderWriterClassDocDBmyParameterDocDB
 
- Protected Attributes inherited from makVrf::DtVrfGuiApplication
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
 

Additional Inherited Members

- Public Types inherited from makVrf::DtVrfGuiApplication
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
 
typedef boost::function< void(DtDeInitializer
&, DtDe
&, DtVrvApplicationConfiguration &)> 
ApplicationTransform
 
- Public Attributes inherited from makVrf::DtVrfGuiApplication
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_dataDoesNotExist
 
boost::signals2::signal< void()> signal_qtExtensionsPreInitialize
 
boost::signals2::signal< void()> signal_qtExtensionsPostInitialize
 
- 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
 
- Static Protected Attributes inherited from makVrf::DtVrfGuiApplication
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 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 bool theQtDesignerMode
 
- Static Protected Attributes inherited from makVrv::DtVrvApplication
static DtVrvApplicationsLastAppInstance
 
static bool theShowErrorMessageDialog
 

Constructor & Destructor Documentation

DtParameterAlteringApplication::DtParameterAlteringApplication ( makVrv::DtVrvApplicationConfiguration config)

Constructor.

virtual DtParameterAlteringApplication::~DtParameterAlteringApplication ( )
virtual

Destructor.

Member Function Documentation

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

Initializes the application with the given command line options and replaces main window.

Parameters
argccommand line args
argvcommand line args

Reimplemented from makVrf::DtVrfGuiApplication.

Reimplemented in DtSimulationObjectEditorApplication.

virtual std::string DtParameterAlteringApplication::startupValue ( const std::string &  ) const
virtual

Returns a value that is set at startup to use in the application. Valid values are: uiFile - ui file to use. Default is ../appData/settings/entityEditor/entityEditorUi.mtl.

virtual void DtParameterAlteringApplication::setStartupValue ( const std::string &  key,
const std::string &  value 
)
virtual

Sets a startup value, replacing any that exists.

static DtParameterAlteringApplication* DtParameterAlteringApplication::app ( makVrv::DtDe )
static

Returns a pointer to this object given the de.

virtual void DtParameterAlteringApplication::run ( )
virtual

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

Reimplemented from makVrf::DtVrfGuiApplication.

virtual void DtParameterAlteringApplication::setMainWindowCreatorFunction ( makVrv::DtDeMainWindowProvider )
virtual

MUST be called to create a new main window of the appropriate type.

virtual void DtParameterAlteringApplication::addParameterType ( const char controllerName,
const char likeUi,
DtSimObjectParametersCreatorFcn  fcn = NULL 
)
virtual

Routines that are used by plugins to register additional information. Reference this class by: DtParameterAlteringApplication::app(myDe)

Use to add a new controller, sensor or actuator to the possible items that can be added to an .ope file. If the creator parameter is not NULL, then the creator will also be associated with the appropriate factory given the descriptor name

virtual void DtParameterAlteringApplication::addController ( const char controllerName,
const char descriptorName,
DtComponentDescriptorCreatorFcn  fcn = NULL 
)
virtual

Routines that are used by plugins to register additional information. Reference this class by: DtParameterAlteringApplication::app(myDe)

Use to add a new controller, sensor or actuator to the possible items that can be added to an .ope file. If the creator parameter is not NULL, then the creator will also be associated with the appropriate factory given the descriptor name

virtual void DtParameterAlteringApplication::addSensor ( const char sensorName,
const char descriptorName,
DtComponentDescriptorCreatorFcn  fcn = NULL 
)
virtual

Routines that are used by plugins to register additional information. Reference this class by: DtParameterAlteringApplication::app(myDe)

Use to add a new controller, sensor or actuator to the possible items that can be added to an .ope file. If the creator parameter is not NULL, then the creator will also be associated with the appropriate factory given the descriptor name

virtual void DtParameterAlteringApplication::addActuator ( const char actuatorName,
const char descriptorName,
DtComponentDescriptorCreatorFcn  fcn = NULL 
)
virtual

Routines that are used by plugins to register additional information. Reference this class by: DtParameterAlteringApplication::app(myDe)

Use to add a new controller, sensor or actuator to the possible items that can be added to an .ope file. If the creator parameter is not NULL, then the creator will also be associated with the appropriate factory given the descriptor name

virtual void DtParameterAlteringApplication::addUserExtentsion ( const DtString type,
DtVrfSRUserExtensionCreatorFcn  fcn 
)
virtual

Add a creator for user extension SR.

virtual DtReaderWriterClassDocDB* DtParameterAlteringApplication::parameterDocDB ( ) const
virtual

Routines that are used by plugins to register additional information. Reference this class by: DtParameterAlteringApplication::app(myDe)

Use to add a new controller, sensor or actuator to the possible items that can be added to an .ope file. If the creator parameter is not NULL, then the creator will also be associated with the appropriate factory given the descriptor name

virtual void DtParameterAlteringApplication::setupMenu ( )
protectedpure virtual

Sets up a menu.

Implemented in DtSimulationObjectEditorApplication.

virtual void DtParameterAlteringApplication::loadTranslationFiles ( const std::string &  )
protectedvirtual
virtual void DtParameterAlteringApplication::assemble ( )
protectedvirtual

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

Reimplemented from makVrf::DtVrfGuiApplication.

Reimplemented in DtSimulationObjectEditorApplication.

virtual void DtParameterAlteringApplication::dePostInitialize ( )
protectedvirtual

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

Reimplemented from makVrf::DtVrfGuiApplication.

virtual void DtParameterAlteringApplication::loadPluginModulesExt ( )
protectedvirtual

Calls setupMenu()

Reimplemented from makVrf::DtVrfGuiApplication.

virtual bool DtParameterAlteringApplication::updateCurrentGuiConfiguration ( )
protectedvirtual

Do not save out any changes to UI layout to prevent VRF-Gui application from modifying.

Reimplemented from makVrf::DtVrfGuiApplication.

virtual bool DtParameterAlteringApplication::loadParameterDocDB ( DtReaderWriterClassDocDB parameterDocDB)
protectedvirtual

Loads in the contents of the parameter documentation database (used to provide context-sensitive help). Returns true if at least one parameter documentation file is loaded, false otherwise. Called from init.

virtual DtReaderWriterClassDocDB* DtParameterAlteringApplication::createParameterDocDB ( ) const
protectedvirtual

Returns new instance of a DtReaderWriterClassDocDB. Called from init.

Member Data Documentation

std::map<std::string, std::string> DtParameterAlteringApplication::myStartupValues
protected
std::map<DtString, DtVector> DtParameterAlteringApplication::myVisualPlacements
protected
bool DtParameterAlteringApplication::myUpdateGuiConfiguration
protected
DtReaderWriterClassDocDB* DtParameterAlteringApplication::myParameterDocDB
protected

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

Document ID: Generated on Mon Jun 20 00:38:30 EDT 2022 from SVN revision 244029
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)