#include <AbstractCellPopulationCountWriter.hpp>
Inheritance diagram for AbstractCellPopulationCountWriter< ELEMENT_DIM, SPACE_DIM >: Collaboration diagram for AbstractCellPopulationCountWriter< ELEMENT_DIM, SPACE_DIM >:Public Member Functions | |
| AbstractCellPopulationCountWriter (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 |
| 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 AbstractCellPopulationCountWriter< 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.
Definition at line 61 of file AbstractCellPopulationCountWriter.hpp.
Constructor & Destructor Documentation
| AbstractCellPopulationCountWriter< ELEMENT_DIM, SPACE_DIM >::AbstractCellPopulationCountWriter | ( | const std::string & | rFileName | ) |
Default constructor.
- Parameters
-
rFileName the name of the file to write to.
Definition at line 41 of file AbstractCellPopulationCountWriter.cpp.
Member Function Documentation
|
inlineprivate |
Serialize the object and its member variables.
- Parameters
-
archive the archive version the current version of this class
Definition at line 73 of file AbstractCellPopulationCountWriter.hpp.
|
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 CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativePhasesCountWriter< ELEMENT_DIM, SPACE_DIM >, and CellProliferativeTypesCountWriter< ELEMENT_DIM, SPACE_DIM >.
|
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 CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativePhasesCountWriter< ELEMENT_DIM, SPACE_DIM >, and CellProliferativeTypesCountWriter< ELEMENT_DIM, SPACE_DIM >.
|
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 CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativePhasesCountWriter< ELEMENT_DIM, SPACE_DIM >, and CellProliferativeTypesCountWriter< ELEMENT_DIM, SPACE_DIM >.
|
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 CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativePhasesCountWriter< ELEMENT_DIM, SPACE_DIM >, and CellProliferativeTypesCountWriter< ELEMENT_DIM, SPACE_DIM >.
|
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 CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >, CellProliferativePhasesCountWriter< ELEMENT_DIM, SPACE_DIM >, and CellProliferativeTypesCountWriter< ELEMENT_DIM, SPACE_DIM >.
|
virtual |
Write the header to file.
- Parameters
-
pCellPopulation a pointer to the population to be written.
Reimplemented in CellMutationStatesCountWriter< ELEMENT_DIM, SPACE_DIM >.
Definition at line 47 of file AbstractCellPopulationCountWriter.cpp.
Friends And Related Function Documentation
|
friend |
Needed for serialization.
Definition at line 65 of file AbstractCellPopulationCountWriter.hpp.
The documentation for this class was generated from the following files:
- cell_based/src/writers/population_count_writers/AbstractCellPopulationCountWriter.hpp
- cell_based/src/writers/population_count_writers/AbstractCellPopulationCountWriter.cpp
