tfCSpecies.h File Reference

#include "tf_port_c.h"
#include "tfCStateVector.h"
#include "tfCParticle.h"

Include dependency graph for tfCSpecies.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	tfStateSpeciesHandle
	Handle to a state::Species instance. More...
struct	tfStateSpeciesListHandle
	Handle to a state::SpeciesList instance. More...
struct	tfStateSpeciesValueHandle
	Handle to a state::SpeciesValue instance. More...

Functions
HRESULT	tfStateSpecies_init (struct tfStateSpeciesHandle *handle)
	Initialize an instance.
HRESULT	tfStateSpecies_initS (struct tfStateSpeciesHandle *handle, const char *s)
	Initialize an instance.
HRESULT	tfStateSpecies_copy (struct tfStateSpeciesHandle *source, struct tfStateSpeciesHandle *destination)
	Copy an instance.
HRESULT	tfStateSpecies_destroy (struct tfStateSpeciesHandle *handle)
	Destroy an instance.
HRESULT	tfStateSpecies_getId (struct tfStateSpeciesHandle *handle, char **str, unsigned int *numChars)
	Get the species id.
HRESULT	tfStateSpecies_setId (struct tfStateSpeciesHandle *handle, const char *sid)
	Set the species id.
HRESULT	tfStateSpecies_getName (struct tfStateSpeciesHandle *handle, char **str, unsigned int *numChars)
	Get the species name.
HRESULT	tfStateSpecies_setName (struct tfStateSpeciesHandle *handle, const char *name)
	Set the species name.
HRESULT	tfStateSpecies_getSpeciesType (struct tfStateSpeciesHandle *handle, char **str, unsigned int *numChars)
	Get the species type.
HRESULT	tfStateSpecies_setSpeciesType (struct tfStateSpeciesHandle *handle, const char *sid)
	Set the species type.
HRESULT	tfStateSpecies_getCompartment (struct tfStateSpeciesHandle *handle, char **str, unsigned int *numChars)
	Get the species compartment.
HRESULT	tfStateSpecies_setCompartment (struct tfStateSpeciesHandle *handle, const char *sid)
	Set the species compartment.
HRESULT	tfStateSpecies_getInitialAmount (struct tfStateSpeciesHandle *handle, tfFloatP_t *value)
	Get the initial amount.
HRESULT	tfStateSpecies_setInitialAmount (struct tfStateSpeciesHandle *handle, tfFloatP_t value)
	Set the initial amount.
HRESULT	tfStateSpecies_getInitialConcentration (struct tfStateSpeciesHandle *handle, tfFloatP_t *value)
	Get the initial concentration.
HRESULT	tfStateSpecies_setInitialConcentration (struct tfStateSpeciesHandle *handle, tfFloatP_t value)
	Set the initial concentration.
HRESULT	tfStateSpecies_getSubstanceUnits (struct tfStateSpeciesHandle *handle, char **str, unsigned int *numChars)
	Get the substance units.
HRESULT	tfStateSpecies_setSubstanceUnits (struct tfStateSpeciesHandle *handle, const char *sid)
	Set the substance units.
HRESULT	tfStateSpecies_getSpatialSizeUnits (struct tfStateSpeciesHandle *handle, char **str, unsigned int *numChars)
	Get the spatial size units.
HRESULT	tfStateSpecies_setSpatialSizeUnits (struct tfStateSpeciesHandle *handle, const char *sid)
	Set the spatial size units.
HRESULT	tfStateSpecies_getUnits (struct tfStateSpeciesHandle *handle, char **str, unsigned int *numChars)
	Get the units.
HRESULT	tfStateSpecies_setUnits (struct tfStateSpeciesHandle *handle, const char *sname)
	Set the units.
HRESULT	tfStateSpecies_getHasOnlySubstanceUnits (struct tfStateSpeciesHandle *handle, bool *value)
	Get whether a species has only substance units.
HRESULT	tfStateSpecies_setHasOnlySubstanceUnits (struct tfStateSpeciesHandle *handle, bool value)
	Set whether a species has only substance units.
HRESULT	tfStateSpecies_getBoundaryCondition (struct tfStateSpeciesHandle *handle, bool *value)
	Get whether a species has a boundary condition.
HRESULT	tfStateSpecies_setBoundaryCondition (struct tfStateSpeciesHandle *handle, bool value)
	Set whether a species has a boundary condition.
HRESULT	tfStateSpecies_getCharge (struct tfStateSpeciesHandle *handle, int *charge)
	Get the species charge.
HRESULT	tfStateSpecies_setCharge (struct tfStateSpeciesHandle *handle, int value)
	Set the species charge.
HRESULT	tfStateSpecies_getConstant (struct tfStateSpeciesHandle *handle, bool *value)
	Get whether a species is constnat.
HRESULT	tfStateSpecies_setConstant (struct tfStateSpeciesHandle *handle, int value)
	Set whether a species is constnat.
HRESULT	tfStateSpecies_getConversionFactor (struct tfStateSpeciesHandle *handle, char **str, unsigned int *numChars)
	Get the species conversion factor.
