AbstractCellWriter< ELEMENT_DIM, SPACE_DIM > Class Template Reference

#include <AbstractCellWriter.hpp>

Inherits AbstractCellBasedWriter< ELEMENT_DIM, SPACE_DIM >.

Inherited by CellAgesWriter< ELEMENT_DIM, SPACE_DIM >, CellAncestorWriter< ELEMENT_DIM, SPACE_DIM >, CellBetaCateninWriter< ELEMENT_DIM, SPACE_DIM >, CellCycleModelProteinConcentrationsWriter< ELEMENT_DIM, SPACE_DIM >, CellIdWriter< ELEMENT_DIM, SPACE_DIM >, CellLabelWriter< ELEMENT_DIM, SPACE_DIM >, CellLocationIndexWriter< ELEMENT_DIM, SPACE_DIM >, CellMutationStatesWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativePhasesWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM >, CellRadiusWriter< ELEMENT_DIM, SPACE_DIM >, and CellVolumesWriter< ELEMENT_DIM, SPACE_DIM >.

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

List of all members.

Public Member Functions

 AbstractCellWriter (const std::string &rFileName)
virtual double GetCellDataForVtkOutput (CellPtr pCell, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *pCellPopulation)=0
virtual void VisitCell (CellPtr pCell, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *pCellPopulation)=0
void SetVtkCellDataName (std::string vtkCellDataName)
std::string GetVtkCellDataName ()

Protected Attributes

std::string mVtkCellDataName

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 AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >

An abstract class for a writer that visits individual cells of a population and writes their data.

Definition at line 51 of file AbstractCellWriter.hpp.

Constructor & Destructor Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >::AbstractCellWriter ( const std::string &  rFileName  )  [inline]

Default constructor.

Parameters:
rFileName the name of the file to write to.

Definition at line 39 of file AbstractCellWriter.cpp.

Member Function Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
virtual double AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >::GetCellDataForVtkOutput ( CellPtr  pCell,
AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *  pCellPopulation 
) [pure virtual]

Get a double associated with a cell. This method reduces duplication of code between the methods VisitCell() and AddVtkData().

Parameters:
pCell a cell
pCellPopulation a pointer to the cell population owning the cell.
Returns:
data associated with the cell

Implemented in CellAgesWriter< ELEMENT_DIM, SPACE_DIM >, CellAncestorWriter< ELEMENT_DIM, SPACE_DIM >, CellCycleModelProteinConcentrationsWriter< ELEMENT_DIM, SPACE_DIM >, CellIdWriter< ELEMENT_DIM, SPACE_DIM >, CellLabelWriter< ELEMENT_DIM, SPACE_DIM >, CellLocationIndexWriter< ELEMENT_DIM, SPACE_DIM >, CellMutationStatesWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativePhasesWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM >, CellRadiusWriter< ELEMENT_DIM, SPACE_DIM >, CellVolumesWriter< ELEMENT_DIM, SPACE_DIM >, and CellBetaCateninWriter< ELEMENT_DIM, SPACE_DIM >.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
std::string AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >::GetVtkCellDataName (  )  [inline]
Returns:
the name of the cell data used in VTK output.

Definition at line 51 of file AbstractCellWriter.cpp.

References AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >::mVtkCellDataName.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
template<class Archive >
void AbstractCellWriter< 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 CellAgesWriter< ELEMENT_DIM, SPACE_DIM >, CellAncestorWriter< ELEMENT_DIM, SPACE_DIM >, CellCycleModelProteinConcentrationsWriter< ELEMENT_DIM, SPACE_DIM >, CellIdWriter< ELEMENT_DIM, SPACE_DIM >, CellLabelWriter< ELEMENT_DIM, SPACE_DIM >, CellLocationIndexWriter< ELEMENT_DIM, SPACE_DIM >, CellMutationStatesWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativePhasesWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM >, CellRadiusWriter< ELEMENT_DIM, SPACE_DIM >, CellVolumesWriter< ELEMENT_DIM, SPACE_DIM >, and CellBetaCateninWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 64 of file AbstractCellWriter.hpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >::SetVtkCellDataName ( std::string  vtkCellDataName  )  [inline]

