Floating species group

Get information about floating species. More...

Functions
C_DECL_SPEC RRVectorPtr rrcCallConv	getFloatingSpeciesConcentrations (RRHandle handle)
	Retrieve in a vector the concentrations for all the floating species. More...
C_DECL_SPEC bool rrcCallConv	setFloatingSpeciesInitialConcentrationByIndex (RRHandle handle, int index, double value)
	Set the initial concentration for a particular floating species. More...
C_DECL_SPEC bool rrcCallConv	getFloatingSpeciesInitialConcentrationByIndex (RRHandle handle, int index, double *value)
	Get the initial concentration for a particular floating species. More...
C_DECL_SPEC bool rrcCallConv	setFloatingSpeciesByIndex (RRHandle handle, const int index, const double value)
	Set the concentration for a particular floating species. More...
C_DECL_SPEC bool rrcCallConv	getFloatingSpeciesByIndex (RRHandle handle, const int index, double *value)
	Retrieve the concentration for a particular floating species. More...
C_DECL_SPEC bool rrcCallConv	setFloatingSpeciesConcentrations (RRHandle handle, const RRVectorPtr vec)
	Set the floating species concentration to the vector vec. More...
C_DECL_SPEC int rrcCallConv	getNumberOfFloatingSpecies (RRHandle handle)
	Returns the number of floating species in the model. More...
C_DECL_SPEC int rrcCallConv	getNumberOfDependentSpecies (RRHandle handle)
	Returns the number of dependent species in the model. More...
C_DECL_SPEC int rrcCallConv	getNumberOfIndependentSpecies (RRHandle handle)
	Returns the number of independent species in the model. More...
C_DECL_SPEC RRStringArrayPtr rrcCallConv	getFloatingSpeciesIds (RRHandle handle)
	Obtain the list of floating species Id. More...
C_DECL_SPEC RRStringArrayPtr rrcCallConv	getFloatingSpeciesConcentrationIds (RRHandle handle)
	Obtain the list of floating species concentrations Id. More...

Detailed Description

Get information about floating species.

Function Documentation

getFloatingSpeciesByIndex()

C_DECL_SPEC bool rrcCallConv getFloatingSpeciesByIndex	(	RRHandle	handle,
		const int	index,
		double *	value
	)

Retrieve the concentration for a particular floating species.

Parameters

[in]	handle	Handle to a RoadRunner instance
	index	The index to the floating species (corresponds to position in getFloatingSpeciesIds(RRHandle handle))
	value	The value returned by the method

Returns

Returns true if successful

getFloatingSpeciesConcentrationIds()

C_DECL_SPEC RRStringArrayPtr rrcCallConv getFloatingSpeciesConcentrationIds

(

RRHandle

handle

)

Obtain the list of floating species concentrations Id.

Parameters

[in]

handle

Handle to a RoadRunner instance

Returns

Returns null if it fails, if successful it returns a pointer to a RRStringArrayPtr struct

getFloatingSpeciesConcentrations()

C_DECL_SPEC RRVectorPtr rrcCallConv getFloatingSpeciesConcentrations

(

RRHandle

handle

)

Retrieve in a vector the concentrations for all the floating species.

Example:

RRVectorPtr values = getFloatingSpeciesConcentrations (void); 

Parameters

[in]

handle

Handle to a RoadRunner instance

Returns

Returns the vector of floating species concentrations or null if an error occurred

getFloatingSpeciesIds()

C_DECL_SPEC RRStringArrayPtr rrcCallConv getFloatingSpeciesIds

(

RRHandle

handle

)

Obtain the list of floating species Id.

Parameters

[in]

handle

Handle to a RoadRunner instance

Returns

Returns null if it fails, if successful it returns a pointer to a RRStringArrayPtr struct

getFloatingSpeciesInitialConcentrationByIndex()

C_DECL_SPEC bool rrcCallConv getFloatingSpeciesInitialConcentrationByIndex	(	RRHandle	handle,
		int	index,
		double *	value
	)

Get the initial concentration for a particular floating species.

Parameters

[in]	handle	Handle to a RoadRunner instance
	index	The index to the floating species (corresponds to position in getFloatingSpeciesIds(RRHandle handle))
[in]	value	The concentration of the species

Returns

Returns true if successful

getNumberOfDependentSpecies()

C_DECL_SPEC int rrcCallConv getNumberOfDependentSpecies

(

RRHandle

handle

)

Returns the number of dependent species in the model.

Parameters

[in]

handle

Handle to a RoadRunner instance

getNumberOfFloatingSpecies()

C_DECL_SPEC int rrcCallConv getNumberOfFloatingSpecies

(

RRHandle

handle

)

Returns the number of floating species in the model.

Parameters

[in]

handle

Handle to a RoadRunner instance

getNumberOfIndependentSpecies()

C_DECL_SPEC int rrcCallConv getNumberOfIndependentSpecies

(

RRHandle

handle

)

Returns the number of independent species in the model.

Parameters

[in]

handle

Handle to a RoadRunner instance

setFloatingSpeciesByIndex()

C_DECL_SPEC bool rrcCallConv setFloatingSpeciesByIndex	(	RRHandle	handle,
		const int	index,
		const double	value
	)

Set the concentration for a particular floating species.

Parameters

[in]	handle	Handle to a RoadRunner instance
	index	The index to the floating species (corresponds to position in getFloatingSpeciesIds(RRHandle handle))
	value	The concentration of the species to set

Returns

Returns true if successful

setFloatingSpeciesConcentrations()

C_DECL_SPEC bool rrcCallConv setFloatingSpeciesConcentrations	(	RRHandle	handle,
		const RRVectorPtr	vec
	)

Set the floating species concentration to the vector vec.

Example:

myVector = createVector (getNumberOfFloatingSpecies(RRHandle handle));
setVectorElement (myVector, 0, 1.2);
setVectorElement (myVector, 1, 5.7);
setVectorElement (myVector, 2, 3.4);
setFloatingSpeciesConcentrations(myVector);

Parameters

[in]	handle	Handle to a RoadRunner instance
[in]	vec	Pointer to a RRVector

Returns

Returns true if successful

setFloatingSpeciesInitialConcentrationByIndex()

C_DECL_SPEC bool rrcCallConv setFloatingSpeciesInitialConcentrationByIndex	(	RRHandle	handle,
		int	index,
		double	value
	)

Set the initial concentration for a particular floating species.

Parameters

[in]	handle	Handle to a RoadRunner instance
	index	The index to the floating species (corresponds to position in getFloatingSpeciesIds(RRHandle handle))
	value	The concentration of the species to set

Returns

Returns true if successful