AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM > Class Template Reference

#include <AbstractCellPopulationWriter.hpp>

Inherits AbstractCellBasedWriter< 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 information from an AbstractCellPopulation and writes it to file.

The key difference between this class and AbstractCellPopulationCountWriter is that writers inheriting from this class ARE compatible with a RoundRobin loop. For such writers, each process can write its part of the information without knowing anything about the other processes as long as they are not interfering with the writing itself.

Definition at line 60 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 >.

Definition at line 72 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.

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.

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.

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.

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.

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.

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

Definition at line 64 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

AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM > Class Template Reference

Public Member Functions

Private Member Functions

Friends

Detailed Description

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM> class AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
class AbstractCellPopulationWriter< ELEMENT_DIM, SPACE_DIM >