HRESULT	tfStateSpecies_setConversionFactor (struct tfStateSpeciesHandle *handle, const char *sid)
	Set the species conversion factor.
HRESULT	tfStateSpecies_isSetId (struct tfStateSpeciesHandle *handle, bool *value)
	Test whether the species id is set.
HRESULT	tfStateSpecies_isSetName (struct tfStateSpeciesHandle *handle, bool *value)
	Test whether the species name is set.
HRESULT	tfStateSpecies_isSetSpeciesType (struct tfStateSpeciesHandle *handle, bool *value)
	Test whether the species type is set.
HRESULT	tfStateSpecies_isSetCompartment (struct tfStateSpeciesHandle *handle, bool *value)
	Test whether the species compartment is set.
HRESULT	tfStateSpecies_isSetInitialAmount (struct tfStateSpeciesHandle *handle, bool *value)
	Test whether the species initial amount is set.
HRESULT	tfStateSpecies_isSetInitialConcentration (struct tfStateSpeciesHandle *handle, bool *value)
	Test whether the species initial concentration is set.
HRESULT	tfStateSpecies_isSetSubstanceUnits (struct tfStateSpeciesHandle *handle, bool *value)
	Test whether the species substance units are set.
HRESULT	tfStateSpecies_isSetSpatialSizeUnits (struct tfStateSpeciesHandle *handle, bool *value)
	Test whether the species spatial size units are set.
HRESULT	tfStateSpecies_isSetUnits (struct tfStateSpeciesHandle *handle, bool *value)
	Test whether the species units are set.
HRESULT	tfStateSpecies_isSetCharge (struct tfStateSpeciesHandle *handle, bool *value)
	Test whether the species charge is set.
HRESULT	tfStateSpecies_isSetConversionFactor (struct tfStateSpeciesHandle *handle, bool *value)
	Test whether the species conversion factor is set.
HRESULT	tfStateSpecies_isSetConstant (struct tfStateSpeciesHandle *handle, bool *value)
	Test whether the species is constant.
HRESULT	tfStateSpecies_isSetBoundaryCondition (struct tfStateSpeciesHandle *handle, bool *value)
	Test whether the species boundary condition is set.
HRESULT	tfStateSpecies_isSetHasOnlySubstanceUnits (struct tfStateSpeciesHandle *handle, bool *value)
	Test whether a species has only substance units.
HRESULT	tfStateSpecies_unsetId (struct tfStateSpeciesHandle *handle)
	Unset the species id.
HRESULT	tfStateSpecies_unsetName (struct tfStateSpeciesHandle *handle)
	Unset the species name.
HRESULT	tfStateSpecies_unsetConstant (struct tfStateSpeciesHandle *handle)
	Unset the species constant flag.
HRESULT	tfStateSpecies_unsetSpeciesType (struct tfStateSpeciesHandle *handle)
	Unset the species type.
HRESULT	tfStateSpecies_unsetInitialAmount (struct tfStateSpeciesHandle *handle)
	Unset the species initial amount.
HRESULT	tfStateSpecies_unsetInitialConcentration (struct tfStateSpeciesHandle *handle)
	Unset the species initial concentration.
HRESULT	tfStateSpecies_unsetSubstanceUnits (struct tfStateSpeciesHandle *handle)
	Unset the species substance units.
HRESULT	tfStateSpecies_unsetSpatialSizeUnits (struct tfStateSpeciesHandle *handle)
	Unset the species spatial size units.
HRESULT	tfStateSpecies_unsetUnits (struct tfStateSpeciesHandle *handle)
	Unset the species units.
HRESULT	tfStateSpecies_unsetCharge (struct tfStateSpeciesHandle *handle)
	Unset the species charge.
HRESULT	tfStateSpecies_unsetConversionFactor (struct tfStateSpeciesHandle *handle)
	Unset the species conversion factor.
HRESULT	tfStateSpecies_unsetCompartment (struct tfStateSpeciesHandle *handle)
	Unset the species compartment.
HRESULT	tfStateSpecies_unsetBoundaryCondition (struct tfStateSpeciesHandle *handle)
	Unset the species boundary condition.
HRESULT	tfStateSpecies_unsetHasOnlySubstanceUnits (struct tfStateSpeciesHandle *handle)
	Unset the species has only substance units flag.
HRESULT	tfStateSpecies_hasRequiredAttributes (struct tfStateSpeciesHandle *handle, bool *value)
	Test whether a species has required attributes.
HRESULT	tfStateSpecies_toString (struct tfStateSpeciesHandle *handle, char **str, unsigned int *numChars)
	Get a JSON string representation.
HRESULT	tfStateSpecies_fromString (struct tfStateSpeciesHandle *handle, const char *str)
	Create from a JSON string representation.
HRESULT	tfStateSpeciesList_init (struct tfStateSpeciesListHandle *handle)
	Initialize an instance.
HRESULT	tfStateSpeciesList_destroy (struct tfStateSpeciesListHandle *handle)
	Destroy an instance.
HRESULT	tfStateSpeciesList_getStr (struct tfStateSpeciesListHandle *handle, char **str, unsigned int *numChars)
	Get a string representation.
