Chaste  Release::3.4
Public Member Functions | Private Member Functions | Friends | List of all members
CellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM > Class Template Reference

#include <CellProliferativeTypesWriter.hpp>

+ Inheritance diagram for CellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM >:
+ Collaboration diagram for CellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM >:

Public Member Functions

 CellProliferativeTypesWriter ()
 
double GetCellDataForVtkOutput (CellPtr pCell, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *pCellPopulation)
 
virtual void VisitCell (CellPtr pCell, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *pCellPopulation)
 
- Public Member Functions inherited from AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >
 AbstractCellWriter (const std::string &rFileName)
 
void SetVtkCellDataName (std::string vtkCellDataName)
 
std::string GetVtkCellDataName ()
 
- 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 AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >
std::string mVtkCellDataName
 
- 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 CellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM >

A class written using the visitor pattern for writing cell proliferative types to file.

The output file is called results.vizcelltypes by default. If VTK is switched on, then the writer also specifies the VTK output for each cell, which is stored in the VTK cell data "Cell types" by default.

Definition at line 51 of file CellProliferativeTypesWriter.hpp.

Constructor & Destructor Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
CellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM >::CellProliferativeTypesWriter ( )

Default constructor.

Definition at line 40 of file CellProliferativeTypesWriter.cpp.

References AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >::mVtkCellDataName.

Member Function Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
double CellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM >::GetCellDataForVtkOutput ( CellPtr  pCell,
AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *  pCellPopulation 
)
virtual

Overridden GetCellDataForVtkOutput() method.

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

Parameters
pCella cell
pCellPopulationa pointer to the cell population owning the cell
Returns
data associated with the cell
Todo:
: replace this hard-coded 6 with the ApoptoticCellProperty member mColour?

Implements AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 47 of file CellProliferativeTypesWriter.cpp.

References CellPropertyCollection::GetProperties(), and CellPropertyCollection::GetProperty().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
template<class Archive >
void CellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM >::serialize ( Archive &  archive,
const unsigned int  version 
)
inlineprivate

Serialize the object and its member variables.

Parameters
archivethe archive
versionthe current version of this class

Definition at line 63 of file CellProliferativeTypesWriter.hpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void CellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM >::VisitCell ( CellPtr  pCell,
AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *  pCellPopulation 
)
virtual

Overridden VisitCell() method.

Visit a cell and write its proliferative type, as given by this property's member mColour.

Outputs a line of space-separated values of the form: ...[cell proliferative type] ...

Note that if the cell is undergoing apoptosis (i.e. has the property ApoptoticCellProperty), then the hard-coded value 6 is written. If instead the cell is labelled (i.e. has the property CellLabel), then this property's member mColour is instead written. Lastly, if the cell has a mutation state other than WildTypeCellMutationState, then this property's member mColour is instead written.

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

Parameters
pCella cell
pCellPopulationa pointer to the cell population owning the cell
Todo:
: replace this hard-coded 6 with the ApoptoticCellProperty member mColour? (#2512)

Implements AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 72 of file CellProliferativeTypesWriter.cpp.

References CellPropertyCollection::GetProperties(), and CellPropertyCollection::GetProperty().

Friends And Related Function Documentation

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

Needed for serialization.

Definition at line 55 of file CellProliferativeTypesWriter.hpp.

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