The Root IG Application object. More...

Inheritance diagram for makVrv::DtVrvApplication:

Public Member Functions
	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 void	initialize (int argc, char **argv)
	Create the GUI, initialize the DtDe.
virtual void	run ()
	Kick off the IG event loop.
virtual void	writeGuiConfiguration ()
	Writes the toolbars and panels layout in the UI so they can be restored next time the app is loaded.
virtual bool	updateCurrentGuiConfiguration ()
	Updates the current GUI configuration with the current UI layout status.

Static Public Member Functions
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 Types
typedef std::map< std::string, ApplicationTransform >	InitializerTransformMap

Protected Member Functions
virtual void	loadPluginModules ()
	Loads plugins if the config says to as well as creating the DtDe instance.
virtual void	assemble ()
	Use the assembler to build the user interface components.
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	loadSavedGuiState ()
	Load saved gui state from the default UI layout file.

Protected Attributes
DtVrvApplicationConfiguration	myConfiguration
DtDeInitializer	myInitializer
DtVrvCommandLineProcessor *	myCommandLineProcessor
DtDe *	myDe
DtPluginManager *	myPluginManager
DtEventLoop *	myEventLoop
InitializerTransformMap	myPrePluginTransforms
InitializerTransformMap	myPostPluginTransforms
InitializerTransformMap	myPostAssembleTransforms
typedef boost::function< void(DtVrvApplicationConfiguration &, int argc, char **argv)>	ConfigurationTransform
	Type for a function object that transforms an app config in some way.
typedef boost::function< void(DtDeInitializer &, DtDe &, DtVrvApplicationConfiguration &)>	ApplicationTransform
	Type for a function object that transforms an DtDeInitializer, DtDe or DtVrvApplicationConfiguration in some way.
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.

Detailed Description

The Root IG Application object.

  To run the IG simply create one, initialize it and call run. 
  @code

#include <vrvCore/DtVrvApplication.h>

using namespace makVrv;

int main(int argc,char** argv) { DtVrvApplication igApp; igApp.initialize(argc, argv); igApp.run(); }

Examples

Member Typedef Documentation

typedef boost::function<void (DtVrvApplicationConfiguration&, int argc, char** argv)> makVrv::DtVrvApplication::ConfigurationTransform

Type for a function object that transforms an app config in some way.

typedef boost::function<void (DtDeInitializer&, DtDe&, DtVrvApplicationConfiguration&)> makVrv::DtVrvApplication::ApplicationTransform

Type for a function object that transforms an DtDeInitializer, DtDe or DtVrvApplicationConfiguration in some way.

typedef std::map<std::string, ApplicationTransform> makVrv::DtVrvApplication::InitializerTransformMap

protected

Constructor & Destructor Documentation

makVrv::DtVrvApplication::DtVrvApplication ( )

Constructor.

Calls loadPluginsAndCreateIgInstance().

makVrv::DtVrvApplication::DtVrvApplication ( const DtVrvApplicationConfiguration & appConfig )

virtual makVrv::DtVrvApplication::~DtVrvApplication ( )

virtual

Destructor.

Member Function Documentation

static void makVrv::DtVrvApplication::ShowSplashScreen ( const std::string & imageName )

static

Show a brief splash screen.

This functionality relies on launching an external splash screen process.

static void makVrv::DtVrvApplication::ShowErrorMessage	(	const std::string &	message,
		DtException *	ex = `0`
	)

static

Show a brief splash screen.

This functionality relies on application specific ability to show an error message. This function may block if user input is required. If an exception is provided the error messages are displayed.

DtVrvApplicationConfiguration& makVrv::DtVrvApplication::configuration ( )

DtVrvApplicationConfiguration accessor.

DtPageConfiguration& makVrv::DtVrvApplication::masterModePageConfiguration ( )

Get the page configuration which may be altered by plugins.

DtPageConfiguration& makVrv::DtVrvApplication::slaveModePageConfiguration ( )

DtMenuConfiguration& makVrv::DtVrvApplication::masterModeMenuConfiguration ( )

Get the menu configuration which may be altered by plugins.

DtMenuConfiguration& makVrv::DtVrvApplication::slaveModeMenuConfiguration ( )

DtToolbarConfiguration& makVrv::DtVrvApplication::masterModeToolbarConfiguration ( )

Get the toolbar configuration which may be altered by plugins.

DtToolbarConfiguration& makVrv::DtVrvApplication::slaveModeToolbarConfiguration ( )

DtDe& makVrv::DtVrvApplication::de ( )

DtDe accessor.

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

virtual

Create the GUI, initialize the DtDe.

Call before calling run().

Sets the DtVrvConfiguration.
Assembles the user interface.
Calls DtDe::initialize().

Reimplemented in makVrf::DtVrfGuiApplication.