HRESULT	tfStateSpeciesList_indexOf (struct tfStateSpeciesListHandle *handle, const char *s, unsigned int *i)
	Get the index of a species name.
HRESULT	tfStateSpeciesList_getSize (struct tfStateSpeciesListHandle *handle, unsigned int *size)
	Get the size of a list.
HRESULT	tfStateSpeciesList_getItem (struct tfStateSpeciesListHandle *handle, unsigned int index, struct tfStateSpeciesHandle *species)
	Get a species by index.
HRESULT	tfStateSpeciesList_getItemS (struct tfStateSpeciesListHandle *handle, const char *s, struct tfStateSpeciesHandle *species)
	Get a species by name.
HRESULT	tfStateSpeciesList_insert (struct tfStateSpeciesListHandle *handle, struct tfStateSpeciesHandle *species)
	Insert a species.
HRESULT	tfStateSpeciesList_insertS (struct tfStateSpeciesListHandle *handle, const char *s)
	Insert a species by name.
HRESULT	tfStateSpeciesList_toString (struct tfStateSpeciesListHandle *handle, char **str, unsigned int *numChars)
	Get a JSON string representation.
HRESULT	tfStateSpeciesList_fromString (struct tfStateSpeciesListHandle *handle, const char *str)
	Create from a JSON string representation.
HRESULT	tfStateSpeciesValue_init (struct tfStateSpeciesValueHandle *handle, struct tfStateStateVectorHandle *state_vector, unsigned int index)
	Initialize an instance.
HRESULT	tfStateSpeciesValue_getValue (struct tfStateSpeciesValueHandle *handle, tfFloatP_t *value)
	Get the value.
HRESULT	tfStateSpeciesValue_setValue (struct tfStateSpeciesValueHandle *handle, tfFloatP_t value)
	Set the value.
HRESULT	tfStateSpeciesValue_getStateVector (struct tfStateSpeciesValueHandle *handle, struct tfStateStateVectorHandle *state_vector)
	Get the state vector.
HRESULT	tfStateSpeciesValue_getIndex (struct tfStateSpeciesValueHandle *handle, unsigned int *index)
	Get the species index.
HRESULT	tfStateSpeciesValue_getSpecies (struct tfStateSpeciesValueHandle *handle, struct tfStateSpeciesHandle *species)
	Get the species.
HRESULT	tfStateSpeciesValue_getBoundaryCondition (struct tfStateSpeciesValueHandle *handle, bool *value)
	Test whether the species has a boundary condition.
HRESULT	tfStateSpeciesValue_setBoundaryCondition (struct tfStateSpeciesValueHandle *handle, bool value)
	Set whether the species has a boundary condition.
HRESULT	tfStateSpeciesValue_getInitialAmount (struct tfStateSpeciesValueHandle *handle, tfFloatP_t *value)
	Get the species initial amount.
HRESULT	tfStateSpeciesValue_setInitialAmount (struct tfStateSpeciesValueHandle *handle, tfFloatP_t value)
	Set the species initial amount.
HRESULT	tfStateSpeciesValue_getInitialConcentration (struct tfStateSpeciesValueHandle *handle, tfFloatP_t *value)
	Get the species initial concentration.
HRESULT	tfStateSpeciesValue_setInitialConcentration (struct tfStateSpeciesValueHandle *handle, tfFloatP_t value)
	Set the species initial concentration.
HRESULT	tfStateSpeciesValue_getConstant (struct tfStateSpeciesValueHandle *handle, bool *value)
	Test whether the species is constant.
HRESULT	tfStateSpeciesValue_setConstant (struct tfStateSpeciesValueHandle *handle, int value)
	Set whether the species is constant.
HRESULT	tfStateSpeciesValue_secreteL (struct tfStateSpeciesValueHandle *handle, tfFloatP_t amount, struct tfParticleListHandle *to, tfFloatP_t *secreted)
	Secrete this species into a neighborhood.
HRESULT	tfStateSpeciesValue_secreteD (struct tfStateSpeciesValueHandle *handle, tfFloatP_t amount, tfFloatP_t distance, tfFloatP_t *secreted)
	Secrete this species into a neighborhood.

Function Documentation

tfStateSpecies_copy()

HRESULT tfStateSpecies_copy	(	struct tfStateSpeciesHandle *	source,
		struct tfStateSpeciesHandle *	destination )

Copy an instance.

Parameters

source	populated handle
destination	handle to populate

Returns

S_OK on success

tfStateSpecies_destroy()

HRESULT tfStateSpecies_destroy

(

struct tfStateSpeciesHandle *

handle

)

Destroy an instance.

Parameters

handle

populated handle

Returns

S_OK on success

tfStateSpecies_fromString()

HRESULT tfStateSpecies_fromString	(	struct tfStateSpeciesHandle *	handle,
		const char *	str )

Create from a JSON string representation.

Returns

S_OK on success

tfStateSpecies_getBoundaryCondition()

HRESULT tfStateSpecies_getBoundaryCondition	(	struct tfStateSpeciesHandle *	handle,
		bool *	value )

Get whether a species has a boundary condition.

Parameters

