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

Inheritance diagram for DtParameterAlteringApplication:

[legend]

Public Member Functions
	DtParameterAlteringApplication (makVrv::DtVrvApplicationConfiguration &config)
	Constructor.
virtual	~DtParameterAlteringApplication ()
	Destructor.
virtual void	initialize (int argc, char **argv)
	Initializes the application with the given command line options and replaces main window.
virtual std::string	startupValue (const std::string &) const
	Returns a value that is set at startup to use in the application.
virtual void	setStartupValue (const std::string &key, const std::string &value)
	Sets a startup value, replacing any that exists.
virtual void	run ()
	Runs the application. Signals deInitialized if application has started successfully.
virtual void	setMainWindowCreatorFunction (makVrv::DtDeMainWindowProvider *)
	MUST be called to create a new main window of the appropriate type.

virtual void	addParameterType (const char controllerName, const char likeUi, DtSimObjectParametersCreatorFcn fcn=NULL)
	Use to add a new controller, sensor or actuator to the possible items that can be added to an .ope file.
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)
	Add a creator for user extension SR.
Public Member Functions inherited from makVrf::DtVrfGuiApplication
	DtVrfGuiApplication (makVrv::DtVrvApplicationConfiguration &config)
	Constructor to the VRFGUI application.
virtual	~DtVrfGuiApplication ()
	Destructor to the VRFGUI application.
virtual DtString	layoutSettingsFileClassName () const
	Returns the class name from the layout settings file.
void	setPluginApplication (const std::string &)
	Sets the plugin application name.
const std::string &	pluginApplication () const
	Gets the plugin application name.
virtual void	setLoadSystemPlugins (bool)
	If set to false does not load any plugins from the plugins directory. Default is true.
virtual bool	loadSystemPlugins () const
virtual makVrv::DtUnicode	applicationName () const
	Returns the application name as defined in the configuration.
virtual void	writeGuiConfiguration ()
	Override to send out pre/post write gui configuration signals.
virtual void	loadSavedGuiState ()
	Override to not load if not loading gui saved state.
virtual bool	getShowStartupScreen () const
	Return false to now show Vantage version of the startup screen.
virtual bool	usingAbsoluteTimeStamps () const
	Returns true if driver is using absolute time stamping.
virtual bool	usingAsynchIO () const
	Returns true if driver is using asynchronous io.
virtual DtSimulationAddress	frontEndSimulationAddress () const
	The front end simulation address of this front-end.
virtual bool	vrlDriverHasBooleanValue (const std::string &) const
virtual int	vrlDriverHasIntegerValue (const std::string &) const
virtual std::string	vrlDriverHasStringValue (const std::string &) 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)
Public Member Functions inherited from makVrv::DtVrvApplication
	DtVrvApplication ()
	Constructor.
	DtVrvApplication (const DtVrvApplicationConfiguration &appConfig)
virtual	~DtVrvApplication ()
	Destructor.
DtVrvApplicationConfiguration &	configuration ()
	DtVrvApplicationConfiguration accessor.
DtPageConfiguration &	masterModePageConfiguration ()
	Get the page configuration which may be altered by plugins.
DtPageConfiguration &	slaveModePageConfiguration ()
DtMenuConfiguration &	masterModeMenuConfiguration ()
	Get the menu configuration which may be altered by plugins.
DtMenuConfiguration &	slaveModeMenuConfiguration ()
DtToolbarConfiguration &	masterModeToolbarConfiguration ()
	Get the toolbar configuration which may be altered by plugins.
DtToolbarConfiguration &	slaveModeToolbarConfiguration ()
DtDe &	de ()
	DtDe accessor.
virtual DtPluginManager &	pluginManager ()
	Provide access to the plugin manager.
virtual void	slot_sceneTerrainLoaded (std::string terrain)
	slots for the DtScene signals so the scenes/terrains can get added to the recent terrains list
