makArchives::DtNameValueLists Class Reference

Inherit this is you need a list of name/value pairs. More...

Inheritance diagram for makArchives::DtNameValueLists:

Public Types
typedef std::map< std::string, int >	ParametersInt
	Map types for image task parameter storage.
typedef std::map< std::string, bool >	ParametersBool
	Map types for image task parameter storage.
typedef std::map< std::string, double >	ParametersDouble
	Map types for image task parameter storage.
typedef std::map< std::string, std::string >	ParametersString
	Map types for image task parameter storage.

Public Member Functions
	DtNameValueLists ()
	CTOR.
	DtNameValueLists (const DtNameValueLists &obj)
	Copy CTOR.
DtNameValueLists &	operator= (const DtNameValueLists &rhs)
	Assignment operator.
bool	operator== (const DtNameValueLists &rhs) const
	Equality Operator.
bool	operator!= (const DtNameValueLists &rhs)
	Inequality Operator.
int	parameterInt (const std::string &parameterName) const
	Parameter Accessors.
double	parameterDouble (const std::string &parameterName) const
	Parameter Accessors.
bool	parameterBool (const std::string &parameterName) const
	Parameter Accessors.
const std::string &	parameterString (const std::string &parameterName) const
	Parameter Accessors.
void	setParameterInt (const std::string &parameterName, int value)
	Parameter Mutators.
void	setParameterDouble (const std::string &parameterName, double value)
	Parameter Mutators.
void	setParameterBool (const std::string &parameterName, bool value)
	Parameter Mutators.
void	setParameterString (const std::string &parameterName, const std::string &value)
	Parameter Mutators.
bool	hasParameterInt (const std::string &parameterName) const
	Parameter existence tests.
bool	hasParameterDouble (const std::string &parameterName) const
	Parameter existence tests.
bool	hasParameterBool (const std::string &parameterName) const
	Parameter existence tests.
bool	hasParameterString (const std::string &parameterName) const
	Parameter existence tests.
bool	hasParameter (const std::string &parameterName) const
	Check for parameter name independent of type.
const ParametersInt &	parametersInt () const
	Parameter list accessors.
const ParametersDouble &	parametersDouble () const
	Parameter list accessors.
const ParametersBool &	parametersBool () const
	Parameter list accessors.
const ParametersString &	parametersString () const
	Parameter list accessors.
void	setParametersInt (const ParametersInt &parameters)
	Parameter list mutators.
void	setParametersBool (const ParametersBool &parameters)
	Parameter list mutators.
void	setParametersDouble (const ParametersDouble &parameters)
	Parameter list mutators.
void	setParametersString (const ParametersString &parameters)
	Parameter list mutators.

Protected Member Functions
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Protected Attributes
ParametersInt	myParametersInt
ParametersDouble	myParametersDouble
ParametersString	myParametersString
ParametersBool	myParametersBool

Friends
class	boost::serialization::access

Detailed Description

Inherit this is you need a list of name/value pairs.

Supports a list for each of int, double, string, and bool types.

Member Typedef Documentation

typedef std::map<std::string, int> makArchives::DtNameValueLists::ParametersInt

Map types for image task parameter storage.

typedef std::map<std::string, bool> makArchives::DtNameValueLists::ParametersBool

Map types for image task parameter storage.

typedef std::map<std::string, double> makArchives::DtNameValueLists::ParametersDouble

Map types for image task parameter storage.

typedef std::map<std::string, std::string> makArchives::DtNameValueLists::ParametersString

Map types for image task parameter storage.

Constructor & Destructor Documentation

makArchives::DtNameValueLists::DtNameValueLists

(

)

CTOR.

makArchives::DtNameValueLists::DtNameValueLists

(

const DtNameValueLists &

obj

)

Copy CTOR.

Member Function Documentation

DtNameValueLists& makArchives::DtNameValueLists::operator=

(

const DtNameValueLists &

rhs

)

Assignment operator.

bool makArchives::DtNameValueLists::operator==

(

const DtNameValueLists &

rhs

)

const

Equality Operator.

bool makArchives::DtNameValueLists::operator!=

(

const DtNameValueLists &

rhs

)

Inequality Operator.

int makArchives::DtNameValueLists::parameterInt

(

const std::string &

parameterName

)

const

Parameter Accessors.

double makArchives::DtNameValueLists::parameterDouble

(

const std::string &

parameterName

)

const

Parameter Accessors.

bool makArchives::DtNameValueLists::parameterBool

(

const std::string &

parameterName

)

const

Parameter Accessors.

const std::string& makArchives::DtNameValueLists::parameterString

(

const std::string &

parameterName

)

const

Parameter Accessors.

void makArchives::DtNameValueLists::setParameterInt	(	const std::string &	parameterName,
		int	value
	)

Parameter Mutators.

void makArchives::DtNameValueLists::setParameterDouble	(	const std::string &	parameterName,
		double	value
	)

Parameter Mutators.

void makArchives::DtNameValueLists::setParameterBool	(	const std::string &	parameterName,
		bool	value
	)

Parameter Mutators.

void makArchives::DtNameValueLists::setParameterString	(	const std::string &	parameterName,
		const std::string &	value
	)

Parameter Mutators.

bool makArchives::DtNameValueLists::hasParameterInt

(

const std::string &

parameterName

)

const

Parameter existence tests.

bool makArchives::DtNameValueLists::hasParameterDouble

(

const std::string &

parameterName

)

const

Parameter existence tests.

bool makArchives::DtNameValueLists::hasParameterBool

(

const std::string &

parameterName

)

const

Parameter existence tests.

bool makArchives::DtNameValueLists::hasParameterString

(

const std::string &

parameterName

)

const

Parameter existence tests.

bool makArchives::DtNameValueLists::hasParameter

(

const std::string &

parameterName

)

const

Check for parameter name independent of type.

const ParametersInt& makArchives::DtNameValueLists::parametersInt

(

)

const

Parameter list accessors.

const ParametersDouble& makArchives::DtNameValueLists::parametersDouble

(

)

const

Parameter list accessors.

const ParametersBool& makArchives::DtNameValueLists::parametersBool

(

)

const

Parameter list accessors.

const ParametersString& makArchives::DtNameValueLists::parametersString

(

)

const

Parameter list accessors.

void makArchives::DtNameValueLists::setParametersInt

(

const ParametersInt &

parameters

)

Parameter list mutators.

void makArchives::DtNameValueLists::setParametersBool

(

const ParametersBool &

parameters

)

Parameter list mutators.

void makArchives::DtNameValueLists::setParametersDouble

(

const ParametersDouble &

parameters

)

Parameter list mutators.

void makArchives::DtNameValueLists::setParametersString

(

const ParametersString &

parameters

)

Parameter list mutators.

template<class Archive >

void makArchives::DtNameValueLists::serialize ( Archive &  ar, const unsigned int  version  )

inlineprotected

Reimplemented in makArchives::DtMetadataPublisherRecord, and makArchives::DtImageTaskRecord.

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Member Data Documentation

ParametersInt makArchives::DtNameValueLists::myParametersInt

protected

ParametersDouble makArchives::DtNameValueLists::myParametersDouble

protected

ParametersString makArchives::DtNameValueLists::myParametersString

protected

ParametersBool makArchives::DtNameValueLists::myParametersBool

protected

---

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

• include/makArchives/DtNameValueLists.h