handle	populated handle
value	flag signifying whether a species has a boundary condition

Returns

S_OK on success

tfStateSpecies_getCharge()

HRESULT tfStateSpecies_getCharge	(	struct tfStateSpeciesHandle *	handle,
		int *	charge )

Get the species charge.

Parameters

handle	populated handle
charge	species charge

Returns

S_OK on success

tfStateSpecies_getCompartment()

HRESULT tfStateSpecies_getCompartment	(	struct tfStateSpeciesHandle *	handle,
		char **	str,
		unsigned int *	numChars )

Get the species compartment.

Parameters

handle	populated handle
str	array to populate
numChars	number of array characters

Returns

S_OK on success

tfStateSpecies_getConstant()

HRESULT tfStateSpecies_getConstant	(	struct tfStateSpeciesHandle *	handle,
		bool *	value )

Get whether a species is constnat.

Parameters

handle	populated handle
value	flag signifying whether a species is constnat

Returns

S_OK on success

tfStateSpecies_getConversionFactor()

HRESULT tfStateSpecies_getConversionFactor	(	struct tfStateSpeciesHandle *	handle,
		char **	str,
		unsigned int *	numChars )

Get the species conversion factor.

Parameters

handle	populated handle
str	array to populate
numChars	number of array characters

Returns

S_OK on success

tfStateSpecies_getHasOnlySubstanceUnits()

HRESULT tfStateSpecies_getHasOnlySubstanceUnits	(	struct tfStateSpeciesHandle *	handle,
		bool *	value )

Get whether a species has only substance units.

Parameters

handle	populated handle
value	flag signifying whether a species has only substance units

Returns

S_OK on success

tfStateSpecies_getId()

HRESULT tfStateSpecies_getId	(	struct tfStateSpeciesHandle *	handle,
		char **	str,
		unsigned int *	numChars )

Get the species id.

Parameters

handle	populated handle
str	array to populate
numChars	number of array characters

Returns

S_OK on success

tfStateSpecies_getInitialAmount()

HRESULT tfStateSpecies_getInitialAmount	(	struct tfStateSpeciesHandle *	handle,
		tfFloatP_t *	value )

Get the initial amount.

Parameters

handle	populated handle
value	initial amount

Returns

S_OK on success

tfStateSpecies_getInitialConcentration()

HRESULT tfStateSpecies_getInitialConcentration	(	struct tfStateSpeciesHandle *	handle,
		tfFloatP_t *	value )

Get the initial concentration.

Parameters

handle	populated handle
value	initial concentration

Returns

S_OK on success

tfStateSpecies_getName()

HRESULT tfStateSpecies_getName	(	struct tfStateSpeciesHandle *	handle,
		char **	str,
		unsigned int *	numChars )

Get the species name.

Parameters

handle	populated handle
str	array to populate
numChars	number of array characters

Returns

S_OK on success

tfStateSpecies_getSpatialSizeUnits()

HRESULT tfStateSpecies_getSpatialSizeUnits	(	struct tfStateSpeciesHandle *	handle,
		char **	str,
		unsigned int *	numChars )

Get the spatial size units.

Parameters

handle	populated handle
str	array to populate
numChars	number of array characters

Returns

S_OK on success

tfStateSpecies_getSpeciesType()

HRESULT tfStateSpecies_getSpeciesType	(	struct tfStateSpeciesHandle *	handle,
		char **	str,
		unsigned int *	numChars )

Get the species type.

Parameters

handle	populated handle
str	array to populate
numChars	number of array character

Returns

S_OK on success

tfStateSpecies_getSubstanceUnits()

HRESULT tfStateSpecies_getSubstanceUnits	(	struct tfStateSpeciesHandle *	handle,
		char **	str,
		unsigned int *	numChars )

Get the substance units.

Parameters

handle	populated handle
str	array to populate
numChars	number of array characters

Returns

S_OK on success

tfStateSpecies_getUnits()

HRESULT tfStateSpecies_getUnits	(	struct tfStateSpeciesHandle *	handle,
		char **	str,
		unsigned int *	numChars )

Get the units.

Parameters

handle	populated handle
str	array to populate
numChars	number of array characters

Returns

S_OK on success

tfStateSpecies_hasRequiredAttributes()

HRESULT tfStateSpecies_hasRequiredAttributes	(	struct tfStateSpeciesHandle *	handle,
		bool *	value )

Test whether a species has required attributes.

Parameters

handle	populated handle
value	outcome of test

Returns

S_OK on success

tfStateSpecies_init()

HRESULT tfStateSpecies_init

(

struct tfStateSpeciesHandle *

handle

)

Initialize an instance.

Parameters

handle

handle to populate

Returns

S_OK on success

tfStateSpecies_initS()

HRESULT tfStateSpecies_initS	(	struct tfStateSpeciesHandle *	handle,
		const char *	s )

Initialize an instance.

Parameters

handle	handle to populate
s	string constructor

Returns

S_OK on success

tfStateSpecies_isSetBoundaryCondition()

HRESULT tfStateSpecies_isSetBoundaryCondition	(	struct tfStateSpeciesHandle *	handle,
		bool *	value )

