ElemUtils::Parameters Class Reference

Object defining a list of pieces of data (of common Parameter type). More...

Public Member Functions
	Parameters ()
	Parameters (const std::string &key, const GenericType &value)
	Parameters (const Parameter &parameter)
virtual	~Parameters ()
void	add (const std::string &key, const GenericType &value)
void	add (const Parameter &parameter)
void	add (const Parameters &parameters)
bool	isAvailable (const std::string &parameterName) const
size_t	size () const
void	clear ()
Parameter	operator() (const std::string &key) const
virtual std::string	toString () const
bool	update (const std::string &key, const GenericType &value)
bool	update (const std::string &key, const Parameter &parameter)
bool	remove (const std::string &key)
const Parameter &	get (const std::string &key) const
const Parameter &	getLastAvailable () const
std::string	key (size_t index) const
	Care ! Use it after isAvailable() to ensure that the iterator is in the map range. More...
std::string	stringValue (size_t index) const

Private Attributes
std::map< std::string, Parameter >	m_parameters
std::map< std::string, Parameter >::const_iterator	m_it

Detailed Description

Object defining a list of pieces of data (of common Parameter type).

Each member of the list is uniquely identified by its name.

Constructor & Destructor Documentation

Parameters() [1/3]

ElemUtils::Parameters::Parameters

(

)

Parameters() [2/3]

ElemUtils::Parameters::Parameters	(	const std::string &	key,
		const GenericType &	value
	)

Parameters() [3/3]

ElemUtils::Parameters::Parameters

(

const Parameter &

parameter

)

~Parameters()

ElemUtils::Parameters::~Parameters ( )

virtual

Member Function Documentation

add() [1/3]

void ElemUtils::Parameters::add

(

const Parameter &

parameter

)

add() [2/3]

void ElemUtils::Parameters::add

(

const Parameters &

parameters

)

add() [3/3]

void ElemUtils::Parameters::add	(	const std::string &	key,
		const GenericType &	value
	)

clear()

void ElemUtils::Parameters::clear

(

)

get()

const Parameter & ElemUtils::Parameters::get

(

const std::string &

key

)

const

getLastAvailable()

const Parameter & ElemUtils::Parameters::getLastAvailable

(

)

const

isAvailable()

bool ElemUtils::Parameters::isAvailable

(

const std::string &

parameterName

)

const

key()

std::string ElemUtils::Parameters::key

(

size_t

index

)

const

Care ! Use it after isAvailable() to ensure that the iterator is in the map range.

operator()()

Parameter ElemUtils::Parameters::operator()

(

const std::string &

key

)

const

remove()

bool ElemUtils::Parameters::remove

(

const std::string &

key

)

size()

size_t ElemUtils::Parameters::size

(

)

const

stringValue()

std::string ElemUtils::Parameters::stringValue

(

size_t

index

)

const

toString()

std::string ElemUtils::Parameters::toString ( ) const

virtual

update() [1/2]

bool ElemUtils::Parameters::update	(	const std::string &	key,
		const GenericType &	value
	)

update() [2/2]

bool ElemUtils::Parameters::update	(	const std::string &	key,
		const Parameter &	parameter
	)

Member Data Documentation

m_it

std::map<std::string, Parameter>::const_iterator ElemUtils::Parameters::m_it

mutableprivate

m_parameters

std::map<std::string, Parameter> ElemUtils::Parameters::m_parameters

private

---

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

• include/ElementaryUtils/parameters/Parameters.h
• src/ElementaryUtils/parameters/Parameters.cpp