#include <CellPropertyCollection.hpp>

Collaboration diagram for CellPropertyCollection:

Public Types
typedef CollectionType::iterator	Iterator

Public Member Functions
	CellPropertyCollection ()

void	AddProperty (const boost::shared_ptr< AbstractCellProperty > &rProp)

CellPropertyRegistry *	GetCellPropertyRegistry ()

void	SetCellPropertyRegistry (CellPropertyRegistry *pRegistry)

bool	HasProperty (const boost::shared_ptr< AbstractCellProperty > &rProp) const

template<typename CLASS >
bool	HasProperty () const

template<typename BASECLASS >
bool	HasPropertyType () const

template<typename CLASS >
void	RemoveProperty ()

void	RemoveProperty (const boost::shared_ptr< AbstractCellProperty > &rProp)

unsigned	GetSize () const

Iterator	Begin ()

Iterator	End ()

boost::shared_ptr< AbstractCellProperty >	GetProperty () const

template<typename CLASS >
CellPropertyCollection	GetProperties () const

template<typename BASECLASS >
CellPropertyCollection	GetPropertiesType () const

Private Types
typedef std::set< boost::shared_ptr< AbstractCellProperty > >	CollectionType

typedef CollectionType::const_iterator	ConstIteratorType

typedef CollectionType::iterator	IteratorType

Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)

Private Attributes
CollectionType	mProperties

CellPropertyRegistry *	mpCellPropertyRegistry

Friends
class	boost::serialization::access

Detailed Description

Cell property collection class.

Contains methods for accessing and interrogating a set of cell properties.

Definition at line 55 of file CellPropertyCollection.hpp.

Member Typedef Documentation

typedef std::set<boost::shared_ptr<AbstractCellProperty> > CellPropertyCollection::CollectionType

private

The type of container used to store properties

Definition at line 59 of file CellPropertyCollection.hpp.

typedef CollectionType::const_iterator CellPropertyCollection::ConstIteratorType

private

Type of a const iterator over the container

Definition at line 62 of file CellPropertyCollection.hpp.

typedef CollectionType::iterator CellPropertyCollection::Iterator

An iterator type over this collection. Don't rely on the particular implementation of the iterator.

Definition at line 191 of file CellPropertyCollection.hpp.

typedef CollectionType::iterator CellPropertyCollection::IteratorType

private

Type of an iterator over the container

Definition at line 65 of file CellPropertyCollection.hpp.

Constructor & Destructor Documentation

CellPropertyCollection::CellPropertyCollection ( )

Create an empty collection of cell properties.

Definition at line 38 of file CellPropertyCollection.cpp.

Referenced by serialize().

Member Function Documentation

void CellPropertyCollection::AddProperty ( const boost::shared_ptr< AbstractCellProperty > & rProp )

Add a new property to this collection.

Parameters

rProp the property to add

Definition at line 61 of file CellPropertyCollection.cpp.

References EXCEPTION, HasProperty(), and mProperties.

Referenced by Cell::AddCellProperty(), Cell::Cell(), Cell::Divide(), GetProperties(), GetPropertiesType(), and serialize().

CellPropertyCollection::Iterator CellPropertyCollection::Begin ( )

Returns: an Iterator to the start of this collection.

Definition at line 93 of file CellPropertyCollection.cpp.

References mProperties.

Referenced by Cell::Cell(), Cell::Kill(), and Cell::RemoveCellProperty().

CellPropertyCollection::Iterator CellPropertyCollection::End ( )

Returns: an Iterator to one past the end of this collection.

Definition at line 98 of file CellPropertyCollection.cpp.

References mProperties.

Referenced by Cell::Cell(), Cell::Kill(), and Cell::RemoveCellProperty().

CellPropertyRegistry * CellPropertyCollection::GetCellPropertyRegistry ( )

Returns: a pointer to the CellPropertyRegistry (as assigned to this cell in the AbstractCellPopulation constructor).

Definition at line 43 of file CellPropertyCollection.cpp.

References CellPropertyRegistry::Instance(), and mpCellPropertyRegistry.

Referenced by serialize(), and Cell::StartApoptosis().

template<typename CLASS >

CellPropertyCollection CellPropertyCollection::GetProperties ( ) const

inline

Returns: a sub-collection containing all our properties that are instances of the given class.

Definition at line 214 of file CellPropertyCollection.hpp.

References AddProperty().

Referenced by CellLabelWriter< ELEMENT_DIM, SPACE_DIM >::GetCellDataForVtkOutput(), CellMutationStatesWriter< ELEMENT_DIM, SPACE_DIM >::GetCellDataForVtkOutput(), CellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM >::GetCellDataForVtkOutput(), CellMutationStatesWriter< ELEMENT_DIM, SPACE_DIM >::VisitCell(), CellLabelWriter< ELEMENT_DIM, SPACE_DIM >::VisitCell(), and CellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM >::VisitCell().

template<typename BASECLASS >

CellPropertyCollection CellPropertyCollection::GetPropertiesType ( ) const

inline

Returns: a sub-collection containing all our properties that are instances of the given class or any of its subclasses.

Definition at line 232 of file CellPropertyCollection.hpp.

References AddProperty().

