CellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM > Class Template Reference
#include <CellProliferativeTypesWriter.hpp>
Inherits AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >.
Public Member Functions | |
| CellProliferativeTypesWriter () | |
| double | GetCellDataForVtkOutput (CellPtr pCell, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *pCellPopulation) |
| virtual void | VisitCell (CellPtr pCell, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *pCellPopulation) |
Private Member Functions | |
| template<class Archive > | |
| void | serialize (Archive &archive, const unsigned int version) |
Friends | |
| class | boost::serialization::access |
Detailed Description
template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
class CellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM >
A class written using the visitor pattern for writing cell proliferative types to file.
Definition at line 45 of file CellProliferativeTypesWriter.hpp.
Constructor & Destructor Documentation
| CellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM >::CellProliferativeTypesWriter | ( | ) | [inline] |
Default constructor.
Definition at line 40 of file CellProliferativeTypesWriter.cpp.
References AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >::mVtkCellDataName.
Member Function Documentation
| double CellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM >::GetCellDataForVtkOutput | ( | CellPtr | pCell, | |
| AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > * | pCellPopulation | |||
| ) | [inline, virtual] |
Overridden GetCellDataForVtkOutput() method.
Get a double associated with a cell. This method reduces duplication of code between the methods VisitCell() and AddVtkData().
- Parameters:
-
pCell a cell pCellPopulation a pointer to the cell population owning the cell
- Returns:
- data associated with the cell
- Todo:
- : replace this hard-coded 6 with the ApoptoticCellProperty member mColour?
Implements AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 47 of file CellProliferativeTypesWriter.cpp.
References CellPropertyCollection::GetProperty().
| void CellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM >::serialize | ( | Archive & | archive, | |
| const unsigned int | version | |||
| ) | [inline, private] |
Serialize the object and its member variables.
- Parameters:
-
archive the archive version the current version of this class
Reimplemented from AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 57 of file CellProliferativeTypesWriter.hpp.
| void CellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM >::VisitCell | ( | CellPtr | pCell, | |
| AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > * | pCellPopulation | |||
| ) | [inline, virtual] |
Overridden VisitCell() method.
Visit a cell and write its proliferative type, as given by this property's member mColour.
Outputs a line of space-separated values of the form: ...[cell proliferative type] ...
Note that if the cell is undergoing apoptosis (i.e. has the property ApoptoticCellProperty), then the hard-coded value 6 is written. If instead the cell is labelled (i.e. has the property CellLabel), then this property's member mColour is instead written. Lastly, if the cell has a mutation state other than WildTypeCellMutationState, then this property's member mColour is instead written.
This is appended to the output written by AbstractCellBasedWriter, which is a single value [present simulation time], followed by a tab.
- Parameters:
-
pCell a cell pCellPopulation a pointer to the cell population owning the cell
- Todo:
- : replace this hard-coded 6 with the ApoptoticCellProperty member mColour?
Implements AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 72 of file CellProliferativeTypesWriter.cpp.
References CellPropertyCollection::GetProperty(), and AbstractCellBasedWriter< ELEMENT_DIM, SPACE_DIM >::mpOutStream.
Friends And Related Function Documentation
friend class boost::serialization::access [friend] |
Needed for serialization.
Reimplemented from AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 49 of file CellProliferativeTypesWriter.hpp.
The documentation for this class was generated from the following files:
- cell_based/src/population/writers/cell_writers/CellProliferativeTypesWriter.hpp
- cell_based/src/population/writers/cell_writers/CellProliferativeTypesWriter.cpp
