dp3::parmdb::ParmMap Class Reference

A map of parameter name to value set. More...

#include <ParmMap.h>

Public Member Functions
	ParmMap ()
	Set up a map for the given domain in the ParmDB. More...
void	clear ()
	Clear the map. More...
void	define (const std::string &name, const ParmValueSet &pset)
	Add or replace a ParmValueSet. More...
bool	empty () const
	Is the map empty? More...
const ParmValueSet &	operator[] (const std::string &name) const
unsigned int	size () const
	Return the size of the map. More...
typedef std::map< std::string, ParmValueSet >::iterator	iterator
typedef std::map< std::string, ParmValueSet >::const_iterator	const_iterator
typedef std::map< std::string, ParmValueSet >::value_type	valueType
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const
iterator	find (const std::string &name)
const_iterator	find (const std::string &name) const

Detailed Description

A map of parameter name to value set.

ParmMap holds a map of name to ParmValueSet. It is meant to hold the default values, but could be used for other purposes as well.

Member Typedef Documentation

const_iterator

typedef std::map<std::string, ParmValueSet>::const_iterator dp3::parmdb::ParmMap::const_iterator

iterator

typedef std::map<std::string, ParmValueSet>::iterator dp3::parmdb::ParmMap::iterator

Iterator functionality.

valueType

typedef std::map<std::string, ParmValueSet>::value_type dp3::parmdb::ParmMap::valueType

Constructor & Destructor Documentation

ParmMap()

dp3::parmdb::ParmMap::ParmMap ( )

inline

Set up a map for the given domain in the ParmDB.

Member Function Documentation

begin() [1/2]

iterator dp3::parmdb::ParmMap::begin ( )

inline

begin() [2/2]

const_iterator dp3::parmdb::ParmMap::begin ( ) const

inline

clear()

void dp3::parmdb::ParmMap::clear ( )

inline

Clear the map.

define()

void dp3::parmdb::ParmMap::define ( const std::string &  name, const ParmValueSet &  pset  )

inline

Add or replace a ParmValueSet.

empty()

bool dp3::parmdb::ParmMap::empty ( ) const

inline

Is the map empty?

end() [1/2]

iterator dp3::parmdb::ParmMap::end ( )

inline

end() [2/2]

const_iterator dp3::parmdb::ParmMap::end ( ) const

inline

find() [1/2]

iterator dp3::parmdb::ParmMap::find ( const std::string &  name )

inline

find() [2/2]

const_iterator dp3::parmdb::ParmMap::find ( const std::string &  name ) const

inline

operator[]()

const ParmValueSet& dp3::parmdb::ParmMap::operator[]

(

const std::string &

name

)

const

Get the value belonging to the name. An exception is thrown if the value does not exist.

size()

unsigned int dp3::parmdb::ParmMap::size ( ) const

inline

Return the size of the map.

---

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

• ParmMap.h