Test whether the species boundary condition is set.

Parameters

handle	populated handle
value	outcome of test

Returns

S_OK on success

tfStateSpecies_isSetCharge()

HRESULT tfStateSpecies_isSetCharge	(	struct tfStateSpeciesHandle *	handle,
		bool *	value )

Test whether the species charge is set.

Parameters

handle	populated handle
value	outcome of test

Returns

S_OK on success

tfStateSpecies_isSetCompartment()

HRESULT tfStateSpecies_isSetCompartment	(	struct tfStateSpeciesHandle *	handle,
		bool *	value )

Test whether the species compartment is set.

Parameters

handle	populated handle
value	outcome of test

Returns

S_OK on success

tfStateSpecies_isSetConstant()

HRESULT tfStateSpecies_isSetConstant	(	struct tfStateSpeciesHandle *	handle,
		bool *	value )

Test whether the species is constant.

Parameters

handle	populated handle
value	outcome of test

Returns

S_OK on success

tfStateSpecies_isSetConversionFactor()

HRESULT tfStateSpecies_isSetConversionFactor	(	struct tfStateSpeciesHandle *	handle,
		bool *	value )

Test whether the species conversion factor is set.

Parameters

handle	populated handle
value	outcome of test

Returns

S_OK on success

tfStateSpecies_isSetHasOnlySubstanceUnits()

HRESULT tfStateSpecies_isSetHasOnlySubstanceUnits	(	struct tfStateSpeciesHandle *	handle,
		bool *	value )

Test whether a species has only substance units.

Parameters

handle	populated handle
value	outcome of test

Returns

S_OK on success

tfStateSpecies_isSetId()

HRESULT tfStateSpecies_isSetId	(	struct tfStateSpeciesHandle *	handle,
		bool *	value )

Test whether the species id is set.

Parameters

handle	populated handle
value	outcome of test

Returns

S_OK on success

tfStateSpecies_isSetInitialAmount()

HRESULT tfStateSpecies_isSetInitialAmount	(	struct tfStateSpeciesHandle *	handle,
		bool *	value )

Test whether the species initial amount is set.

Parameters

handle	populated handle
value	outcome of test

Returns

S_OK on success

tfStateSpecies_isSetInitialConcentration()

HRESULT tfStateSpecies_isSetInitialConcentration	(	struct tfStateSpeciesHandle *	handle,
		bool *	value )

Test whether the species initial concentration is set.

Parameters

handle	populated handle
value	outcome of test

Returns

S_OK on success

tfStateSpecies_isSetName()

HRESULT tfStateSpecies_isSetName	(	struct tfStateSpeciesHandle *	handle,
		bool *	value )

Test whether the species name is set.

Parameters

handle	populated handle
value	outcome of test

Returns

S_OK on success

tfStateSpecies_isSetSpatialSizeUnits()

HRESULT tfStateSpecies_isSetSpatialSizeUnits	(	struct tfStateSpeciesHandle *	handle,
		bool *	value )

Test whether the species spatial size units are set.

Parameters

handle	populated handle
value	outcome of test

Returns

S_OK on success

tfStateSpecies_isSetSpeciesType()

HRESULT tfStateSpecies_isSetSpeciesType	(	struct tfStateSpeciesHandle *	handle,
		bool *	value )

Test whether the species type is set.

Parameters

handle	populated handle
value	outcome of test

Returns

S_OK on success

tfStateSpecies_isSetSubstanceUnits()

HRESULT tfStateSpecies_isSetSubstanceUnits	(	struct tfStateSpeciesHandle *	handle,
		bool *	value )

Test whether the species substance units are set.

Parameters

handle	populated handle
value	outcome of test

Returns

S_OK on success

tfStateSpecies_isSetUnits()

HRESULT tfStateSpecies_isSetUnits	(	struct tfStateSpeciesHandle *	handle,
		bool *	value )

Test whether the species units are set.

Parameters

handle	populated handle
value	outcome of test

Returns

S_OK on success

tfStateSpecies_setBoundaryCondition()

HRESULT tfStateSpecies_setBoundaryCondition	(	struct tfStateSpeciesHandle *	handle,
		bool	value )

Set whether a species has a boundary condition.

Parameters

handle	populated handle
value	flag signifying whether a species has a boundary condition

Returns

S_OK on success

tfStateSpecies_setCharge()

HRESULT tfStateSpecies_setCharge	(	struct tfStateSpeciesHandle *	handle,
		int	value )

Set the species charge.

Parameters

handle	populated handle
value	species charge

Returns

S_OK on success

tfStateSpecies_setCompartment()

HRESULT tfStateSpecies_setCompartment	(	struct tfStateSpeciesHandle *	handle,
		const char *	sid )

Set the species compartment.

Parameters

handle	populated handle
sid	compartment string

Returns

S_OK on success

tfStateSpecies_setConstant()

HRESULT tfStateSpecies_setConstant	(	struct tfStateSpeciesHandle *	handle,
		int	value )

Set whether a species is constnat.

Parameters

handle	populated handle
value	flag signifying whether a species is constnat

Returns

S_OK on success

