AbstractCellMutationState Class Reference
#include <AbstractCellMutationState.hpp>
Public Member Functions | |
| AbstractCellMutationState (unsigned colour) | |
| virtual | ~AbstractCellMutationState () |
| unsigned | GetColour () const |
Private Member Functions | |
| template<class Archive> | |
| void | serialize (Archive &archive, const unsigned int version) |
| AbstractCellMutationState () | |
Private Attributes | |
| unsigned | mColour |
Friends | |
| class | boost::serialization::access |
Detailed Description
Base class for cell mutation states.Each Cell has a (shared pointer to a) mutation state instance, which will be an instance of a subclass of this class. When setting up a CellBasedSimulation, the user must specify a list of AbstractCellMutationState instances, which represent the possible mutations that can occur in the simulation (including WildTypeCellMutationState). This provides a registry of available mutation states, and cells will point to one of these objects.
The mutation state objects keep track of the number of cells in a given mutation state, as well as what colour should be used by the visualizer to display cells in each state.
Definition at line 50 of file AbstractCellMutationState.hpp.
Constructor & Destructor Documentation
| AbstractCellMutationState::AbstractCellMutationState | ( | ) | [private] |
Default constructor needs to be defined for archiving, but never actually used, since subclasses call the normal constructor.
Definition at line 32 of file AbstractCellMutationState.cpp.
References NEVER_REACHED.
| AbstractCellMutationState::AbstractCellMutationState | ( | unsigned | colour | ) |
Constructor.
- Parameters:
-
colour what colour cells with this mutation state should be in the visualizer
Definition at line 38 of file AbstractCellMutationState.cpp.
| AbstractCellMutationState::~AbstractCellMutationState | ( | ) | [virtual] |
Virtual destructor, to make this class polymorphic.
Definition at line 44 of file AbstractCellMutationState.cpp.
Member Function Documentation
| void AbstractCellMutationState::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.
Reimplemented in ApcOneHitCellMutationState, ApcTwoHitCellMutationState, BetaCateninOneHitCellMutationState, and WildTypeCellMutationState.
Definition at line 68 of file AbstractCellMutationState.hpp.
References mColour.
| unsigned AbstractCellMutationState::GetColour | ( | ) | const |
Friends And Related Function Documentation
friend class boost::serialization::access [friend] |
Needed for serialization.
Reimplemented from AbstractCellProperty.
Reimplemented in ApcOneHitCellMutationState, ApcTwoHitCellMutationState, BetaCateninOneHitCellMutationState, and WildTypeCellMutationState.
Definition at line 60 of file AbstractCellMutationState.hpp.
Member Data Documentation
unsigned AbstractCellMutationState::mColour [private] |
Colour for use by visualizer.
Definition at line 57 of file AbstractCellMutationState.hpp.
Referenced by GetColour(), and serialize().
The documentation for this class was generated from the following files:
- cell_based/src/population/cell/mutations/AbstractCellMutationState.hpp
- cell_based/src/population/cell/mutations/AbstractCellMutationState.cpp
