Rates of change group

Get information about rates of change. More...

Functions
C_DECL_SPEC RRVectorPtr rrcCallConv	getRatesOfChange (RRHandle handle)
	Retrieve the vector of rates of change as determined by the current state of the model. More...
C_DECL_SPEC RRStringArrayPtr rrcCallConv	getRatesOfChangeIds (RRHandle handle)
	Retrieve the string list of rates of change Ids. More...
C_DECL_SPEC bool rrcCallConv	getRateOfChange (RRHandle handle, const int, double *value)
	Retrieve the rate of change for a given floating species. More...
C_DECL_SPEC RRVectorPtr rrcCallConv	getRatesOfChangeEx (RRHandle handle, const RRVectorPtr vec)
	Retrieve the vector of rates of change given a vector of floating species concentrations. More...

Detailed Description

Get information about rates of change.

Function Documentation

getRateOfChange()

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

Retrieve the rate of change for a given floating species.

Example:

status = getRateOfChange (&index, *value); 

Parameters

[in]	handle	Handle to a RoadRunner instance
[out]	value	Pointer to double, holding the rate of change

Returns

Returns false if it fails, otherwise value contains the rate of change.

getRatesOfChange()

C_DECL_SPEC RRVectorPtr rrcCallConv getRatesOfChange

(

RRHandle

handle

)

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

Example:

values = getRatesOfChange (RRHandle handle); 

Parameters

[in]

handle

Handle to a RoadRunner instance

Returns

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

getRatesOfChangeEx()

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

Retrieve the vector of rates of change given a vector of floating species concentrations.

Example:

values = getRatesOfChangeEx (vector); 

Parameters

[in]	handle	Handle to a RoadRunner instance
[in]	vec	Vector handle holding rates of change

Returns

Returns null if it fails

getRatesOfChangeIds()

C_DECL_SPEC RRStringArrayPtr rrcCallConv getRatesOfChangeIds

(

RRHandle

handle

)

Retrieve the string list of rates of change Ids.

Example:

Ids = getRatesOfChangeIds (RRHandle handle); 

Parameters

[in]

handle

Handle to a RoadRunner instance

Returns

Returns null if it fails, otherwise returns a list of rates of change Ids