CellsGenerator< CELL_CYCLE_MODEL, DIM > Class Template Reference

#include <CellsGenerator.hpp>

List of all members.

Public Member Functions
void	GenerateBasic (std::vector< TissueCell > &rCells, unsigned numCells, const std::vector< unsigned > locationIndices=std::vector< unsigned >())
void	GenerateGivenLocationIndices (std::vector< TissueCell > &rCells, const std::vector< unsigned > locationIndices)

---

Detailed Description

template<class CELL_CYCLE_MODEL, unsigned DIM>
class CellsGenerator< CELL_CYCLE_MODEL, DIM >

A helper class for generating a vector of cells for a given mesh.

It is templated over types of cell cycle model and spatial dimension.

Definition at line 44 of file CellsGenerator.hpp.

---

Member Function Documentation

template<class CELL_CYCLE_MODEL , unsigned DIM>

void CellsGenerator< CELL_CYCLE_MODEL, DIM >::GenerateBasic	(	std::vector< TissueCell > &	rCells,
		unsigned	numCells,
		const std::vector< unsigned >	locationIndices = std::vector<unsigned>()
	)			[inline]

Fills a vector of cells with a specified cell cycle model, to match a given number of cells. Gives them birth times of 0 for node 0, -1 for node 1, -2 for node 2 etc...

Parameters:

	rCells	An empty vector of cells to fill up.
	numCells	The number of cells to generate.
	locationIndices	is used when a birth-time hint is needed for individual cell. Defaults to an empty vector -- otherwise must be of length numCells

Definition at line 75 of file CellsGenerator.hpp.

References CellMutationStateRegistry::Clear(), CellMutationStateRegistry::Instance(), and TissueCell::SetBirthTime().

template<class CELL_CYCLE_MODEL , unsigned DIM>

void CellsGenerator< CELL_CYCLE_MODEL, DIM >::GenerateGivenLocationIndices	(	std::vector< TissueCell > &	rCells,
		const std::vector< unsigned >	locationIndices
	)			[inline]

Fills a vector of cells with birth times to match a given vector of location indices.

Parameters:

	rCells	An empty vector of cells to fill up.
	locationIndices	The indices of the tissue to assign real cells to.

Definition at line 115 of file CellsGenerator.hpp.

References CellMutationStateRegistry::Clear(), CellMutationStateRegistry::Instance(), and TissueCell::SetBirthTime().

---

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

• /tmp/release_2.0/cell_based/src/tissue/cell/CellsGenerator.hpp