virtual void	slot_sceneTerrainSaved (std::string terrain)
virtual void	slot_sceneToBeLoaded (std::string terrain)
virtual void	slot_sceneLoaded (std::string terrain)
virtual void	slot_sceneSaved (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.
virtual void	installPrePluginTransform (const ApplicationTransform &transform, const std::string &id)
	Add a transformer that runs before plug-ins are loaded.
virtual void	installPostPluginTransform (const ApplicationTransform &transform, const std::string &id)
	Add a transformer that runs after plug-ins are loaded.
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.

Static Public Member Functions
static DtParameterAlteringApplication *	app (makVrv::DtDe &)
	Returns a pointer to this object given the de.
Static Public Member Functions inherited from makVrf::DtVrfGuiApplication
static void	setIgnoreLayoutGeometryOnInitialLoad (bool)
	Sets whether or not to use VLD memory tracking. Only enabled is USE_VLD_MEMORY_TRACKING is enabled.
static bool	ignoreLayoutGeometryOnInitialLoad ()
static void	setShowPerspective (const std::string &)
	Sets the initial perspective to show for ground truth.
static void	setGuiConfiguration (const std::string &)
	Sets the gui configuration file to use.
static void	setObserverModeBindings (const ObserverModeBindings &modes)
	Sets the observer mode bindings to a different set of bindings.
static const ObserverModeBindings &	observerModeBindings ()
	Gets the current observer mode bindings that are set.
static const std::vector < std::string > &	additionalPluginsToLoad ()
	Gets a list of additional plugins to be loaded or were loaded by loadPluginModules()
static void	setAdditionalPluginsToLoad (const std::vector< std::string > &)
	Sets the list of additional plugins to be loaded by loadPluginModules()
static bool	loadDefaultPlugins ()
	Gets whether the default plugins should be loaded or not.
static void	setLoadDefaultPlugins (bool)
	Sets whether the default plugins were loaded or not.
static bool	checkPluginVersions ()
	Gets whether to check the plugin versions or not.
static void	setCheckPluginVersions (bool)
	Sets whether to check the plugin versions or not.
static const std::string &	transport ()
	Gets the transport string.
static void	setTransport (const std::string &)
	Sets the transport string.
static const std::string &	loadScenario ()
	Gets the currently loaded scenario name.
static void	setLoadScenario (const std::string &)
	Sets the currently loaded scenario name.
static const std::string &	useFileCommChannel ()
	If empty use this file comm channel as a listener in the scenario manager class.
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)
static std::string	layoutSettingsFile ()
static const std::string &	loadSimulationObjectGroup ()
	Gets the currently loaded simulation object group name.
static void	setLoadSimulationObjectGroup (const std::string &)
	Sets the currently loaded simulation object group name.
static void	setDefaultSimulationModelSet (const std::string &)
	Sets the default simulation model set to use. Will override any setting within the session settings file.
static const std::string &	defaultSimulationModelSet ()
static ObserverMode	observerMode ()
	Gets the current observer mode.
static void	setObserverMode (ObserverMode)
	Sets the current observer mode.
static void	setShouldLoadGuiSavedState (bool)
	Set to false to not load gui saved state.
static bool	shouldLoadGuiSavedState ()
Static Public Member Functions inherited from makVrv::DtVrvApplication
static DtVrvApplication *	get_last_instance ()
	Returns the last DtVrvApplication created, regardless of DtDe.
static void	ShowSplashScreen (const std::string &imageName)
	Show a brief splash screen.
static void	ShowErrorMessage (const std::string &message, DtException *ex=0)
	Show a brief splash screen.
static DtVrvApplication *	findFromDe (DtDe &)
	If an IG is created by an application you can find the IG application which created/owns it.
static bool	parseDisplayEngineParameter (const std::string &argument, int &port, std::string &address, std::string &displayConfig)
	Parse a display engine command line argument.
static std::string	displayEngineParameterFormatting ()
	Get the format of the display engine parameter.
static void	handleFileError (const std::string &filename, const std::string fileType)
	Handle when a file specified on the command line can't be read.
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.
static bool	loadObserverStateRecords (const std::string &file, makArchives::DtObserverStateRecordsList &list)
	Loads up observer state records from filename into specified list.
static void	loadViews (const std::vector< std::string > &filenames, makVrv::DtDeInitializer::ObserverStateMap &aMap)
	Places all views into the supplied observer view map.

Protected Member Functions
virtual void	setupMenu ()=0
	Sets up a menu.
virtual void	loadTranslationFiles (const std::string &)
virtual void	assemble ()
	Assembles the application and signals the pre and post of the assembly process.
virtual void	dePostInitialize ()
	Called during the post initialize process of the de, initialize some things before drivers get initialized.
virtual void	loadPluginModulesExt ()
	Calls setupMenu()