Set the name of the cell data used in VTK output. This method allows the user to change mVtkCellDataName from its default value, which is set in each subclass's constructor.

Parameters:
vtkCellDataName the output file name

Definition at line 45 of file AbstractCellWriter.cpp.

References AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >::mVtkCellDataName.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
virtual void AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >::VisitCell ( CellPtr  pCell,
AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *  pCellPopulation 
) [pure virtual]

Visit a cell and write its data.

Parameters:
pCell a cell
pCellPopulation a pointer to the cell population owning the cell.

Implemented in CellAgesWriter< ELEMENT_DIM, SPACE_DIM >, CellAncestorWriter< ELEMENT_DIM, SPACE_DIM >, CellCycleModelProteinConcentrationsWriter< ELEMENT_DIM, SPACE_DIM >, CellIdWriter< ELEMENT_DIM, SPACE_DIM >, CellLabelWriter< ELEMENT_DIM, SPACE_DIM >, CellLocationIndexWriter< ELEMENT_DIM, SPACE_DIM >, CellMutationStatesWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativePhasesWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM >, CellRadiusWriter< ELEMENT_DIM, SPACE_DIM >, CellVolumesWriter< ELEMENT_DIM, SPACE_DIM >, and CellBetaCateninWriter< ELEMENT_DIM, SPACE_DIM >.

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 CellAgesWriter< ELEMENT_DIM, SPACE_DIM >, CellAncestorWriter< ELEMENT_DIM, SPACE_DIM >, CellCycleModelProteinConcentrationsWriter< ELEMENT_DIM, SPACE_DIM >, CellIdWriter< ELEMENT_DIM, SPACE_DIM >, CellLabelWriter< ELEMENT_DIM, SPACE_DIM >, CellLocationIndexWriter< ELEMENT_DIM, SPACE_DIM >, CellMutationStatesWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativePhasesWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM >, CellRadiusWriter< ELEMENT_DIM, SPACE_DIM >, CellVolumesWriter< ELEMENT_DIM, SPACE_DIM >, and CellBetaCateninWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 56 of file AbstractCellWriter.hpp.

Member Data Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
std::string AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >::mVtkCellDataName [protected]

The name of the cell data used in VTK output.

Definition at line 74 of file AbstractCellWriter.hpp.

Referenced by CellAgesWriter< ELEMENT_DIM, SPACE_DIM >::CellAgesWriter(), CellAncestorWriter< ELEMENT_DIM, SPACE_DIM >::CellAncestorWriter(), CellBetaCateninWriter< ELEMENT_DIM, SPACE_DIM >::CellBetaCateninWriter(), CellCycleModelProteinConcentrationsWriter< ELEMENT_DIM, SPACE_DIM >::CellCycleModelProteinConcentrationsWriter(), CellIdWriter< ELEMENT_DIM, SPACE_DIM >::CellIdWriter(), CellLabelWriter< ELEMENT_DIM, SPACE_DIM >::CellLabelWriter(), CellLocationIndexWriter< ELEMENT_DIM, SPACE_DIM >::CellLocationIndexWriter(), CellMutationStatesWriter< ELEMENT_DIM, SPACE_DIM >::CellMutationStatesWriter(), CellProliferativePhasesWriter< ELEMENT_DIM, SPACE_DIM >::CellProliferativePhasesWriter(), CellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM >::CellProliferativeTypesWriter(), CellRadiusWriter< ELEMENT_DIM, SPACE_DIM >::CellRadiusWriter(), CellVolumesWriter< ELEMENT_DIM, SPACE_DIM >::CellVolumesWriter(), AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >::GetVtkCellDataName(), and AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >::SetVtkCellDataName().

The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.2