OutputInterface Class Reference

#include <OutputInterface.h>

Collaboration diagram for OutputInterface:

[legend]

List of all members.

Classes
class	ConverterToV1_0a4
struct	ModulesConfigData
Static Public Member Functions
static bool	init (std::string outputInterfaceConfigFile)
static bool	configure (std::string outputInterfaceConfigFile)
static void	cleanup ()
static bool	registerModuleInterface (ModuleInterface *modIntf)
static bool	unregisterModuleInterface (ModuleInterface *modIntf)
static void	registerModuleInitCallback (outputInterfaceCallback function)
static ModuleInterface *	getModuleByName (std::string name, std::string fileName="")
static bool	isModuleLoaded (std::string name)
static SceneGraphInterface *	getSceneGraphInterface ()
Static Private Member Functions
static bool	parseOutputInterfaceConfig (std::string path, std::vector< ModulesConfigData > &modulesConfigurations)
static bool	initializeModules (std::vector< ModulesConfigData > &modulesConfigurations)
static bool	configureModules (std::vector< ModulesConfigData > &modulesConfigurations)
Static Private Attributes
static bool	isInitialized = false
static bool	isConfigured = false
static std::vector < ModulesConfigData >	modulesConfigurations
static std::map< std::string, ModuleInterface * >	moduleMap
static std::vector < outputInterfaceCallback >	moduleInitCallbacks
static SceneGraphInterface *	sceneGraphInterface = NULL
static XmlConfigurationLoader	xmlConfigLoader

---

Member Function Documentation

void OutputInterface::cleanup

(

)

[static]

: write doxygen documentation

bool OutputInterface::configure

(

std::string

outputInterfaceConfigFile

)

[static]

: write doxygen documentation

bool OutputInterface::configureModules

(

std::vector< ModulesConfigData > &

modulesConfigurations

)

[static, private]

: write doxygen documentation

ModuleInterface * OutputInterface::getModuleByName	(	std::string	name,
		std::string	fileName = ""
	)			[static]

: write doxygen documentation

SceneGraphInterface * OutputInterface::getSceneGraphInterface

(

)

[static]

bool OutputInterface::init

(

std::string

outputInterfaceConfigFile

)

[static]

: write doxygen documentation

bool OutputInterface::initializeModules

(

std::vector< ModulesConfigData > &

modulesConfigurations

)

[static, private]

: write doxygen documentation : write doxygen documentation

bool OutputInterface::isModuleLoaded

(

std::string

name

)

[static]

: write doxygen documentation

bool OutputInterface::parseOutputInterfaceConfig	(	std::string	path,
		std::vector< ModulesConfigData > &	modulesConfigurations
	)			[static, private]

: write doxygen documentation

void OutputInterface::registerModuleInitCallback

(

outputInterfaceCallback

function

)

[static]

Register a function to be called on initialisation of a module. The callback function will be called after a new module has been loaded (i.e. it has been registered with the OutputInterface), but before the module's loadConfig method has been called. The callback function has to take one argument of type ModuleInterface *, and have a return type of void. All registered callbacks are called on each new module.

Parameters:

function

the callback function.

bool OutputInterface::registerModuleInterface

(

ModuleInterface *

modIntf

)

[static]

Registers a ModuleInterface. All registered modules will be configured through loadConfigs(). Typically a module calls this method in their constructor.

Parameters:

modIntf

module which will be registered

bool OutputInterface::unregisterModuleInterface

(

ModuleInterface *

modIntf

)

[static]

Unregisters a ModuleInterface. Typically a module calls this method in their destructor.

Parameters:

modIntf

module which will be registered

---

Member Data Documentation

bool OutputInterface::isConfigured = false [static, private]

bool OutputInterface::isInitialized = false [static, private]

std::vector< outputInterfaceCallback > OutputInterface::moduleInitCallbacks [static, private]

std::map< std::string, ModuleInterface * > OutputInterface::moduleMap [static, private]

std::vector< OutputInterface::ModulesConfigData > OutputInterface::modulesConfigurations [static, private]

SceneGraphInterface * OutputInterface::sceneGraphInterface = NULL [static, private]

XmlConfigurationLoader OutputInterface::xmlConfigLoader [static, private]

---

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

• src/inVRs/OutputInterface/OutputInterface.h
• src/inVRs/OutputInterface/OutputInterface.cpp