Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
Public Member Functions | Protected Attributes | Private Member Functions | Friends | List of all members
CellLabel Class Reference

#include <CellLabel.hpp>

+ Inheritance diagram for CellLabel:
+ Collaboration diagram for CellLabel:

Public Member Functions

 CellLabel (unsigned colour=5)
 
virtual ~CellLabel ()
 
unsigned GetColour () 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
 

Protected Attributes

unsigned mColour
 

Private Member Functions

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

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 54 of file CellLabel.hpp.

Constructor & Destructor Documentation

◆ CellLabel()

CellLabel::CellLabel ( unsigned  colour = 5)

Constructor.

Parameters
colourwhat colour cells with this label should be in the visualizer (defaults to 5)

Definition at line 38 of file CellLabel.cpp.

◆ ~CellLabel()

CellLabel::~CellLabel ( )
virtual

Destructor.

Definition at line 44 of file CellLabel.cpp.

Member Function Documentation

◆ GetColour()

unsigned CellLabel::GetColour ( ) const
Returns
mColour.

Definition at line 48 of file CellLabel.cpp.

References mColour.

◆ serialize()

template<class Archive >
void CellLabel::serialize ( Archive &  archive,
const unsigned int  version 
)
inlineprivate

Archive the member variables.

Parameters
archivethe archive
versionthe current version of this class

Definition at line 74 of file CellLabel.hpp.

References mColour.

Friends And Related Symbol Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Needed for serialization.

Definition at line 66 of file CellLabel.hpp.

Member Data Documentation

◆ mColour

unsigned CellLabel::mColour
protected

Colour for use by visualizer.

Definition at line 61 of file CellLabel.hpp.

Referenced by GetColour(), and serialize().

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