AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM > Class Template Reference

#include <AbstractCellPopulationWriter.hpp>

Inherits AbstractCellBasedWriter< ELEMENT_DIM, SPACE_DIM >.

Inherited by BoundaryNodeWriter< ELEMENT_DIM, SPACE_DIM >, CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >, CellPopulationAreaWriter< ELEMENT_DIM, SPACE_DIM >, CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativePhasesCountWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativeTypesCountWriter< ELEMENT_DIM, SPACE_DIM >, NodeLocationWriter< ELEMENT_DIM, SPACE_DIM >, NodeVelocityWriter< ELEMENT_DIM, SPACE_DIM >, VertexT1SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >, VertexT2SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >, VertexT3SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >, and VoronoiDataWriter< ELEMENT_DIM, SPACE_DIM >.

Collaboration diagram for AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >:

[legend]

List of all members.

Public Member Functions
	AbstractCellPopulationWriter (const std::string &rFileName)
virtual void	WriteHeader (AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *pCellPopulation)
virtual void	Visit (MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM > *pCellPopulation)=0
virtual void	Visit (CaBasedCellPopulation< SPACE_DIM > *pCellPopulation)=0
virtual void	Visit (NodeBasedCellPopulation< SPACE_DIM > *pCellPopulation)=0
virtual void	Visit (PottsBasedCellPopulation< SPACE_DIM > *pCellPopulation)=0
virtual void	Visit (VertexBasedCellPopulation< SPACE_DIM > *pCellPopulation)=0
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 AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >

Abstract class for a writer that takes data from an AbstractCellPopulation and writes it to file.

Definition at line 55 of file AbstractCellPopulationWriter.hpp.

---

Constructor & Destructor Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >::AbstractCellPopulationWriter

(

const std::string &

rFileName

)

[inline]

Default constructor.

Parameters:

rFileName

the name of the file to write to.

Definition at line 44 of file AbstractCellPopulationWriter.cpp.

---

Member Function Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

template<class Archive >

void AbstractCellPopulationWriter< 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 AbstractCellBasedWriter< ELEMENT_DIM, SPACE_DIM >.

Reimplemented in BoundaryNodeWriter< ELEMENT_DIM, SPACE_DIM >, CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >, CellPopulationAreaWriter< ELEMENT_DIM, SPACE_DIM >, CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativePhasesCountWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativeTypesCountWriter< ELEMENT_DIM, SPACE_DIM >, NodeLocationWriter< ELEMENT_DIM, SPACE_DIM >, NodeVelocityWriter< ELEMENT_DIM, SPACE_DIM >, VertexT1SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >, VertexT2SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >, VertexT3SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >, and VoronoiDataWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 67 of file AbstractCellPopulationWriter.hpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual void AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >::Visit

(

VertexBasedCellPopulation< SPACE_DIM > *

pCellPopulation

)

[pure virtual]

Visit the population and write the data.

Parameters:

pCellPopulation

a pointer to the VertexBasedCellPopulation to visit.

Implemented in BoundaryNodeWriter< ELEMENT_DIM, SPACE_DIM >, CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >, CellPopulationAreaWriter< ELEMENT_DIM, SPACE_DIM >, CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativePhasesCountWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativeTypesCountWriter< ELEMENT_DIM, SPACE_DIM >, NodeLocationWriter< ELEMENT_DIM, SPACE_DIM >, NodeVelocityWriter< ELEMENT_DIM, SPACE_DIM >, VertexT1SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >, VertexT2SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >, VertexT3SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >, and VoronoiDataWriter< ELEMENT_DIM, SPACE_DIM >.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual void AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >::Visit

(

PottsBasedCellPopulation< SPACE_DIM > *

pCellPopulation

)

[pure virtual]

Visit the population and write the data.

Parameters:

pCellPopulation

a pointer to the PottsBasedCellPopulation to visit.

Implemented in BoundaryNodeWriter< ELEMENT_DIM, SPACE_DIM >, CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >, CellPopulationAreaWriter< ELEMENT_DIM, SPACE_DIM >, CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativePhasesCountWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativeTypesCountWriter< ELEMENT_DIM, SPACE_DIM >, NodeLocationWriter< ELEMENT_DIM, SPACE_DIM >, NodeVelocityWriter< ELEMENT_DIM, SPACE_DIM >, VertexT1SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >, VertexT2SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >, VertexT3SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >, and VoronoiDataWriter< ELEMENT_DIM, SPACE_DIM >.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual void AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >::Visit

