CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM > Class Template Reference
#include <CellMutationStatesCountWriter.hpp>
Inherits AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.
Public Member Functions | |
| CellMutationStatesCountWriter () | |
| virtual void | WriteHeader (AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *pCellPopulation) |
| void | VisitAnyPopulation (AbstractCellPopulation< SPACE_DIM, SPACE_DIM > *pCellPopulation) |
| virtual void | Visit (MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM > *pCellPopulation) |
| virtual void | Visit (CaBasedCellPopulation< SPACE_DIM > *pCellPopulation) |
| virtual void | Visit (NodeBasedCellPopulation< SPACE_DIM > *pCellPopulation) |
| virtual void | Visit (PottsBasedCellPopulation< SPACE_DIM > *pCellPopulation) |
| virtual void | Visit (VertexBasedCellPopulation< 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 CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >
A class written using the visitor pattern for writing cell mutations states from a cell population to file.
Definition at line 45 of file CellMutationStatesCountWriter.hpp.
Constructor & Destructor Documentation
| CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::CellMutationStatesCountWriter | ( | ) | [inline] |
Default constructor.
Definition at line 45 of file CellMutationStatesCountWriter.cpp.
Member Function Documentation
| void CellMutationStatesCountWriter< 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 AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 57 of file CellMutationStatesCountWriter.hpp.
| void CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::Visit | ( | VertexBasedCellPopulation< SPACE_DIM > * | pCellPopulation | ) | [inline, virtual] |
Visit the population and write the data.
- Parameters:
-
pCellPopulation a pointer to the VertexBasedCellPopulation to visit.
Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 120 of file CellMutationStatesCountWriter.cpp.
References CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().
| void CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::Visit | ( | PottsBasedCellPopulation< SPACE_DIM > * | pCellPopulation | ) | [inline, virtual] |
Visit the population and write the data.
- Parameters:
-
pCellPopulation a pointer to the PottsBasedCellPopulation to visit.
Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 114 of file CellMutationStatesCountWriter.cpp.
References CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().
| void CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::Visit | ( | NodeBasedCellPopulation< SPACE_DIM > * | pCellPopulation | ) | [inline, virtual] |
Visit the population and write the data.
- Parameters:
-
pCellPopulation a pointer to the NodeBasedCellPopulation to visit.
Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 108 of file CellMutationStatesCountWriter.cpp.
References CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().
| void CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::Visit | ( | CaBasedCellPopulation< SPACE_DIM > * | pCellPopulation | ) | [inline, virtual] |
Visit the population and write the data.
- Parameters:
-
pCellPopulation a pointer to the CaBasedCellPopulation to visit.
Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 102 of file CellMutationStatesCountWriter.cpp.
References CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().
| void CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::Visit | ( | MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM > * | pCellPopulation | ) | [inline, virtual] |
Visit the population and write the data.
- Parameters:
-
pCellPopulation a pointer to the MeshBasedCellPopulation to visit.
Implements AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 88 of file CellMutationStatesCountWriter.cpp.
References PetscTools::AmMaster(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetCellMutationStateCount(), and AbstractCellBasedWriter< ELEMENT_DIM, SPACE_DIM >::mpOutStream.
| void CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation | ( | AbstractCellPopulation< SPACE_DIM, SPACE_DIM > * | pCellPopulation | ) | [inline] |
A general method for writing to any population.
- Parameters:
-
pCellPopulation the population to write
Definition at line 74 of file CellMutationStatesCountWriter.cpp.
References PetscTools::AmMaster(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetCellMutationStateCount(), and AbstractCellBasedWriter< ELEMENT_DIM, SPACE_DIM >::mpOutStream.
Referenced by CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::Visit().
| void CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::WriteHeader | ( | AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > * | pCellPopulation | ) | [inline, virtual] |
Overridden WriteHeader() method.
Write the header to file.
- Parameters:
-
pCellPopulation a pointer to the population to be written.
Reimplemented from AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 51 of file CellMutationStatesCountWriter.cpp.
References PetscTools::AmMaster(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetCellPropertyRegistry(), AbstractCellBasedWriter< ELEMENT_DIM, SPACE_DIM >::mpOutStream, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::SetDefaultCellMutationStateAndProliferativeTypeOrdering(), and AbstractCellBasedWriter< ELEMENT_DIM, SPACE_DIM >::WriteNewline().
Friends And Related Function Documentation
friend class boost::serialization::access [friend] |
Needed for serialization.
Reimplemented from AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 49 of file CellMutationStatesCountWriter.hpp.
The documentation for this class was generated from the following files:
- cell_based/src/population/writers/population_writers/CellMutationStatesCountWriter.hpp
- cell_based/src/population/writers/population_writers/CellMutationStatesCountWriter.cpp
