Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
LegacyCellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM > Class Template Reference

#include <LegacyCellProliferativeTypesWriter.hpp>

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

Public Member Functions

 LegacyCellProliferativeTypesWriter ()
 
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)
 
virtual c_vector< double, SPACE_DIM > GetVectorCellDataForVtkOutput (CellPtr pCell, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > *pCellPopulation)
 
bool GetOutputScalarData ()
 
bool GetOutputVectorData ()
 
void SetVtkCellDataName (std::string vtkCellDataName)
 
void SetVtkVectorCellDataName (std::string vtkCellDataName)
 
std::string GetVtkCellDataName ()
 
std::string GetVtkVectorCellDataName ()
 
- 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 >
bool mOutputScalarData
 
bool mOutputVectorData
 
std::string mVtkCellDataName
 
std::string mVtkVectorCellDataName
 
- 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 LegacyCellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM >

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

Note this version will overwitew cell color if the cell is lableled or mutant for use in the Java Vizialiser.

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 54 of file LegacyCellProliferativeTypesWriter.hpp.

Constructor & Destructor Documentation

◆ LegacyCellProliferativeTypesWriter()

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

Member Function Documentation

◆ GetCellDataForVtkOutput()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
double LegacyCellProliferativeTypesWriter< 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?

Reimplemented from AbstractCellWriter< ELEMENT_DIM, SPACE_DIM >.

Definition at line 51 of file LegacyCellProliferativeTypesWriter.cpp.

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

◆ serialize()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
template<class Archive >
void LegacyCellProliferativeTypesWriter< 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 66 of file LegacyCellProliferativeTypesWriter.hpp.

◆ VisitCell()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void LegacyCellProliferativeTypesWriter< 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 76 of file LegacyCellProliferativeTypesWriter.cpp.

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

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 58 of file LegacyCellProliferativeTypesWriter.hpp.


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