Reaction group

Get information about reaction rates. More...

Functions
C_DECL_SPEC int rrcCallConv	getNumberOfReactions (RRHandle handle)
	Obtain the number of reactions in the loaded model. More...
C_DECL_SPEC bool rrcCallConv	getReactionRate (RRHandle handle, const int index, double *rate)
	Retrieve a give reaction rate as indicated by the index parameter. More...
C_DECL_SPEC RRVectorPtr rrcCallConv	getReactionRates (RRHandle handle)
	Retrieve a vector of reaction rates as determined by the current state of the model. More...
C_DECL_SPEC RRVectorPtr rrcCallConv	getReactionRatesEx (RRHandle handle, const RRVectorPtr vec)
	Retrieve a vector of reaction rates given a vector of species concentrations. More...
C_DECL_SPEC RRStringArrayPtr rrcCallConv	getReactionIds (RRHandle handle)
	Obtain the list of reaction Ids. More...

Detailed Description

Get information about reaction rates.

Function Documentation

getNumberOfReactions()

C_DECL_SPEC int rrcCallConv getNumberOfReactions

(

RRHandle

handle

)

Obtain the number of reactions in the loaded model.

Example:

number = getNumberOfReactions (RRHandle handle); 

Parameters

[in]

handle

Handle to a RoadRunner instance

Returns

Returns -1 if it fails, if successful it return 0 or more, indicating the number of reactions

getReactionIds()

C_DECL_SPEC RRStringArrayPtr rrcCallConv getReactionIds

(

RRHandle

handle

)

Obtain the list of reaction Ids.

Parameters

[in]

handle

Handle to a RoadRunner instance

Returns

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

getReactionRate()

C_DECL_SPEC bool rrcCallConv getReactionRate	(	RRHandle	handle,
		const int	index,
		double *	rate
	)

Retrieve a give reaction rate as indicated by the index parameter.

Parameters

[in]	handle	Handle to a RoadRunner instance
	index	- The index is used to specify which reaction rate to retrieve
	rate	- The reaction rate is returned in the rate argument

Returns

Returns false if it fails

getReactionRates()

C_DECL_SPEC RRVectorPtr rrcCallConv getReactionRates

(

RRHandle

handle

)

Retrieve a vector of reaction rates as determined by the current state of the model.

Parameters

[in]

handle

Handle to a RoadRunner instance

Returns

Returns null if it fails, otherwise it returns a vector of reaction rates

getReactionRatesEx()

C_DECL_SPEC RRVectorPtr rrcCallConv getReactionRatesEx	(	RRHandle	handle,
		const RRVectorPtr	vec
	)

Retrieve a vector of reaction rates given a vector of species concentrations.

Parameters

[in]	handle	Handle to a RoadRunner instance
	vec	The vector of floating species concentrations

Returns

Returns null if it fails otherwise it returns a vector of reaction rates