makVrv::DtJoystickConfigurationSettings Class Reference

A set of settings that will encompass all function groups and functions currently known. More...

Classes
struct	GameControl

Public Types
typedef std::map< std::string, DtJoystickConfigurationSetting >	SettingsByFunctionCode
typedef std::map< std::string, SettingsByFunctionCode >	JoystickConfigurationSettings
typedef std::vector< GameControl >	GameControlInformation

Public Member Functions
	DtJoystickConfigurationSettings ()
	CTOR.
	DtJoystickConfigurationSettings (const DtJoystickConfigurationSettings &)
	~DtJoystickConfigurationSettings ()
	DTOR.
DtUnicode	gameControllerName (const std::string &functionGroup, const std::string &function) const
	Returns the name of the game controller that is used to control the particular function group and function.
DtUnicode	gameControllerFunction (const std::string &functionGroup, const std::string &function) const
	Returns the name of the game function descriptive text that is used to control the particular function group and function.
const JoystickConfigurationSettings &	joystickConfigurationSettings () const
GameControlInformation	gameControlInformation (const std::string &fg) const
	Will return only specified game control information for this function group.
bool	addSwitchGroup (const std::string &)
	Adds a new configuration for switch groups. Returns true if this switch group did not exist.
bool	addOrUpdateJoystickControl (const std::string &functionGroup, const std::string &function)
	Adds or updates the control. If either has happened return true.
DtGameControlInformation	gameControlInformationFor (const std::string &functionGroup, const std::string &function) const
	Returns game controller information for the given function group and function.
bool	removeGameControlInformationFor (const std::string &functionGroup, const std::string &function)
	Removes game controller information for the given configuration, function group and function.
DtJoystickConfigurationSetting	addGameControlInformationFor (const std::string &functionGroup, const std::string &function, const DtGameControlInformation &)
bool	functionGroupSpecified (const std::string &functionGroup, bool all=false) const
	Returns true if at least one function in the function group is specified. If all flag is true then all must be specified.

Protected Member Functions
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
	When the class Archive corresponds to an output archive, the & operator is defined similar to <<.

Protected Attributes
JoystickConfigurationSettings	myJoystickConfigurationSettings

Friends
class	boost::serialization::access

Detailed Description

A set of settings that will encompass all function groups and functions currently known.

Member Typedef Documentation

typedef std::map<std::string, DtJoystickConfigurationSetting> makVrv::DtJoystickConfigurationSettings::SettingsByFunctionCode

typedef std::map<std::string, SettingsByFunctionCode> makVrv::DtJoystickConfigurationSettings::JoystickConfigurationSettings

typedef std::vector<GameControl> makVrv::DtJoystickConfigurationSettings::GameControlInformation

Constructor & Destructor Documentation

makVrv::DtJoystickConfigurationSettings::DtJoystickConfigurationSettings

(

)

CTOR.

makVrv::DtJoystickConfigurationSettings::DtJoystickConfigurationSettings

(

const DtJoystickConfigurationSettings &

)

makVrv::DtJoystickConfigurationSettings::~DtJoystickConfigurationSettings

(

)

DTOR.

Member Function Documentation

DtUnicode makVrv::DtJoystickConfigurationSettings::gameControllerName	(	const std::string &	functionGroup,
		const std::string &	function
	)		const

Returns the name of the game controller that is used to control the particular function group and function.

DtUnicode makVrv::DtJoystickConfigurationSettings::gameControllerFunction	(	const std::string &	functionGroup,
		const std::string &	function
	)		const

Returns the name of the game function descriptive text that is used to control the particular function group and function.

const JoystickConfigurationSettings& makVrv::DtJoystickConfigurationSettings::joystickConfigurationSettings ( ) const

inline

GameControlInformation makVrv::DtJoystickConfigurationSettings::gameControlInformation

(

const std::string &

fg

)

const

Will return only specified game control information for this function group.

bool makVrv::DtJoystickConfigurationSettings::addSwitchGroup

(

const std::string &

)

Adds a new configuration for switch groups. Returns true if this switch group did not exist.

bool makVrv::DtJoystickConfigurationSettings::addOrUpdateJoystickControl	(	const std::string &	functionGroup,
		const std::string &	function
	)

Adds or updates the control. If either has happened return true.

DtGameControlInformation makVrv::DtJoystickConfigurationSettings::gameControlInformationFor	(	const std::string &	functionGroup,
		const std::string &	function
	)		const

Returns game controller information for the given function group and function.

bool makVrv::DtJoystickConfigurationSettings::removeGameControlInformationFor	(	const std::string &	functionGroup,
		const std::string &	function
	)

Removes game controller information for the given configuration, function group and function.

DtJoystickConfigurationSetting makVrv::DtJoystickConfigurationSettings::addGameControlInformationFor	(	const std::string &	functionGroup,
		const std::string &	function,
		const DtGameControlInformation &
	)

bool makVrv::DtJoystickConfigurationSettings::functionGroupSpecified	(	const std::string &	functionGroup,
		bool	all = false
	)		const

Returns true if at least one function in the function group is specified. If all flag is true then all must be specified.

template<class Archive >

void makVrv::DtJoystickConfigurationSettings::serialize ( Archive &  ar, const unsigned int  version  )

inlineprotected

When the class Archive corresponds to an output archive, the & operator is defined similar to <<.

Likewise, when the class Archive is a type of input archive the & operator is defined similar to >>.

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Member Data Documentation

JoystickConfigurationSettings makVrv::DtJoystickConfigurationSettings::myJoystickConfigurationSettings

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/joystickCore/joystickConfigurations.h