mitk::ScalarListLookupTable Class Reference

Data class for model fit properties that store a map of lists (e.g. static parameters). More...

#include <mitkScalarListLookupTable.h>

Collaboration diagram for mitk::ScalarListLookupTable:

Public Types
typedef std::string	KeyType
typedef std::vector< double >	ValueType
typedef std::map< KeyType, ValueType >	LookupTableType
typedef std::pair< KeyType, ValueType >	EntryType

Public Member Functions
	ScalarListLookupTable ()
	ScalarListLookupTable (const ScalarListLookupTable &)=default
virtual	~ScalarListLookupTable ()
virtual const char *	GetNameOfClass () const
void	SetTableValue (const KeyType &key, const ValueType &value)
	Sets the list at the given map key to the given value. More...
bool	ValueExists (const KeyType &key) const
	Returns true if the list with the given name exists. More...
const ValueType &	GetTableValue (const KeyType &key) const
	Returns the list with the given name. More...
const LookupTableType &	GetLookupTable () const
	Returns the map of lists. More...
void	SetLookupTable (const LookupTableType &table)
bool	operator== (const ScalarListLookupTable &lookupTable) const
bool	operator!= (const ScalarListLookupTable &lookupTable) const
virtual ScalarListLookupTable &	operator= (const ScalarListLookupTable &other)

Protected Attributes
LookupTableType	m_LookupTable

Detailed Description

Data class for model fit properties that store a map of lists (e.g. static parameters).

Definition at line 29 of file mitkScalarListLookupTable.h.

Member Typedef Documentation

EntryType

typedef std::pair<KeyType, ValueType> mitk::ScalarListLookupTable::EntryType

Definition at line 35 of file mitkScalarListLookupTable.h.

KeyType

typedef std::string mitk::ScalarListLookupTable::KeyType

Definition at line 32 of file mitkScalarListLookupTable.h.

LookupTableType

typedef std::map<KeyType, ValueType> mitk::ScalarListLookupTable::LookupTableType

Definition at line 34 of file mitkScalarListLookupTable.h.

ValueType

typedef std::vector<double> mitk::ScalarListLookupTable::ValueType

Definition at line 33 of file mitkScalarListLookupTable.h.

Constructor & Destructor Documentation

ScalarListLookupTable() [1/2]

mitk::ScalarListLookupTable::ScalarListLookupTable ( )

inline

Definition at line 37 of file mitkScalarListLookupTable.h.

ScalarListLookupTable() [2/2]

mitk::ScalarListLookupTable::ScalarListLookupTable ( const ScalarListLookupTable &  )

default

~ScalarListLookupTable()

virtual mitk::ScalarListLookupTable::~ScalarListLookupTable ( )

inlinevirtual

Definition at line 39 of file mitkScalarListLookupTable.h.

Member Function Documentation

GetLookupTable()

const LookupTableType& mitk::ScalarListLookupTable::GetLookupTable

(

)

const

Returns the map of lists.

Returns

The map of lists.

GetNameOfClass()

virtual const char* mitk::ScalarListLookupTable::GetNameOfClass ( ) const

virtual

GetTableValue()

const ValueType& mitk::ScalarListLookupTable::GetTableValue

(

const KeyType &

key

)

const

Returns the list with the given name.

Parameters

key	The name (i.e. map key) of the desired list.

Returns

The list with the given name.

Exceptions

std::range_error

If the list doesn't exist.

operator!=()

bool mitk::ScalarListLookupTable::operator!=

(

const ScalarListLookupTable &

lookupTable

)

const

operator=()

virtual ScalarListLookupTable& mitk::ScalarListLookupTable::operator= ( const ScalarListLookupTable &  other )

virtual

operator==()

bool mitk::ScalarListLookupTable::operator==

(

const ScalarListLookupTable &

lookupTable

)

const

SetLookupTable()

void mitk::ScalarListLookupTable::SetLookupTable

(

const LookupTableType &

table

)

SetTableValue()

void mitk::ScalarListLookupTable::SetTableValue	(	const KeyType &	key,
		const ValueType &	value
	)

Sets the list at the given map key to the given value.

Parameters

key	The name of the list (i.e. map key).
value	The list to be added (i.e. map value).

ValueExists()

bool mitk::ScalarListLookupTable::ValueExists

(

const KeyType &

key

)

const

Returns true if the list with the given name exists.

Parameters

key	The name of the desired list (i.e. map key).

Returns

True if the list exists or false otherwise.

Member Data Documentation

m_LookupTable

LookupTableType mitk::ScalarListLookupTable::m_LookupTable

protected

Definition at line 79 of file mitkScalarListLookupTable.h.

---

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

• mitkScalarListLookupTable.h