CellPropertyRegistry Class Reference

#include <CellPropertyRegistry.hpp>

Collaboration diagram for CellPropertyRegistry:

Public Member Functions
template<class SUBCLASS >
boost::shared_ptr < AbstractCellProperty >	Get ()
const std::vector < boost::shared_ptr < AbstractCellProperty > > &	rGetAllCellProperties ()
void	Clear ()
CellPropertyRegistry *	TakeOwnership ()
void	SpecifyOrdering (const std::vector< boost::shared_ptr< AbstractCellProperty > > &rOrdering)
bool	HasOrderingBeenSpecified ()
Static Public Member Functions
static CellPropertyRegistry *	Instance ()
Private Member Functions
	CellPropertyRegistry ()
	CellPropertyRegistry (const CellPropertyRegistry &)
CellPropertyRegistry &	operator= (const CellPropertyRegistry &)
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)
Private Attributes
std::vector< boost::shared_ptr < AbstractCellProperty > >	mCellProperties
bool	mOrderingHasBeenSpecified
Static Private Attributes
static CellPropertyRegistry *	mpInstance = NULL
Friends
class	boost::serialization::access

Detailed Description

A singleton registry of available cell properties.

Definition at line 44 of file CellPropertyRegistry.hpp.

Constructor & Destructor Documentation

CellPropertyRegistry::CellPropertyRegistry ( ) [private]

Default constructor.

Definition at line 56 of file CellPropertyRegistry.cpp.

CellPropertyRegistry::CellPropertyRegistry ( const CellPropertyRegistry & ) [private]

Copy constructor.

Member Function Documentation

void CellPropertyRegistry::Clear ( )

Clear all registered cell proeprties.

Definition at line 50 of file CellPropertyRegistry.cpp.

References mCellProperties, and mOrderingHasBeenSpecified.

Referenced by CryptCellsGenerator< CELL_CYCLE_MODEL >::Generate(), CellsGenerator< CELL_CYCLE_MODEL, DIM >::GenerateBasic(), CellsGenerator< CELL_CYCLE_MODEL, DIM >::GenerateBasicRandom(), CellsGenerator< CELL_CYCLE_MODEL, DIM >::GenerateGivenLocationIndices(), and AbstractCellBasedTestSuite::setUp().

template<class SUBCLASS >

boost::shared_ptr< AbstractCellProperty > CellPropertyRegistry::Get ( void ) [inline]

The main interface to this class: get a particular cell property object. Use like: boost::shared_ptr<AbstractCellProperty> p_property( CellPropertyRegistry::Instance()->Get<WildTypeCellMutationState>());

Definition at line 143 of file CellPropertyRegistry.hpp.

References mCellProperties.

Referenced by Cell::StartApoptosis().

bool CellPropertyRegistry::HasOrderingBeenSpecified ( )

Returns:: whether an ordering has been specified.

Definition at line 89 of file CellPropertyRegistry.cpp.

References mOrderingHasBeenSpecified.

CellPropertyRegistry * CellPropertyRegistry::Instance ( ) [static]

Get the single instance of the registry.

Definition at line 36 of file CellPropertyRegistry.cpp.

References mpInstance.

Referenced by CryptCellsGenerator< CELL_CYCLE_MODEL >::Generate(), CellsGenerator< CELL_CYCLE_MODEL, DIM >::GenerateBasic(), CellsGenerator< CELL_CYCLE_MODEL, DIM >::GenerateBasicRandom(), CellsGenerator< CELL_CYCLE_MODEL, DIM >::GenerateGivenLocationIndices(), CellPropertyCollection::GetCellPropertyRegistry(), AbstractCryptStatistics::LabelAllCellsAsHealthy(), AbstractCryptStatistics::LabelSPhaseCells(), AbstractCellBasedTestSuite::setUp(), ContactInhibitionCellCycleModel::UpdateCellCyclePhase(), and SimpleOxygenBasedCellCycleModel::UpdateHypoxicDuration().

CellPropertyRegistry& CellPropertyRegistry::operator= ( const CellPropertyRegistry & ) [private]

Overloaded assignment operator.

const std::vector< boost::shared_ptr< AbstractCellProperty > > & CellPropertyRegistry::rGetAllCellProperties ( )

Get a list of the cell properties registered.

Definition at line 45 of file CellPropertyRegistry.cpp.

References mCellProperties.

template<class Archive >

void CellPropertyRegistry::serialize	(	Archive &	archive,
		const unsigned int	version
	)			`[inline, private]`

Archive the member variables.

Parameters:

	archive	the archive
	version	the current version of this class

Definition at line 135 of file CellPropertyRegistry.hpp.

References mCellProperties, and mOrderingHasBeenSpecified.

void CellPropertyRegistry::SpecifyOrdering ( const std::vector< boost::shared_ptr< AbstractCellProperty > > & rOrdering )

Specify the ordering in which cell properties should be returned by rGetAllCellProperties(). The provided ordering must include all cell properties in the registry. Once an ordering has been specified, attempts to get a cell property which is not in the ordering will throw an exception.

Parameters:

rOrdering

vector of cell properties in the desired order

Definition at line 67 of file CellPropertyRegistry.cpp.

References EXCEPTION, mCellProperties, and mOrderingHasBeenSpecified.

CellPropertyRegistry * CellPropertyRegistry::TakeOwnership ( )

Take ownership of the current registry. Calling Instance after this will create a new registry. The caller takes responsibility for freeing the returned registry when finished with it.

This method is intended for use by CellBasedSimulation, so that we can have multiple concurrent simulations, each with their own registry.

Definition at line 61 of file CellPropertyRegistry.cpp.

References mpInstance.