CellAncestor Class Reference

#include <CellAncestor.hpp>

Inheritance diagram for CellAncestor:

Collaboration diagram for CellAncestor:

Public Member Functions
	CellAncestor (unsigned ancestor=UNSIGNED_UNSET)
virtual	~CellAncestor ()
unsigned	GetAncestor () 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
unsigned	mAncestor

Friends
class	boost::serialization::access

Detailed Description

Cell ancestor class.

Each Cell owns a CellPropertyCollection, which may include a shared pointer to an object of this type. When a Cell that has an ancestor divides, the daughter cells both have the same ancestor.

The CellAncestor object keeps track of the number of cells that have the same ancestor.

Definition at line 53 of file CellAncestor.hpp.

Constructor & Destructor Documentation

CellAncestor::CellAncestor

(

unsigned

ancestor = UNSIGNED_UNSET

)

Constructor.

Parameters

ancestor

the ID of the ancestor of this cell. Defaults to max.

Definition at line 38 of file CellAncestor.cpp.

Referenced by serialize().

CellAncestor::~CellAncestor ( )

virtual

Destructor.

Definition at line 44 of file CellAncestor.cpp.

Referenced by serialize().

Member Function Documentation

unsigned CellAncestor::GetAncestor

(

)

const

Returns

mAncestor.

Definition at line 48 of file CellAncestor.cpp.

References CHASTE_CLASS_EXPORT, and mAncestor.

Referenced by Cell::GetAncestor(), and serialize().

template<class Archive >

void CellAncestor::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 71 of file CellAncestor.hpp.

References CellAncestor(), CHASTE_CLASS_EXPORT, GetAncestor(), mAncestor, UNSIGNED_UNSET, and ~CellAncestor().

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Needed for serialization.

Definition at line 63 of file CellAncestor.hpp.

Member Data Documentation

unsigned CellAncestor::mAncestor

private

Cell ancestor

Definition at line 60 of file CellAncestor.hpp.

Referenced by GetAncestor(), and serialize().

---

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

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