virtual bool	updateCurrentGuiConfiguration ()
	Do not save out any changes to UI layout to prevent VRF-Gui application from modifying.
Protected Member Functions inherited from makVrf::DtVrfGuiApplication
virtual void	loadPluginModules ()
	Override to set up additional plugins to load.
virtual void	bindObserverModes (const ObserverModeBindings &modes)
	Given the list, binds the observers (if they exist) to the visual mode.
virtual DtVrfGuiPluginManager *	createPluginManager ()
	Creates and returns the plugin manager for VRF plugins.
virtual void	setupForObserverMode ()
	Called to set up Gui configuration and settings based on current observer mode selection.
virtual void	setupForPvdMode ()
	Sets up GUI for PVD mode only. Experimental as of 4.0.
virtual void	setupForStealthMode ()
	Sets up for Stealth only. Experimental as of 4.0.
Protected Member Functions inherited from makVrv::DtVrvApplication
virtual void	createDefaultDisplayEngineConfiguration ()
	Create default engine configurations if none exist.
virtual DtDisplayConfiguration	embeddedMasterDisplayConfig ()
	Helper method that returns an embedded display config.
virtual void	createDefaultObserverConfiguration ()
	Create default observer configurations if none exist.
virtual void	addRecentTerrain (std::string terrain)
	add a terrain/scene to the list of recent terrains.

Protected Attributes
std::map< std::string, std::string >	myStartupValues
std::map< DtString, DtVector >	myVisualPlacements
bool	myUpdateGuiConfiguration
Protected Attributes inherited from makVrf::DtVrfGuiApplication
DtVrfGuiPluginManager *	myVrfGuiPluginManager
std::string	myPluginApplication
std::string	myVrfSvnRevision
std::string	myVrvSvnRevision
bool	myLoadSystemPlugins
Protected Attributes inherited from makVrv::DtVrvApplication
DtVrvApplicationConfiguration	myConfiguration
DtDeInitializer	myInitializer
DtVrvCommandLineProcessor *	myCommandLineProcessor
DtDe *	myDe
DtPluginManager *	myPluginManager
DtEventLoop *	myEventLoop
InitializerTransformMap	myPrePluginTransforms
InitializerTransformMap	myPostPluginTransforms
InitializerTransformMap	myPostAssembleTransforms
DtSignalConnectionManager *	myConnections
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 Attributes inherited from makVrf::DtVrfGuiApplication
boost::signal< void(makVrv::DtDe &, makVrv::DtMenuConfiguration &)>	signal_preAssemble
boost::signal< void(makVrv::DtDe &, makVrv::DtMenuConfiguration &)>	signal_postAssemble
boost::signal< void(makVrv::DtDe &)>	signal_deInitialized
boost::signal< void()>	signal_preLoadPlugins
boost::signal< void()>	signal_postLoadPlugins
boost::signal< void()>	signal_preWriteGuiConfiguration
boost::signal< void()>	signal_postWriteGuiConfiguration
boost::signal< void(std::string)>	signal_terrainSaved
boost::signal< void()>	signal_defaultLayoutLoaded
Static Public Attributes inherited from makVrv::DtVrvApplication
static const int	MAX_RECENT_TERRAIN_COUNT = 20
Protected Types inherited from makVrv::DtVrvApplication
typedef std::map< std::string, ApplicationTransform >	InitializerTransformMap
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 ObserverMode	theObserverMode
static bool	theLoadGuiSavedState
static bool	theIgnoreLayoutGeometryOnInitialLoad

Detailed Description

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

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

argc	command line args
argv	command line args

Reimplemented from makVrf::DtVrfGuiApplication.

Reimplemented in DtSimulationObjectEditorApplication, and DtVrfOpdEditorApplication.

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.

Reimplemented from makVrf::DtVrfGuiApplication.

Reimplemented in DtSimulationObjectEditorApplication, and DtVrfOpdEditorApplication.

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

Use to add a new controller, sensor or actuator to the possible items that can be added to an .ope file.

Routines that are used by plugins to register additional information. Reference this class by: DtParameterAlteringApplication::app(myDe) If the creator parameter is not NULL, then the creator will also be associated with the appropriate factory given the descriptor name

Reimplemented in DtVrfOpdEditorApplication.

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

virtual

Reimplemented in DtVrfOpdEditorApplication.

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

virtual

Reimplemented in DtVrfOpdEditorApplication.

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