igor::iParameters Class Reference

#include <iParameters.h>

Public Member Functions
	iParameters ()=default
	iParameters (const iParametersMap &parameters)
void	setParameter (const iaString &name, const iAny &value)
const iAny &	getParameter (const iaString &name, const iAny &defaultValue=iAny()) const
template<typename T >
T	getParameterValue (const iaString &name, const T &defaultValue=T()) const
bool	hasParameter (const iaString &name) const
iAnyType	getParameterType (const iaString &name) const
const iParametersMap &	getData () const
template<typename T >
T	getParameterValue (const iaString &name, const T &defaultValue) const

Detailed Description

a key value list of parameters

Constructor & Destructor Documentation

iParameters() [1/2]

igor::iParameters::iParameters ( )

default

does nothing

iParameters() [2/2]

igor::iParameters::iParameters ( const iParametersMap &  parameters )

explicit

init members

Parameters

parameters

the parameters

Member Function Documentation

getData()

const iParametersMap & igor::iParameters::getData

(

)

const

Returns

all parameters

getParameter()

const iAny & igor::iParameters::getParameter	(	const iaString &	name,
		const iAny &	defaultValue = iAny()
	)		const

Returns

value for given parameter name

if name does not exist it returns some default value

Parameters

name	the parameter name
defaultValue	the given default value

getParameterType()

iAnyType igor::iParameters::getParameterType

(

const iaString &

name

)

const

Returns

parameter type of given parameter name

Parameters

name	the parameter name

getParameterValue() [1/2]

template<typename T >

T igor::iParameters::getParameterValue	(	const iaString &	name,
		const T &	defaultValue
	)		const

getParameterValue() [2/2]

template<typename T >

T igor::iParameters::getParameterValue	(	const iaString &	name,
		const T &	defaultValue = T()
	)		const

Returns

value for given parameter name

if name does not exist it returns some default value

Parameters

name	the parameter name
defaultValue	the given default value

hasParameter()

bool igor::iParameters::hasParameter

(

const iaString &

name

)

const

Returns

true if given name exists

Parameters

name	given parameter name

setParameter()

void igor::iParameters::setParameter	(	const iaString &	name,
		const iAny &	value
	)

sets value for given parameter

overwrites existing values

Parameters

name	name of parameter
value	the value to set

---

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

• /home/martin/dev/Igor/src/igor/igor/data/iParameters.h
• /home/martin/dev/Igor/src/igor/igor/data/iParameters.cpp
• /home/martin/dev/Igor/src/igor/igor/data/iParameters.inl