CellData Class Reference

#include <CellData.hpp>

Inheritance diagram for CellData:

Collaboration diagram for CellData:

List of all members.

Public Member Functions
void	SetItem (const std::string &variableName, double data)
double	GetItem (const std::string &variableName) const
unsigned	GetNumItems () const
std::vector< std::string >	GetKeys () const
Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)
Private Attributes
std::map< std::string, double >	mCellData
Friends
class	boost::serialization::access

---

Detailed Description

CellData class.

Each Cell owns a CellData property

Definition at line 58 of file CellData.hpp.

---

Member Function Documentation

double CellData::GetItem

(

const std::string &

variableName

)

const

Get data.

Parameters:

variableName

the index of the data required.

Definition at line 43 of file CellData.cpp.

References DOUBLE_UNSET, EXCEPTION, and mCellData.

std::vector< std::string > CellData::GetKeys

(

)

const

Get all keys These are sorted in lexicographical/alphabetic order (so that the order is independent of any map iteration method)

Todo:

Note: Does the order of the keys matter? If so, then sort the vector + Doxygen

Definition at line 68 of file CellData.cpp.

References mCellData.

unsigned CellData::GetNumItems

(

)

const

Get number of data items

Definition at line 63 of file CellData.cpp.

References mCellData.

template<class Archive >

void CellData::serialize	(	Archive &	archive,
		const unsigned int	version
	)		[inline, private]

Archive the member variables.

Parameters:

archive	the archive
version	the current version of this class

Reimplemented from AbstractCellProperty.

Definition at line 76 of file CellData.hpp.

References mCellData.

void CellData::SetItem	(	const std::string &	variableName,
		double	data
	)

Constructor/destructor are default. This assigns the cell data.

Parameters:

variableName	the index of the data to be set.
data	the value to set it to.

Definition at line 38 of file CellData.cpp.

References mCellData.

---

Friends And Related Function Documentation

friend class boost::serialization::access [friend]

Needed for serialization.

Reimplemented from AbstractCellProperty.

Definition at line 68 of file CellData.hpp.

---

Member Data Documentation

std::map<std::string, double> CellData::mCellData [private]

Cell data

Definition at line 65 of file CellData.hpp.

Referenced by GetItem(), GetKeys(), GetNumItems(), serialize(), and SetItem().

---

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

• cell_based/src/population/cell/properties/CellData.hpp
• cell_based/src/population/cell/properties/CellData.cpp