tfStateSpecies_setConversionFactor()

HRESULT tfStateSpecies_setConversionFactor	(	struct tfStateSpeciesHandle *	handle,
		const char *	sid )

Set the species conversion factor.

Parameters

handle	populated handle
sid	species conversion factor string

Returns

S_OK on success

tfStateSpecies_setHasOnlySubstanceUnits()

HRESULT tfStateSpecies_setHasOnlySubstanceUnits	(	struct tfStateSpeciesHandle *	handle,
		bool	value )

Set whether a species has only substance units.

Parameters

handle	populated handle
value	flag signifying whether a species has only substance units

Returns

S_OK on success

tfStateSpecies_setId()

HRESULT tfStateSpecies_setId	(	struct tfStateSpeciesHandle *	handle,
		const char *	sid )

Set the species id.

Parameters

handle	populated handle
sid	id string

Returns

S_OK on success

tfStateSpecies_setInitialAmount()

HRESULT tfStateSpecies_setInitialAmount	(	struct tfStateSpeciesHandle *	handle,
		tfFloatP_t	value )

Set the initial amount.

Parameters

handle	populated handle
value	initial amount

Returns

S_OK on success

tfStateSpecies_setInitialConcentration()

HRESULT tfStateSpecies_setInitialConcentration	(	struct tfStateSpeciesHandle *	handle,
		tfFloatP_t	value )

Set the initial concentration.

Parameters

handle	populated handle
value	initial concentration

Returns

S_OK on success

tfStateSpecies_setName()

HRESULT tfStateSpecies_setName	(	struct tfStateSpeciesHandle *	handle,
		const char *	name )

Set the species name.

Parameters

handle	populated handle
name	name string

Returns

S_OK on success

tfStateSpecies_setSpatialSizeUnits()

HRESULT tfStateSpecies_setSpatialSizeUnits	(	struct tfStateSpeciesHandle *	handle,
		const char *	sid )

Set the spatial size units.

Parameters

handle	populated handle
sid	spatial size units string

Returns

S_OK on success

tfStateSpecies_setSpeciesType()

HRESULT tfStateSpecies_setSpeciesType	(	struct tfStateSpeciesHandle *	handle,
		const char *	sid )

Set the species type.

Parameters

handle	populated handle
sid	type string

Returns

S_OK on success

tfStateSpecies_setSubstanceUnits()

HRESULT tfStateSpecies_setSubstanceUnits	(	struct tfStateSpeciesHandle *	handle,
		const char *	sid )

Set the substance units.

Parameters

handle	populated handle
sid	substance units string

Returns

S_OK on success

tfStateSpecies_setUnits()

HRESULT tfStateSpecies_setUnits	(	struct tfStateSpeciesHandle *	handle,
		const char *	sname )

Set the units.

Parameters

handle	populated handle
sname	units string

Returns

S_OK on success

tfStateSpecies_toString()

HRESULT tfStateSpecies_toString	(	struct tfStateSpeciesHandle *	handle,
		char **	str,
		unsigned int *	numChars )

Get a JSON string representation.

Parameters

handle	populated handle
str	string representation; can be used as an argument in a type particle factory
numChars	number of characters of string representation

Returns

S_OK on success

tfStateSpecies_unsetBoundaryCondition()

HRESULT tfStateSpecies_unsetBoundaryCondition

(

struct tfStateSpeciesHandle *

handle

)

Unset the species boundary condition.

Parameters

handle

populated handle

Returns

S_OK on success

tfStateSpecies_unsetCharge()

HRESULT tfStateSpecies_unsetCharge

(

struct tfStateSpeciesHandle *

handle

)

Unset the species charge.

Parameters

handle

populated handle

Returns

S_OK on success

tfStateSpecies_unsetCompartment()

HRESULT tfStateSpecies_unsetCompartment

(

struct tfStateSpeciesHandle *

handle

)

Unset the species compartment.

Parameters

handle

populated handle

Returns

S_OK on success

tfStateSpecies_unsetConstant()

HRESULT tfStateSpecies_unsetConstant

(

struct tfStateSpeciesHandle *

handle

)

Unset the species constant flag.

Parameters

handle

populated handle

Returns

S_OK on success

tfStateSpecies_unsetConversionFactor()

HRESULT tfStateSpecies_unsetConversionFactor

(

struct tfStateSpeciesHandle *

handle

)

Unset the species conversion factor.

Parameters

handle

populated handle

Returns

S_OK on success

tfStateSpecies_unsetHasOnlySubstanceUnits()

HRESULT tfStateSpecies_unsetHasOnlySubstanceUnits

(

struct tfStateSpeciesHandle *

handle

)

Unset the species has only substance units flag.

Parameters

handle

populated handle

Returns

S_OK on success

tfStateSpecies_unsetId()

HRESULT tfStateSpecies_unsetId

(

struct tfStateSpeciesHandle *

handle

)

Unset the species id.

Parameters

handle

populated handle

Returns

S_OK on success

tfStateSpecies_unsetInitialAmount()

HRESULT tfStateSpecies_unsetInitialAmount

(

struct tfStateSpeciesHandle *

handle

)

