NullSrnModel Class Reference

#include <NullSrnModel.hpp>

Inheritance diagram for NullSrnModel:

Collaboration diagram for NullSrnModel:

Public Member Functions
	NullSrnModel ()
virtual	~NullSrnModel ()
void	SimulateToCurrentTime ()
AbstractSrnModel *	CreateSrnModel ()
Public Member Functions inherited from AbstractSrnModel
	AbstractSrnModel ()
virtual	~AbstractSrnModel ()
void	SetCell (CellPtr pCell)
virtual void	Initialise ()
virtual void	InitialiseDaughterCell ()
CellPtr	GetCell ()
void	SetSimulatedToTime (double simulatedToTime)
double	GetSimulatedToTime ()
virtual void	ResetForDivision ()
void	OutputSrnModelInfo (out_stream &rParamsFile)
virtual void	OutputSrnModelParameters (out_stream &rParamsFile)
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 AbstractSrnModel
CellPtr	mpCell
double	mSimulatedToTime

Detailed Description

This class contains a dummy/null sub-cellular reaction network (SRN) model that can be used for any cell-cycle models that do not have an SRN, or where the SRN is combined with the main cell-cycle model.

Definition at line 52 of file NullSrnModel.hpp.

Constructor & Destructor Documentation

NullSrnModel::NullSrnModel

(

)

Default constructor.

Creates an NullSrnModel and calls SetBirthTime() on the AbstractSrnModel to make sure that can be set 'back in time' for cells which did not divide at the current time.

Definition at line 42 of file NullSrnModel.cpp.

Referenced by CreateSrnModel().

NullSrnModel::~NullSrnModel ( )

virtual

Destructor.

Definition at line 47 of file NullSrnModel.cpp.

Member Function Documentation

AbstractSrnModel * NullSrnModel::CreateSrnModel ( )

virtual

Builder method to create new instances of the SRN model. Each concrete subclass must implement this method to create an instance of that subclass.

This method is called by Cell::Divide() to create a SRN model for the daughter cell. Note that the parent SRN model will have had ResetForDivision() called just before CreateSrnModel() is called, so performing an exact copy of the parent is suitable behaviour. Any daughter-cell-specific initialisation can be done in InitialiseDaughterCell().

Returns

new SRN model

Implements AbstractSrnModel.

Definition at line 59 of file NullSrnModel.cpp.

References AbstractSrnModel::mSimulatedToTime, NullSrnModel(), and AbstractSrnModel::SetSimulatedToTime().

template<class Archive >

void NullSrnModel::serialize ( Archive &  archive, const unsigned int  version  )

inlineprivate

Archive the srn model and member variables.

Parameters

archive	the archive
version	the current version of this class

Definition at line 65 of file NullSrnModel.hpp.

void NullSrnModel::SimulateToCurrentTime ( )

virtual

Simulate the SRN to the current time.

This should be overridden for each SRN type i.e. ODE based.

Implements AbstractSrnModel.

Definition at line 51 of file NullSrnModel.cpp.

References SimulationTime::GetTime(), SimulationTime::Instance(), and AbstractSrnModel::SetSimulatedToTime().

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Needed for serialization.

Definition at line 57 of file NullSrnModel.hpp.

---

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

• cell_based/src/cell/srn/NullSrnModel.hpp
• cell_based/src/cell/srn/NullSrnModel.cpp