#include <CellAncestor.hpp>
Inheritance diagram for CellAncestor:
Collaboration diagram for CellAncestor:
Public Member Functions | |
| CellAncestor (unsigned ancestor=UNSIGNED_UNSET) | |
| virtual | ~CellAncestor () |
| unsigned | GetAncestor () 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.
| CellAncestor::~CellAncestor | ( | ) | [virtual] |
Destructor.
Definition at line 44 of file CellAncestor.cpp.
Member Function Documentation
| unsigned CellAncestor::GetAncestor | ( | ) | const |
Get mAncestor.
Definition at line 48 of file CellAncestor.cpp.
References mAncestor.
Referenced by Cell::GetAncestor().
| void CellAncestor::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 71 of file CellAncestor.hpp.
References mAncestor.
Friends And Related Function Documentation
friend class boost::serialization::access [friend] |
Needed for serialization.
Reimplemented from AbstractCellProperty.
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/population/cell/properties/CellAncestor.hpp
- cell_based/src/population/cell/properties/CellAncestor.cpp
