TissueForge::state::SpeciesValue Struct Reference

A working valued-object of an underlying Species attached to an object. More...

#include <tfSpeciesValue.h>

Collaboration diagram for TissueForge::state::SpeciesValue:

Public Member Functions
TissueForge::state::Species *	species ()
FloatP_t	getValue () const
void	setValue (const FloatP_t &_value)
bool	getBoundaryCondition ()
int	setBoundaryCondition (const int &value)
FloatP_t	getInitialAmount ()
int	setInitialAmount (const FloatP_t &value)
FloatP_t	getInitialConcentration ()
int	setInitialConcentration (const FloatP_t &value)
bool	getConstant ()
int	setConstant (const int &value)
FloatP_t	secrete (const FloatP_t &amount, const TissueForge::ParticleList &to)
	Secrete this species into a neighborhood.
FloatP_t	secrete (const FloatP_t &amount, const FloatP_t &distance)
	Secrete this species into a neighborhood.
	SpeciesValue (struct TissueForge::state::StateVector *state_vector, uint32_t index)

Public Attributes
struct TissueForge::state::StateVector *	state_vector
uint32_t	index

Detailed Description

A working valued-object of an underlying Species attached to an object.

Member Function Documentation

secrete() [1/2]

FloatP_t TissueForge::state::SpeciesValue::secrete	(	const FloatP_t &	amount,
		const FloatP_t &	distance )

Secrete this species into a neighborhood.

Parameters

amount	Amount to secrete.
distance	Neighborhood distance.

Returns

FloatP_t Amount actually secreted, accounting for availability and other subtleties.

secrete() [2/2]

FloatP_t TissueForge::state::SpeciesValue::secrete	(	const FloatP_t &	amount,
		const TissueForge::ParticleList &	to )

Secrete this species into a neighborhood.

Parameters

amount	Amount to secrete.
to	List of particles to secrete to.

Returns

FloatP_t Amount actually secreted, accounting for availability and other subtleties.

---

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

• source/state/tfSpeciesValue.h