Chaste  Release::2017.1
AbstractCellProliferativeType Class Reference

#include <AbstractCellProliferativeType.hpp>

+ Inheritance diagram for AbstractCellProliferativeType:
+ Collaboration diagram for AbstractCellProliferativeType:

Public Member Functions

 AbstractCellProliferativeType (unsigned colour)
 
virtual ~AbstractCellProliferativeType ()
 
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
 

Private Member Functions

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

Private Attributes

unsigned mColour
 

Friends

class boost::serialization::access
 

Detailed Description

Base class for cell proliferative types.

Each Cell has a (shared pointer to a) proliferative type instance, which will be an instance of a subclass of this class. When setting up a CellBasedSimulation, the user must specify a list of AbstractCellProliferativeType instances, which represent the possible proliferative types that can occur in the simulation. This provides a registry of available proliferative types, and cells will point to one of these objects.

The proliferative type objects keep track of the number of cells with a proliferative type, as well as what colour should be used by the visualizer to display cells with each proliferative type.

Definition at line 58 of file AbstractCellProliferativeType.hpp.

Constructor & Destructor Documentation

AbstractCellProliferativeType::AbstractCellProliferativeType ( )
private

Default constructor needs to be defined for archiving, but never actually used, since subclasses call the normal constructor.

Definition at line 40 of file AbstractCellProliferativeType.cpp.

References NEVER_REACHED.

Referenced by serialize().

AbstractCellProliferativeType::AbstractCellProliferativeType ( unsigned  colour)

Constructor.

Parameters
colourwhat colour cells with this proliferative type should be in the visualizer

Definition at line 47 of file AbstractCellProliferativeType.cpp.

AbstractCellProliferativeType::~AbstractCellProliferativeType ( )
virtual

Virtual destructor, to make this class polymorphic.

Definition at line 53 of file AbstractCellProliferativeType.cpp.

Referenced by serialize().

Member Function Documentation

unsigned AbstractCellProliferativeType::GetColour ( ) const
Returns
mColour.

Definition at line 57 of file AbstractCellProliferativeType.cpp.

References mColour.

Referenced by serialize().

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

Archive the member variables.

Parameters
archivethe archive
versionthe current version of this class

Definition at line 76 of file AbstractCellProliferativeType.hpp.

References AbstractCellProliferativeType(), GetColour(), mColour, and ~AbstractCellProliferativeType().

Friends And Related Function Documentation

friend class boost::serialization::access
friend

Needed for serialization.

Definition at line 68 of file AbstractCellProliferativeType.hpp.

Member Data Documentation

unsigned AbstractCellProliferativeType::mColour
private

Colour for use by visualizer.

Definition at line 65 of file AbstractCellProliferativeType.hpp.

Referenced by GetColour(), and serialize().


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