#include <AbstractCellPopulationEventWriter.hpp>

Inheritance diagram for AbstractCellPopulationEventWriter< ELEMENT_DIM, SPACE_DIM >:

Collaboration diagram for AbstractCellPopulationEventWriter< ELEMENT_DIM, SPACE_DIM >:

Public Member Functions
	AbstractCellPopulationEventWriter (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

virtual void	Visit (ImmersedBoundaryCellPopulation< SPACE_DIM > *pCellPopulation)=0

Public Member Functions inherited from AbstractCellBasedWriter< ELEMENT_DIM, SPACE_DIM >
	AbstractCellBasedWriter (const std::string &rFileName)

virtual	~AbstractCellBasedWriter ()

void	CloseFile ()

virtual void	OpenOutputFile (OutputFileHandler &rOutputFileHandler)

void	OpenOutputFileForAppend (OutputFileHandler &rOutputFileHandler)

virtual void	WriteTimeStamp ()

virtual void	WriteNewline ()

void	SetFileName (std::string fileName)

std::string	GetFileName ()

Public Member Functions inherited from Identifiable
virtual	~Identifiable ()

std::string	GetIdentifier () const

Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)

Friends
class	boost::serialization::access

Additional Inherited Members
Protected Attributes inherited from AbstractCellBasedWriter< ELEMENT_DIM, SPACE_DIM >
std::string	mFileName

out_stream	mpOutStream

Detailed Description

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
class AbstractCellPopulationEventWriter< 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 AbstractCellPopulationWriter is that writers inheriting from this class are NOT compatible with a RoundRobin loop, because they write information that needs to be collected from all processes, such as global counters for mutation states. These writers concentrate the information from all processes and then write it at each timestep for which output is required.

These writers also only write data when an event has occured since the last output step/

Definition at line 64 of file AbstractCellPopulationEventWriter.hpp.

Constructor & Destructor Documentation

◆ AbstractCellPopulationEventWriter()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

AbstractCellPopulationEventWriter< ELEMENT_DIM, SPACE_DIM >::AbstractCellPopulationEventWriter ( const std::string & rFileName )

Default constructor.

Parameters

rFileName the name of the file to write to.

Definition at line 39 of file AbstractCellPopulationEventWriter.cpp.

Member Function Documentation

◆ serialize()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

template<class Archive >

void AbstractCellPopulationEventWriter< ELEMENT_DIM, SPACE_DIM >::serialize	(	Archive &	archive,
		const unsigned int	version
	)

inlineprivate

Serialize the object and its member variables.

Parameters

archive	the archive
version	the current version of this class

Definition at line 76 of file AbstractCellPopulationEventWriter.hpp.

◆ Visit() [1/6]

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual void AbstractCellPopulationEventWriter< ELEMENT_DIM, SPACE_DIM >::Visit ( CaBasedCellPopulation< SPACE_DIM > * pCellPopulation )

pure virtual

Visit the population and write the data.

As this method is pure virtual, it must be overridden in subclasses.

Parameters

pCellPopulation a pointer to the CaBasedCellPopulation to visit.

Implemented in CellDivisionLocationsWriter< ELEMENT_DIM, SPACE_DIM >, and CellRemovalLocationsWriter< ELEMENT_DIM, SPACE_DIM >.

◆ Visit() [2/6]

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual void AbstractCellPopulationEventWriter< ELEMENT_DIM, SPACE_DIM >::Visit ( ImmersedBoundaryCellPopulation< SPACE_DIM > * pCellPopulation )

pure virtual

Visit the population and write the data.

As this method is pure virtual, it must be overridden in subclasses.

Parameters

pCellPopulation a pointer to the ImmersedBoundaryCellPopulation to visit.

Implemented in CellDivisionLocationsWriter< ELEMENT_DIM, SPACE_DIM >, and CellRemovalLocationsWriter< ELEMENT_DIM, SPACE_DIM >.

◆ Visit() [3/6]

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual void AbstractCellPopulationEventWriter< ELEMENT_DIM, SPACE_DIM >::Visit ( MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM > * pCellPopulation )

pure virtual

Visit the population and write the data.

As this method is pure virtual, it must be overridden in subclasses.

Parameters

pCellPopulation a pointer to the MeshBasedCellPopulation to visit.

Implemented in CellDivisionLocationsWriter< ELEMENT_DIM, SPACE_DIM >, and CellRemovalLocationsWriter< ELEMENT_DIM, SPACE_DIM >.

◆ Visit() [4/6]

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual void AbstractCellPopulationEventWriter< ELEMENT_DIM, SPACE_DIM >::Visit ( NodeBasedCellPopulation< SPACE_DIM > * pCellPopulation )

pure virtual

Visit the population and write the data.

As this method is pure virtual, it must be overridden in subclasses.

Parameters

pCellPopulation a pointer to the NodeBasedCellPopulation to visit.

Implemented in CellDivisionLocationsWriter< ELEMENT_DIM, SPACE_DIM >, and CellRemovalLocationsWriter< ELEMENT_DIM, SPACE_DIM >.

◆ Visit() [5/6]

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual void AbstractCellPopulationEventWriter< ELEMENT_DIM, SPACE_DIM >::Visit ( PottsBasedCellPopulation< SPACE_DIM > * pCellPopulation )

pure virtual

Visit the population and write the data.

As this method is pure virtual, it must be overridden in subclasses.

Parameters

pCellPopulation a pointer to the PottsBasedCellPopulation to visit.

Implemented in CellDivisionLocationsWriter< ELEMENT_DIM, SPACE_DIM >, and CellRemovalLocationsWriter< ELEMENT_DIM, SPACE_DIM >.

◆ Visit() [6/6]

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

virtual void AbstractCellPopulationEventWriter< ELEMENT_DIM, SPACE_DIM >::Visit ( VertexBasedCellPopulation< SPACE_DIM > * pCellPopulation )

pure virtual

Visit the population and write the data.

As this method is pure virtual, it must be overridden in subclasses.

Parameters

pCellPopulation a pointer to the VertexBasedCellPopulation to visit.

Implemented in CellDivisionLocationsWriter< ELEMENT_DIM, SPACE_DIM >, and CellRemovalLocationsWriter< ELEMENT_DIM, SPACE_DIM >.

◆ WriteHeader()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

void AbstractCellPopulationEventWriter< ELEMENT_DIM, SPACE_DIM >::WriteHeader ( AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > * pCellPopulation )

virtual

Write the header to file.

Parameters

pCellPopulation a pointer to the population to be written.

Definition at line 45 of file AbstractCellPopulationEventWriter.cpp.

Friends And Related Symbol Documentation

◆ boost::serialization::access

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

friend class boost::serialization::access

friend

Needed for serialization.

Definition at line 68 of file AbstractCellPopulationEventWriter.hpp.

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

cell_based/src/writers/population_event_writers/AbstractCellPopulationEventWriter.hpp
cell_based/src/writers/population_event_writers/AbstractCellPopulationEventWriter.cpp

Public Member Functions

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AbstractCellPopulationEventWriter()

Member Function Documentation

◆ serialize()

◆ Visit() [1/6]

◆ Visit() [2/6]

◆ Visit() [3/6]

◆ Visit() [4/6]

◆ Visit() [5/6]

◆ Visit() [6/6]

◆ WriteHeader()

Friends And Related Symbol Documentation

◆ boost::serialization::access