InputInterface Class Reference

#include <InputInterface.h>

Collaboration diagram for InputInterface:

[legend]

List of all members.

Classes
class	ConverterToV1_0a4
struct	ModulesConfigData
Static Public Member Functions
static bool	init (std::string inputInterfaceConfigFile)
static bool	configure (std::string inputInterfaceConfigFile)
static void	cleanup ()
static bool	registerModuleInterface (ModuleInterface *modIntf)
static bool	unregisterModuleInterface (ModuleInterface *modIntf)
static void	registerModuleInitCallback (inputInterfaceCallback function)
static ModuleInterface *	getModuleByName (std::string name, std::string fileName="")
static bool	isModuleLoaded (std::string name)
static ControllerManagerInterface *	getControllerManager ()
Static Private Member Functions
static bool	parseInputInterfaceConfig (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 < inputInterfaceCallback >	moduleInitCallbacks
static ControllerManagerInterface *	controllerManager = NULL
static XmlConfigurationLoader	xmlConfigLoader

---

Member Function Documentation

void InputInterface::cleanup

(

)

[static]

: write doxygen documentation

bool InputInterface::configure

(

std::string

inputInterfaceConfigFile

)

[static]

: write doxygen documentation

bool InputInterface::configureModules

(

std::vector< ModulesConfigData > &

modulesConfigurations

)

[static, private]

: write doxygen documentation

ControllerManagerInterface * InputInterface::getControllerManager

(

)

[static]

: write doxygen documentation

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

: write doxygen documentation

bool InputInterface::init

(

std::string

inputInterfaceConfigFile

)

[static]

: write doxygen documentation

bool InputInterface::initializeModules

(

std::vector< ModulesConfigData > &

modulesConfigurations

)

[static, private]

: write doxygen documentation

bool InputInterface::isModuleLoaded

(

std::string

name

)

[static]

: write doxygen documentation

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

: write doxygen documentation

void InputInterface::registerModuleInitCallback

(

inputInterfaceCallback

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 InputInterface), 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 InputInterface::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 InputInterface::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

ControllerManagerInterface * InputInterface::controllerManager = NULL [static, private]

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

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

std::vector< inputInterfaceCallback > InputInterface::moduleInitCallbacks [static, private]

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

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

XmlConfigurationLoader InputInterface::xmlConfigLoader [static, private]

---

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

• src/inVRs/InputInterface/InputInterface.h
• src/inVRs/InputInterface/InputInterface.cpp