CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM > Class Template Reference

#include <CellMutationStatesCountWriter.hpp>

Inherits AbstractCellPopulationCountWriter< ELEMENT_DIM, SPACE_DIM >.

Collaboration diagram for CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >:
Collaboration graph
[legend]

List of all members.

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

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::CellMutationStatesCountWriter (  )  [inline]

Default constructor.

Definition at line 45 of file CellMutationStatesCountWriter.cpp.


Member Function Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
template<class Archive >
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 AbstractCellPopulationCountWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 57 of file CellMutationStatesCountWriter.hpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::Visit ( VertexBasedCellPopulation< SPACE_DIM > *  pCellPopulation  )  [inline, virtual]

Visit the population and write the number of cells in the population that have each mutation state.

Outputs a line of tab-separated values of the form: [num mutation state 0] [num mutation state 1] [num mutation state 2] ...

where [num mutation state 0] denotes the number of cells in the population that have the mutation state with index 0 in the registry of cell properties, and so on. These counts are computed through the cell population method GetCellMutationStateCount(). The ordering of mutation states is usually specified by the cell population method SetDefaultCellMutationStateAndProliferativeTypeOrdering().

This line is appended to the output written by AbstractCellBasedWriter, which is a single value [present simulation time], followed by a tab.

Parameters:
pCellPopulation a pointer to the VertexBasedCellPopulation to visit.

Implements AbstractCellPopulationCountWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 120 of file CellMutationStatesCountWriter.cpp.

References CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::Visit ( PottsBasedCellPopulation< SPACE_DIM > *  pCellPopulation  )  [inline, virtual]

Visit the population and write the number of cells in the population that have each mutation state.

Outputs a line of tab-separated values of the form: [num mutation state 0] [num mutation state 1] [num mutation state 2] ...

where [num mutation state 0] denotes the number of cells in the population that have the mutation state with index 0 in the registry of cell properties, and so on. These counts are computed through the cell population method GetCellMutationStateCount(). The ordering of mutation states is usually specified by the cell population method SetDefaultCellMutationStateAndProliferativeTypeOrdering().

This line is appended to the output written by AbstractCellBasedWriter, which is a single value [present simulation time], followed by a tab.

Parameters:
pCellPopulation a pointer to the PottsBasedCellPopulation to visit.

Implements AbstractCellPopulationCountWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 114 of file CellMutationStatesCountWriter.cpp.

References CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::Visit ( NodeBasedCellPopulation< SPACE_DIM > *  pCellPopulation  )  [inline, virtual]

Visit the population and write the number of cells in the population that have each mutation state.

Outputs a line of tab-separated values of the form: [num mutation state 0] [num mutation state 1] [num mutation state 2] ...

where [num mutation state 0] denotes the number of cells in the population that have the mutation state with index 0 in the registry of cell properties, and so on. These counts are computed through the cell population method GetCellMutationStateCount(). The ordering of mutation states is usually specified by the cell population method SetDefaultCellMutationStateAndProliferativeTypeOrdering().

This line is appended to the output written by AbstractCellBasedWriter, which is a single value [present simulation time], followed by a tab.

Parameters:
pCellPopulation a pointer to the NodeBasedCellPopulation to visit.

Implements AbstractCellPopulationCountWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 108 of file CellMutationStatesCountWriter.cpp.

References CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::Visit ( CaBasedCellPopulation< SPACE_DIM > *  pCellPopulation  )  [inline, virtual]

Visit the population and write the number of cells in the population that have each mutation state.

Outputs a line of tab-separated values of the form: [num mutation state 0] [num mutation state 1] [num mutation state 2] ...

where [num mutation state 0] denotes the number of cells in the population that have the mutation state with index 0 in the registry of cell properties, and so on. These counts are computed through the cell population method GetCellMutationStateCount(). The ordering of mutation states is usually specified by the cell population method SetDefaultCellMutationStateAndProliferativeTypeOrdering().

This line is appended to the output written by AbstractCellBasedWriter, which is a single value [present simulation time], followed by a tab.

Parameters:
pCellPopulation a pointer to the CaBasedCellPopulation to visit.

Implements AbstractCellPopulationCountWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 102 of file CellMutationStatesCountWriter.cpp.

References CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::Visit ( MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM > *  pCellPopulation  )  [inline, virtual]

Visit the population and write the number of cells in the population that have each mutation state.

Outputs a line of tab-separated values of the form: [num mutation state 0] [num mutation state 1] [num mutation state 2] ...

where [num mutation state 0] denotes the number of cells in the population that have the mutation state with index 0 in the registry of cell properties, and so on. These counts are computed through the cell population method GetCellMutationStateCount(). The ordering of mutation states is usually specified by the cell population method SetDefaultCellMutationStateAndProliferativeTypeOrdering().

This line is appended to the output written by AbstractCellBasedWriter, which is a single value [present simulation time], followed by a tab.

Parameters:
pCellPopulation a pointer to the MeshBasedCellPopulation to visit.

Implements AbstractCellPopulationCountWriter< 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.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::VisitAnyPopulation ( AbstractCellPopulation< SPACE_DIM, SPACE_DIM > *  pCellPopulation  )  [inline]
template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >::WriteHeader ( AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *  pCellPopulation  )  [inline, virtual]

Friends And Related Function Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
friend class boost::serialization::access [friend]

Needed for serialization.

Reimplemented from AbstractCellPopulationCountWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 49 of file CellMutationStatesCountWriter.hpp.


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

Generated by  doxygen 1.6.2