virtual void makVrv::DtVrvApplication::run ( )

virtual

Kick off the IG event loop.

This function will block until the application is done running. Once run has completed there is no further operations that the object can perform other than destruction.

Reimplemented in makVrf::DtVrfGuiApplication.

static DtVrvApplication* makVrv::DtVrvApplication::findFromDe ( DtDe & )

static

If an IG is created by an application you can find the IG application which created/owns it.

Returns: 0 if the de was not created by a DtDe.

static bool makVrv::DtVrvApplication::parseDisplayEngineParameter	(	const std::string &	argument,
		int &	port,
		std::string &	address,
		std::string &	displayConfig
	)

static

Parse a display engine command line argument.

Parameters

Output port will be set to -1 if no port is specified.

Returns: true or false if the argument was properly parsed.

static std::string makVrv::DtVrvApplication::displayEngineParameterFormatting ( )

static

Get the format of the display engine parameter.

virtual void makVrv::DtVrvApplication::installCommandLineProcessor ( DtVrvCommandLineProcessor * commandLineProcessor )

virtual

Add a configuration transformer that runs at command line processor level priority.

virtual void makVrv::DtVrvApplication::installPrePluginTransform	(	const ApplicationTransform &	transform,
		const std::string &	id
	)

virtual

Add a transformer that runs before plug-ins are loaded.

virtual void makVrv::DtVrvApplication::installPostPluginTransform	(	const ApplicationTransform &	transform,
		const std::string &	id
	)

virtual

Add a transformer that runs after plug-ins are loaded.

virtual void makVrv::DtVrvApplication::installPostAssembleTransform	(	const ApplicationTransform &	transform,
		const std::string &	id
	)

virtual

Add a transformer that runs after the application is assembled and before the DtDe is initialized.

static void makVrv::DtVrvApplication::handleFileError	(	const std::string &	filename,
		const std::string	fileType
	)

static

Handle when a file specified on the command line can't be read.

static void makVrv::DtVrvApplication::bindViews	(	const std::vector< std::string > &	filenames,
		makVrv::DtDeInitializer::ObserverStateMap &	aMap
	)

static

Places all views into the supplied observer view map and binds to the supplied observer view.

static bool makVrv::DtVrvApplication::loadObserverStateRecords	(	const std::string &	file,
		makArchives::DtObserverStateRecordsList &	list
	)

static

Loads up observer state records from filename into specified list.

static void makVrv::DtVrvApplication::loadViews	(	const std::vector< std::string > &	filenames,
		makVrv::DtDeInitializer::ObserverStateMap &	aMap
	)

static

Places all views into the supplied observer view map.

virtual void makVrv::DtVrvApplication::writeGuiConfiguration ( )

virtual

Writes the toolbars and panels layout in the UI so they can be restored next time the app is loaded.

virtual bool makVrv::DtVrvApplication::updateCurrentGuiConfiguration ( )

virtual

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

virtual void makVrv::DtVrvApplication::loadPluginModules ( )

protectedvirtual

Loads plugins if the config says to as well as creating the DtDe instance.

Called by the constructors.

Reimplemented in makVrf::DtVrfGuiApplication.

virtual void makVrv::DtVrvApplication::assemble ( )

protectedvirtual

Use the assembler to build the user interface components.

Reimplemented in makVrf::DtVrfGuiApplication.

virtual void makVrv::DtVrvApplication::createDefaultDisplayEngineConfiguration ( )

protectedvirtual

Create default engine configurations if none exist.

virtual DtDisplayConfiguration makVrv::DtVrvApplication::embeddedMasterDisplayConfig ( )

protectedvirtual

Helper method that returns an embedded display config.

virtual void makVrv::DtVrvApplication::createDefaultObserverConfiguration ( )

protectedvirtual

Create default observer configurations if none exist.

virtual void makVrv::DtVrvApplication::loadSavedGuiState ( )

protectedvirtual

Load saved gui state from the default UI layout file.

Member Data Documentation

DtVrvApplicationConfiguration makVrv::DtVrvApplication::myConfiguration

protected

DtDeInitializer makVrv::DtVrvApplication::myInitializer

protected

DtVrvCommandLineProcessor* makVrv::DtVrvApplication::myCommandLineProcessor

protected

DtDe* makVrv::DtVrvApplication::myDe

protected

DtPluginManager* makVrv::DtVrvApplication::myPluginManager

protected

DtEventLoop* makVrv::DtVrvApplication::myEventLoop

protected

InitializerTransformMap makVrv::DtVrvApplication::myPrePluginTransforms

protected

InitializerTransformMap makVrv::DtVrvApplication::myPostPluginTransforms

protected

InitializerTransformMap makVrv::DtVrvApplication::myPostAssembleTransforms

protected

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

include/vrvCore/DtVrvApplication.h

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation