ArgumentVector Class Reference

#include <ArgumentVector.h>

List of all members.

Classes
class	Argument
Public Member Functions
	~ArgumentVector ()
void	push_back (std::string key, bool value)
void	push_back (std::string key, int value)
void	push_back (std::string key, unsigned int value)
void	push_back (std::string key, float value)
void	push_back (std::string key, std::string value)
int	size () const
bool	keyExists (std::string key) const
bool	get (std::string key, bool &val) const
bool	get (std::string key, int &val) const
bool	get (std::string key, unsigned int &val) const
bool	get (std::string key, float &val) const
bool	get (std::string key, std::string &val) const
void	addToBinaryMessage (NetMessage *msg) const
Static Public Member Functions
static ArgumentVector *	readFromBinaryMessage (NetMessage *msg)
Private Attributes
std::map< std::string, Argument >	arguments

---

Constructor & Destructor Documentation

ArgumentVector::~ArgumentVector

(

)

---

Member Function Documentation

void ArgumentVector::addToBinaryMessage

(

NetMessage *

msg

)

const

Serialise the ArgumentVector and append it to a NetMessage.

bool ArgumentVector::get	(	std::string	key,
		std::string &	val
	)			const

Write the string value associated with key into val. If the key does not exist val is not altered.

Parameters:

key

the key

Returns:

true, if key exists, false otherwise.

bool ArgumentVector::get	(	std::string	key,
		float &	val
	)			const

Write the float value associated with key into val. If the key does not exist val is not altered.

Parameters:

key

the key

Returns:

true, if key exists, false otherwise.

bool ArgumentVector::get	(	std::string	key,
		unsigned int &	val
	)			const

Write the unsigned integer value associated with key into val. If the key does not exist val is not altered.

Parameters:

key

the key

Returns:

true, if key exists, false otherwise.

bool ArgumentVector::get	(	std::string	key,
		int &	val
	)			const

Write the integer value associated with key into val. If the key does not exist val is not altered.

Parameters:

key

the key

Returns:

true, if key exists, false otherwise.

bool ArgumentVector::get	(	std::string	key,
		bool &	val
	)			const

Write the boolean value associated with key into val. If the key does not exist val is not altered.

Parameters:

key

the key

Returns:

true, if key exists, false otherwise.

bool ArgumentVector::keyExists

(

std::string

key

)

const

Query whether a value is associated with the given key.

Parameters:

key

the key

Returns:

true, if key exists, false otherwise.

void ArgumentVector::push_back	(	std::string	key,
		std::string	value
	)

void ArgumentVector::push_back	(	std::string	key,
		float	value
	)

void ArgumentVector::push_back	(	std::string	key,
		unsigned int	value
	)

void ArgumentVector::push_back	(	std::string	key,
		int	value
	)

void ArgumentVector::push_back	(	std::string	key,
		bool	value
	)

ArgumentVector * ArgumentVector::readFromBinaryMessage

(

NetMessage *

msg

)

[static]

Deserialise an ArgumentVector from a NetMessage.

int ArgumentVector::size

(

)

const

---

Member Data Documentation

std::map<std::string, Argument> ArgumentVector::arguments [private]

---

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

• src/inVRs/SystemCore/ArgumentVector.h
• src/inVRs/SystemCore/ArgumentVector.cpp