dictionary Class Reference [Standard classes and functions]

The dictionary objects map string values to values or objects of other types. More...

---

Detailed Description

The dictionary objects map string values to values or objects of other types.

Example:

List of all members.

Private Member Functions
void	set (const string& in key,?& in value)
	Sets a variable type value for a key.
bool	get (const string& in key,?& out value) const
	Gets a variable type value for a key.
void	set (const string& in key, int64& in value)
	Sets an integer number value for a key.
bool	get (const string& in key, int64& out value) const
	Gets an integer number value for a key.
void	set (const string& in key, double& in value)
	Sets a real number value for a key.
bool	get (const string& in key, double& out value) const
	Gets a real number value for a key.
bool	exists (const string& in key) const
	Returns true if the key is set.
void	delete (const string& in key)
	Deletes specified key.
void	deleteAll ()
	Deletes all keys.

---

Member Function Documentation

void set	(	const string& in	key,
		?& in	value
	)			[private]

Sets a variable type value for a key.

Parameters:

	key	The key of the value to set.
	value	Value to associate with the specified key.

bool get	(	const string& in	key,
		?& out	value
	)			const [private]

Gets a variable type value for a key.

Parameters:

	key	The key of the value to get.
[out]	value	When this method returns, contains the value associated with the specified key, if the key is found.

Returns:

true if the the specified key is set; otherwise, false.

void set	(	const string& in	key,
		int64& in	value
	)			[private]

Sets an integer number value for a key.

Parameters:

	key	The key of the value to set.
	value	Value to associate with the specified key.

bool get	(	const string& in	key,
		int64& out	value
	)			const [private]

Gets an integer number value for a key.

Parameters:

	key	The key of the value to get.
[out]	value	When this method returns, contains the value associated with the specified key, if the key is found.

Returns:

true if the the specified key is set; otherwise, false.

void set	(	const string& in	key,
		double& in	value
	)			[private]

Sets a real number value for a key.

Parameters:

	key	The key of the value to set.
	value	Value to associate with the specified key.

bool get	(	const string& in	key,
		double& out	value
	)			const [private]

Gets a real number value for a key.

Parameters:

	key	The key of the value to get.
[out]	value	When this method returns, contains the value associated with the specified key, if the key is found.

Returns:

true if the the specified key is set; otherwise, false.

bool exists

(

const string& in

key

)

const [private]

Returns true if the key is set.

Parameters:

key

Key to check.

Returns:

Returns true if the key is set; otherwise, false.

void delete

(

const string& in

key

)

[private]

Deletes specified key.

Parameters:

key

Key to delete.

void deleteAll

(

)

[private]

Deletes all keys.