Unset the species initial amount.

Parameters

handle

populated handle

Returns

S_OK on success

tfStateSpecies_unsetInitialConcentration()

HRESULT tfStateSpecies_unsetInitialConcentration

(

struct tfStateSpeciesHandle *

handle

)

Unset the species initial concentration.

Parameters

handle

populated handle

Returns

S_OK on success

tfStateSpecies_unsetName()

HRESULT tfStateSpecies_unsetName

(

struct tfStateSpeciesHandle *

handle

)

Unset the species name.

Parameters

handle

populated handle

Returns

S_OK on success

tfStateSpecies_unsetSpatialSizeUnits()

HRESULT tfStateSpecies_unsetSpatialSizeUnits

(

struct tfStateSpeciesHandle *

handle

)

Unset the species spatial size units.

Parameters

handle

populated handle

Returns

S_OK on success

tfStateSpecies_unsetSpeciesType()

HRESULT tfStateSpecies_unsetSpeciesType

(

struct tfStateSpeciesHandle *

handle

)

Unset the species type.

Parameters

handle

populated handle

Returns

S_OK on success

tfStateSpecies_unsetSubstanceUnits()

HRESULT tfStateSpecies_unsetSubstanceUnits

(

struct tfStateSpeciesHandle *

handle

)

Unset the species substance units.

Parameters

handle

populated handle

Returns

S_OK on success

tfStateSpecies_unsetUnits()

HRESULT tfStateSpecies_unsetUnits

(

struct tfStateSpeciesHandle *

handle

)

Unset the species units.

Parameters

handle

populated handle

Returns

S_OK on success

tfStateSpeciesList_destroy()

HRESULT tfStateSpeciesList_destroy

(

struct tfStateSpeciesListHandle *

handle

)

Destroy an instance.

Parameters

handle

populated handle

Returns

S_OK on success

tfStateSpeciesList_fromString()

HRESULT tfStateSpeciesList_fromString	(	struct tfStateSpeciesListHandle *	handle,
		const char *	str )

Create from a JSON string representation.

Returns

S_OK on success

tfStateSpeciesList_getItem()

HRESULT tfStateSpeciesList_getItem	(	struct tfStateSpeciesListHandle *	handle,
		unsigned int	index,
		struct tfStateSpeciesHandle *	species )

Get a species by index.

Parameters

handle	populated handle
index	index of the species
species	species at the given index

Returns

S_OK on success

tfStateSpeciesList_getItemS()

HRESULT tfStateSpeciesList_getItemS	(	struct tfStateSpeciesListHandle *	handle,
		const char *	s,
		struct tfStateSpeciesHandle *	species )

Get a species by name.

Parameters

handle	populated handle
s	name of species
species	species at the given index

Returns

state::Species*

tfStateSpeciesList_getSize()

HRESULT tfStateSpeciesList_getSize	(	struct tfStateSpeciesListHandle *	handle,
		unsigned int *	size )

Get the size of a list.

Parameters

handle	populated handle
size	size of the list

Returns

S_OK on success

tfStateSpeciesList_getStr()

HRESULT tfStateSpeciesList_getStr	(	struct tfStateSpeciesListHandle *	handle,
		char **	str,
		unsigned int *	numChars )

Get a string representation.

Parameters

handle	populated handle
str	array to populate
numChars	number of array characters

Returns

S_OK on success

tfStateSpeciesList_indexOf()

HRESULT tfStateSpeciesList_indexOf	(	struct tfStateSpeciesListHandle *	handle,
		const char *	s,
		unsigned int *	i )

Get the index of a species name.

Parameters

handle	populated handle
s	species name
i	species index

Returns

S_OK on success

tfStateSpeciesList_init()

HRESULT tfStateSpeciesList_init

(

struct tfStateSpeciesListHandle *

handle

)

Initialize an instance.

Parameters

handle

handle to populate

Returns

S_OK on success

tfStateSpeciesList_insert()

HRESULT tfStateSpeciesList_insert	(	struct tfStateSpeciesListHandle *	handle,
		struct tfStateSpeciesHandle *	species )

Insert a species.

Parameters

handle	populated handle
species	species to insert

Returns

S_OK on success

tfStateSpeciesList_insertS()

HRESULT tfStateSpeciesList_insertS	(	struct tfStateSpeciesListHandle *	handle,
		const char *	s )

Insert a species by name.

Parameters

handle	populated handle
s	name of the species to insert

Returns

S_OK on success

tfStateSpeciesList_toString()

HRESULT tfStateSpeciesList_toString	(	struct tfStateSpeciesListHandle *	handle,
		char **	str,
		unsigned int *	numChars )

Get a JSON string representation.

Parameters

handle	populated handle
str	string representation; can be used as an argument in a type particle factory
numChars	number of characters of string representation

Returns

S_OK on success

tfStateSpeciesValue_getBoundaryCondition()

HRESULT tfStateSpeciesValue_getBoundaryCondition	(	struct tfStateSpeciesValueHandle *	handle,
		bool *	value )

Test whether the species has a boundary condition.

Parameters

handle	populated handle
value	flag signifying whether the species has a boundary condition

