CellEdgeData Class Reference

#include <CellEdgeData.hpp>

Inheritance diagram for CellEdgeData:

Collaboration diagram for CellEdgeData:

Public Member Functions
virtual	~CellEdgeData ()
void	SetItem (const std::string &rVariableName, const std::vector< double > &rData)
std::vector< double >	GetItem (const std::string &rVariableName) const
double	GetItemAtIndex (const std::string &rVariableName, const unsigned index)
unsigned	GetNumItems () const
std::vector< std::string >	GetKeys () const
Public Member Functions inherited from AbstractCellProperty
	AbstractCellProperty ()
virtual	~AbstractCellProperty ()
template<class CLASS >
bool	IsType () const
template<class BASECLASS >
bool	IsSubType () const
bool	IsSame (const AbstractCellProperty *pOther) const
bool	IsSame (boost::shared_ptr< const AbstractCellProperty > pOther) const
void	IncrementCellCount ()
void	DecrementCellCount ()
unsigned	GetCellCount () const
Public Member Functions inherited from Identifiable
virtual	~Identifiable ()
std::string	GetIdentifier () const

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

Private Attributes
std::map< std::string, std::vector< double > >	mCellEdgeData

Friends
class	boost::serialization::access

Detailed Description

Data associated with the cell's edges, for use when cells are physically represented as a VertexMesh. Each data item is an array that has the same size and in the same order as edges in cell's associated VertexElement.

Definition at line 57 of file CellEdgeData.hpp.

Constructor & Destructor Documentation

~CellEdgeData()

CellEdgeData::~CellEdgeData ( )

virtual

We need the empty virtual destructor in this class to ensure Boost serialization works correctly with static libraries.

Definition at line 38 of file CellEdgeData.cpp.

Member Function Documentation

GetItem()

std::vector< double > CellEdgeData::GetItem

(

const std::string &

rVariableName

)

const

Retrieves the cell edge data array. Throws if rVariableName has not been stored.

Parameters

rVariableName

the name of the data to get.

Returns

An array of cell edge data

Definition at line 47 of file CellEdgeData.cpp.

References EXCEPTION, and mCellEdgeData.

GetItemAtIndex()

double CellEdgeData::GetItemAtIndex	(	const std::string &	rVariableName,
		const unsigned	index
	)

Retrieves the data of rVariableName at index

Parameters

rVariableName	the name of the data to get.
index	the index of the data of rVariableName

Returns

A single value in the data array.

Definition at line 63 of file CellEdgeData.cpp.

References EXCEPTION, and mCellEdgeData.

GetKeys()

std::vector< std::string > CellEdgeData::GetKeys

(

)

const

Returns

all keys.

According to STL these are sorted in lexicographical/alphabetic order (so that the ordering here is predictable).

Definition at line 89 of file CellEdgeData.cpp.

References mCellEdgeData.

GetNumItems()

unsigned CellEdgeData::GetNumItems

(

)

const

Returns

number of data items

Definition at line 84 of file CellEdgeData.cpp.

References mCellEdgeData.

serialize()

template<class Archive >

void CellEdgeData::serialize ( Archive &  archive, const unsigned int  version  )

inlineprivate

Archive the member variables.

Parameters

archive	the archive
version	the current version of this class

Definition at line 73 of file CellEdgeData.hpp.

References mCellEdgeData.

SetItem()

void CellEdgeData::SetItem	(	const std::string &	rVariableName,
		const std::vector< double > &	rData
	)

This assigns the cell edge data vector.

Parameters

rVariableName	the name of the data to be set.
rData	the vector of values to set it to.

Definition at line 42 of file CellEdgeData.cpp.

References mCellEdgeData.

Friends And Related Symbol Documentation

boost::serialization::access

friend class boost::serialization::access

friend

Needed for serialization.

Definition at line 65 of file CellEdgeData.hpp.

Member Data Documentation

mCellEdgeData

std::map<std::string, std::vector<double> > CellEdgeData::mCellEdgeData

private

The cell edge data.

Definition at line 62 of file CellEdgeData.hpp.

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

---

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

• cell_based/src/cell/properties/CellEdgeData.hpp
• cell_based/src/cell/properties/CellEdgeData.cpp