(

NodeBasedCellPopulation< SPACE_DIM > *

pCellPopulation

)

[pure virtual]

Visit the population and write the data.

Parameters:

pCellPopulation

a pointer to the NodeBasedCellPopulation to visit.

Implemented in BoundaryNodeWriter< ELEMENT_DIM, SPACE_DIM >, CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >, CellPopulationAreaWriter< ELEMENT_DIM, SPACE_DIM >, CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativePhasesCountWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativeTypesCountWriter< ELEMENT_DIM, SPACE_DIM >, NodeLocationWriter< ELEMENT_DIM, SPACE_DIM >, NodeVelocityWriter< ELEMENT_DIM, SPACE_DIM >, VertexT1SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >, VertexT2SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >, VertexT3SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >, and VoronoiDataWriter< ELEMENT_DIM, SPACE_DIM >.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual void AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >::Visit

(

CaBasedCellPopulation< SPACE_DIM > *

pCellPopulation

)

[pure virtual]

Visit the population and write the data.

Parameters:

pCellPopulation

a pointer to the CaBasedCellPopulation to visit.

Implemented in BoundaryNodeWriter< ELEMENT_DIM, SPACE_DIM >, CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >, CellPopulationAreaWriter< ELEMENT_DIM, SPACE_DIM >, CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativePhasesCountWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativeTypesCountWriter< ELEMENT_DIM, SPACE_DIM >, NodeLocationWriter< ELEMENT_DIM, SPACE_DIM >, NodeVelocityWriter< ELEMENT_DIM, SPACE_DIM >, VertexT1SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >, VertexT2SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >, VertexT3SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >, and VoronoiDataWriter< ELEMENT_DIM, SPACE_DIM >.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual void AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >::Visit

(

MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM > *

pCellPopulation

)

[pure virtual]

Visit the population and write the data.

Parameters:

pCellPopulation

a pointer to the MeshBasedCellPopulation to visit.

Implemented in BoundaryNodeWriter< ELEMENT_DIM, SPACE_DIM >, CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >, CellPopulationAreaWriter< ELEMENT_DIM, SPACE_DIM >, CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativePhasesCountWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativeTypesCountWriter< ELEMENT_DIM, SPACE_DIM >, NodeLocationWriter< ELEMENT_DIM, SPACE_DIM >, NodeVelocityWriter< ELEMENT_DIM, SPACE_DIM >, VertexT1SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >, VertexT2SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >, VertexT3SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >, and VoronoiDataWriter< ELEMENT_DIM, SPACE_DIM >.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >::WriteHeader

(

AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *

pCellPopulation

)

[inline, virtual]

Write the header to file.

Parameters:

pCellPopulation

a pointer to the population to be written.

Reimplemented in CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 50 of file AbstractCellPopulationWriter.cpp.

---

Friends And Related Function Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

friend class boost::serialization::access [friend]

Needed for serialization.

Reimplemented from AbstractCellBasedWriter< ELEMENT_DIM, SPACE_DIM >.

Reimplemented in BoundaryNodeWriter< ELEMENT_DIM, SPACE_DIM >, CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >, CellPopulationAreaWriter< ELEMENT_DIM, SPACE_DIM >, CellPopulationElementWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativePhasesCountWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativeTypesCountWriter< ELEMENT_DIM, SPACE_DIM >, NodeLocationWriter< ELEMENT_DIM, SPACE_DIM >, NodeVelocityWriter< ELEMENT_DIM, SPACE_DIM >, VertexT1SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >, VertexT2SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >, VertexT3SwapLocationsWriter< ELEMENT_DIM, SPACE_DIM >, and VoronoiDataWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 59 of file AbstractCellPopulationWriter.hpp.

---

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

• cell_based/src/population/writers/population_writers/AbstractCellPopulationWriter.hpp
• cell_based/src/population/writers/population_writers/AbstractCellPopulationWriter.cpp