CellLabel Class Reference
#include <CellLabel.hpp>
Inherits AbstractCellProperty.
Public Member Functions | |
| CellLabel (unsigned colour=5) | |
| virtual | ~CellLabel () |
| unsigned | GetColour () const |
Private Member Functions | |
| template<class Archive > | |
| void | serialize (Archive &archive, const unsigned int version) |
Private Attributes | |
| unsigned | mColour |
Friends | |
| class | boost::serialization::access |
Detailed Description
Cell label class.
Each Cell owns a CellPropertyCollection, which may include a shared pointer to an object of this type. When a Cell that is labelled divides, the daughter cells are both labelled.
The CellLabel object keeps track of the number of cells that have the label, as well as what colour should be used by the visualizer to display cells with the label.
Definition at line 47 of file CellLabel.hpp.
Constructor & Destructor Documentation
| CellLabel::CellLabel | ( | unsigned | colour = 5 |
) |
Constructor.
- Parameters:
-
colour what colour cells with this label should be in the visualizer (defaults to 5)
Definition at line 31 of file CellLabel.cpp.
| CellLabel::~CellLabel | ( | ) | [virtual] |
Destructor.
Definition at line 37 of file CellLabel.cpp.
Member Function Documentation
| unsigned CellLabel::GetColour | ( | ) | const |
| void CellLabel::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 65 of file CellLabel.hpp.
References mColour.
Friends And Related Function Documentation
friend class boost::serialization::access [friend] |
Needed for serialization.
Reimplemented from AbstractCellProperty.
Definition at line 57 of file CellLabel.hpp.
Member Data Documentation
unsigned CellLabel::mColour [private] |
Colour for use by visualizer.
Definition at line 54 of file CellLabel.hpp.
Referenced by GetColour(), and serialize().
The documentation for this class was generated from the following files:
- cell_based/src/population/cell/properties/CellLabel.hpp
- cell_based/src/population/cell/properties/CellLabel.cpp