Returns

S_OK on success

tfStateSpeciesValue_getConstant()

HRESULT tfStateSpeciesValue_getConstant	(	struct tfStateSpeciesValueHandle *	handle,
		bool *	value )

Test whether the species is constant.

Parameters

handle	populated handle
value	flag signifying whether the species is constant

Returns

S_OK on success

tfStateSpeciesValue_getIndex()

HRESULT tfStateSpeciesValue_getIndex	(	struct tfStateSpeciesValueHandle *	handle,
		unsigned int *	index )

Get the species index.

Parameters

handle	populated handle
index	species index

Returns

S_OK on success

tfStateSpeciesValue_getInitialAmount()

HRESULT tfStateSpeciesValue_getInitialAmount	(	struct tfStateSpeciesValueHandle *	handle,
		tfFloatP_t *	value )

Get the species initial amount.

Parameters

handle	populated handle
value	initial amount

Returns

S_OK on success

tfStateSpeciesValue_getInitialConcentration()

HRESULT tfStateSpeciesValue_getInitialConcentration	(	struct tfStateSpeciesValueHandle *	handle,
		tfFloatP_t *	value )

Get the species initial concentration.

Parameters

handle	populated handle
value	initial concentration

Returns

S_OK on success

tfStateSpeciesValue_getSpecies()

HRESULT tfStateSpeciesValue_getSpecies	(	struct tfStateSpeciesValueHandle *	handle,
		struct tfStateSpeciesHandle *	species )

Get the species.

Parameters

handle	populated handle
species	handle to populate

Returns

S_OK on success

tfStateSpeciesValue_getStateVector()

HRESULT tfStateSpeciesValue_getStateVector	(	struct tfStateSpeciesValueHandle *	handle,
		struct tfStateStateVectorHandle *	state_vector )

Get the state vector.

Parameters

handle	populated handle
state_vector	state vector

Returns

S_OK on success

tfStateSpeciesValue_getValue()

HRESULT tfStateSpeciesValue_getValue	(	struct tfStateSpeciesValueHandle *	handle,
		tfFloatP_t *	value )

Get the value.

Parameters

handle	populated handle
value	species value

Returns

S_OK on success

tfStateSpeciesValue_init()

HRESULT tfStateSpeciesValue_init	(	struct tfStateSpeciesValueHandle *	handle,
		struct tfStateStateVectorHandle *	state_vector,
		unsigned int	index )

Initialize an instance.

Parameters

handle	handle to populate
value	species value
state_vector	state vector of species
index	species index in state vector

Returns

S_OK on success

tfStateSpeciesValue_secreteD()

HRESULT tfStateSpeciesValue_secreteD	(	struct tfStateSpeciesValueHandle *	handle,
		tfFloatP_t	amount,
		tfFloatP_t	distance,
		tfFloatP_t *	secreted )

Secrete this species into a neighborhood.

Parameters

handle	populated handle
amount	amount to secrete.
distance	neighborhood distance.
secreted	amount actually secreted, accounting for availability and other subtleties.

Returns

S_OK on success

tfStateSpeciesValue_secreteL()

HRESULT tfStateSpeciesValue_secreteL	(	struct tfStateSpeciesValueHandle *	handle,
		tfFloatP_t	amount,
		struct tfParticleListHandle *	to,
		tfFloatP_t *	secreted )

Secrete this species into a neighborhood.

Parameters

handle	populated handle
amount	amount to secrete.
to	list of particles to secrete to.
secreted	amount actually secreted, accounting for availability and other subtleties.

Returns

S_OK on success

tfStateSpeciesValue_setBoundaryCondition()

HRESULT tfStateSpeciesValue_setBoundaryCondition	(	struct tfStateSpeciesValueHandle *	handle,
		bool	value )

Set whether the species has a boundary condition.

Parameters

handle	populated handle
value	flag signifying whether the species has a boundary condition

Returns

S_OK on success

tfStateSpeciesValue_setConstant()

HRESULT tfStateSpeciesValue_setConstant	(	struct tfStateSpeciesValueHandle *	handle,
		int	value )

Set whether the species is constant.

Parameters

handle	populated handle
value	flag signifying whether the species is constant

Returns

S_OK on success

tfStateSpeciesValue_setInitialAmount()

HRESULT tfStateSpeciesValue_setInitialAmount	(	struct tfStateSpeciesValueHandle *	handle,
		tfFloatP_t	value )

Set the species initial amount.

Parameters

handle	populated handle
value	initial amount

Returns

S_OK on success

tfStateSpeciesValue_setInitialConcentration()

HRESULT tfStateSpeciesValue_setInitialConcentration	(	struct tfStateSpeciesValueHandle *	handle,
		tfFloatP_t	value )

Set the species initial concentration.

Parameters

handle	populated handle
value	initial concentration

Returns

S_OK on success

tfStateSpeciesValue_setValue()

HRESULT tfStateSpeciesValue_setValue	(	struct tfStateSpeciesValueHandle *	handle,
		tfFloatP_t	value )

Set the value.

Parameters

handle	populated handle
value	species value

Returns

S_OK on success