utl::ResponseMap Class Reference

A helper class which manages a list of system response identifiers (std::strings) and their corresponding weights. More...

#include "utl/ResponseMap.h"

Public Types
typedef std::map< std::string, double >::const_iterator	const_iterator

Public Member Functions
void	AddResponseItem (const std::string &identifier, const double weight)
	Add the item denoted by the identifier with the specified weight to the ResponseMap. More...
const_iterator	Begin () const
	Get an iterator to the first element of the ResponseMap. More...
void	Clear ()
const_iterator	End () const
	Get an iterator to the end of the ResponseMap. More...
bool	operator== (const ResponseMap &m) const
	compares if two ResponseMaps are identical More...
	ResponseMap (const std::map< std::string, double > &m)
	Constructor to create a ResponseMap from an stl-map. More...
std::map< std::string, double > ::size_type	Size () const

Private Member Functions
	ResponseMap ()

Private Attributes
std::map< std::string, double >	fResponseMap

Friends
class	utl::Validated< ResponseMap >

Detailed Description

A helper class which manages a list of system response identifiers (std::strings) and their corresponding weights.

Author

Tim Huege

Definition at line 28 of file ResponseMap.h.

Member Typedef Documentation

typedef std::map<std::string, double>::const_iterator utl::ResponseMap::const_iterator

Definition at line 34 of file ResponseMap.h.

Constructor & Destructor Documentation

utl::ResponseMap::ResponseMap ( const std::map< std::string, double > &  m )

inline

Constructor to create a ResponseMap from an stl-map.

Definition at line 31 of file ResponseMap.h.

References fResponseMap, and utl::m.

utl::ResponseMap::ResponseMap ( )

inlineprivate

Definition at line 56 of file ResponseMap.h.

References fResponseMap.

Member Function Documentation

void utl::ResponseMap::AddResponseItem ( const std::string &  identifier, const double  weight  )

inline

Add the item denoted by the identifier with the specified weight to the ResponseMap.

Definition at line 41 of file ResponseMap.h.

References fResponseMap.

const_iterator utl::ResponseMap::Begin ( ) const

inline

Get an iterator to the first element of the ResponseMap.

Definition at line 45 of file ResponseMap.h.

References fResponseMap.

Referenced by RdChannelResponseIncorporator::RdChannelResponseIncorporator::CalculateOverallResponse(), and RDetectorTest::testRModel().

void utl::ResponseMap::Clear ( )

inline

Definition at line 36 of file ResponseMap.h.

References fResponseMap.

const_iterator utl::ResponseMap::End ( ) const

inline

Get an iterator to the end of the ResponseMap.

Definition at line 48 of file ResponseMap.h.

References fResponseMap.

Referenced by RdChannelResponseIncorporator::RdChannelResponseIncorporator::CalculateOverallResponse(), and RDetectorTest::testRModel().

bool utl::ResponseMap::operator== ( const ResponseMap &  m ) const

inline

compares if two ResponseMaps are identical

Definition at line 51 of file ResponseMap.h.

References fResponseMap.

std::map<std::string, double>::size_type utl::ResponseMap::Size ( ) const

inline

Definition at line 38 of file ResponseMap.h.

References fResponseMap.

Friends And Related Function Documentation

friend class utl::Validated< ResponseMap >

friend

Definition at line 55 of file ResponseMap.h.

Member Data Documentation

std::map<std::string, double> utl::ResponseMap::fResponseMap

private

Definition at line 59 of file ResponseMap.h.

Referenced by AddResponseItem(), Begin(), Clear(), End(), operator==(), ResponseMap(), and Size().

---

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

• ResponseMap.h