Referenced by Cell::GetAncestor(), Cell::GetCellData(), Cell::GetCellId(), Cell::GetCellProliferativeType(), Cell::GetCellVecData(), Cell::GetMutationState(), and Cell::SetAncestor().

boost::shared_ptr< AbstractCellProperty > CellPropertyCollection::GetProperty ( ) const

Returns: If this collection contains a single property, then return it. Otherwise, throws an exception.

Definition at line 103 of file CellPropertyCollection.cpp.

References EXCEPTION, GetSize(), and mProperties.

Referenced by Cell::GetAncestor(), Cell::GetCellData(), CellMutationStatesWriter< ELEMENT_DIM, SPACE_DIM >::GetCellDataForVtkOutput(), CellLabelWriter< ELEMENT_DIM, SPACE_DIM >::GetCellDataForVtkOutput(), CellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM >::GetCellDataForVtkOutput(), Cell::GetCellId(), Cell::GetCellProliferativeType(), Cell::GetCellVecData(), Cell::GetMutationState(), CellMutationStatesWriter< ELEMENT_DIM, SPACE_DIM >::VisitCell(), CellLabelWriter< ELEMENT_DIM, SPACE_DIM >::VisitCell(), and CellProliferativeTypesWriter< ELEMENT_DIM, SPACE_DIM >::VisitCell().

unsigned CellPropertyCollection::GetSize ( ) const

Returns: the size of this container.

Definition at line 88 of file CellPropertyCollection.cpp.

References mProperties.

Referenced by Cell::GetAncestor(), Cell::GetCellData(), CellMutationStatesWriter< ELEMENT_DIM, SPACE_DIM >::GetCellDataForVtkOutput(), Cell::GetCellId(), Cell::GetCellProliferativeType(), Cell::GetCellVecData(), Cell::GetMutationState(), GetProperty(), RemoveProperty(), Cell::SetAncestor(), and CellMutationStatesWriter< ELEMENT_DIM, SPACE_DIM >::VisitCell().

bool CellPropertyCollection::HasProperty ( const boost::shared_ptr< AbstractCellProperty > & rProp ) const

Returns: whether this collection contains the given property object.

Parameters

rProp the property to compare against

Definition at line 70 of file CellPropertyCollection.cpp.

References mProperties.

Referenced by Cell::AddCellProperty(), Cell::Cell(), and Cell::HasCellProperty().

template<typename CLASS >

bool CellPropertyCollection::HasProperty ( ) const

inline

Returns: whether the collection contains a property that has the exact type CLASS.

Should be used like bool healthy = collection.HasProperty<WildTypeCellMutationState>();

Definition at line 127 of file CellPropertyCollection.hpp.

Referenced by AddProperty(), and serialize().

template<typename BASECLASS >

bool CellPropertyCollection::HasPropertyType ( ) const

inline

Returns: whether the collection contains a property that inherits from BASECLASS.

Should be used like collection.HasPropertyType<AbstractCellMutationState>();

Definition at line 146 of file CellPropertyCollection.hpp.

Referenced by Cell::Cell(), Cell::Divide(), and Cell::HasCellVecData().

template<typename CLASS >

void CellPropertyCollection::RemoveProperty ( )

inline

Remove a single property of the given type.

Definition at line 162 of file CellPropertyCollection.hpp.

References EXCEPTION, and GetSize().

Referenced by Cell::Divide(), MeshBasedCellPopulation< ELEMENT_DIM, SPACE_DIM >::DivideLongSprings(), Cell::RemoveCellProperty(), Cell::SetCellProliferativeType(), and Cell::SetMutationState().

void CellPropertyCollection::RemoveProperty ( const boost::shared_ptr< AbstractCellProperty > & rProp )

Remove the given property from this collection.

Parameters

rProp the property to remove

Definition at line 75 of file CellPropertyCollection.cpp.

References EXCEPTION, and mProperties.

template<class Archive >

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

inlineprivate

Save/load our member variables.

Parameters

archive	the archive
version	the current version of this class

Definition at line 82 of file CellPropertyCollection.hpp.

References AddProperty(), CellPropertyCollection(), GetCellPropertyRegistry(), HasProperty(), mProperties, and SetCellPropertyRegistry().

void CellPropertyCollection::SetCellPropertyRegistry ( CellPropertyRegistry * pRegistry )

Set the CellPropertyRegistry for this cell

Parameters

pRegistry The cell property registry (assigned in the AbstractCellPopulation constructor).

Definition at line 56 of file CellPropertyCollection.cpp.

References mpCellPropertyRegistry.

Referenced by serialize().

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Needed for serialization.

Definition at line 74 of file CellPropertyCollection.hpp.

Member Data Documentation

CellPropertyRegistry* CellPropertyCollection::mpCellPropertyRegistry

private

Cell property registry.

Definition at line 71 of file CellPropertyCollection.hpp.

Referenced by GetCellPropertyRegistry(), and SetCellPropertyRegistry().

CollectionType CellPropertyCollection::mProperties

private

The properties stored in this collection.

Definition at line 68 of file CellPropertyCollection.hpp.

Referenced by AddProperty(), Begin(), End(), GetProperty(), GetSize(), HasProperty(), RemoveProperty(), and serialize().

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

cell_based/src/cell/properties/CellPropertyCollection.hpp
cell_based/src/cell/properties/CellPropertyCollection.cpp

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation