Current state of system

Compute derivatives, fluxes, and other values of the system at the current state. More...

Functions
C_DECL_SPEC bool rrcCallConv	getValue (RRHandle handle, const char *symbolId, double *value)
	Get the value for a given symbol, use getAvailableTimeCourseSymbols(void) for a list of symbols. More...
C_DECL_SPEC bool rrcCallConv	setValue (RRHandle handle, const char *symbolId, const double value)
	Set the value for a given symbol, use getAvailableTimeCourseSymbols(void) for a list of symbols. More...
C_DECL_SPEC bool rrcCallConv	evalModel (RRHandle handle)
	Evaluate the current model, that it update all assignments and rates of change. Do not carry out an integration step. More...
C_DECL_SPEC RRStringArrayPtr rrcCallConv	getEigenvalueIds (RRHandle handle)
	Obtain the list of eigenvalue Ids. More...
C_DECL_SPEC RRListPtr rrcCallConv	getAvailableTimeCourseSymbols (RRHandle handle)
	Obtain the list of all available symbols. More...
C_DECL_SPEC RRListPtr rrcCallConv	getAvailableSteadyStateSymbols (RRHandle handle)
	Obtain the list of all available steady state symbols. More...

Detailed Description

Compute derivatives, fluxes, and other values of the system at the current state.

Function Documentation

evalModel()

C_DECL_SPEC bool rrcCallConv evalModel

(

RRHandle

handle

)

Evaluate the current model, that it update all assignments and rates of change. Do not carry out an integration step.

Parameters

[in]

handle

Handle to a RoadRunner instance

Returns

Returns false if it fails

getAvailableSteadyStateSymbols()

C_DECL_SPEC RRListPtr rrcCallConv getAvailableSteadyStateSymbols

(

RRHandle

handle

)

Obtain the list of all available steady state symbols.

Parameters

[in]

handle

Handle to a RoadRunner instance

Returns

Returns -1 if it fails, if successful it returns a pointer to a RRListPtr struct

getAvailableTimeCourseSymbols()

C_DECL_SPEC RRListPtr rrcCallConv getAvailableTimeCourseSymbols

(

RRHandle

handle

)

Obtain the list of all available symbols.

Parameters

[in]

handle

Handle to a RoadRunner instance

Returns

Returns -1 if it fails, if successful it returns a pointer to a RRListHandle struct

getEigenvalueIds()

C_DECL_SPEC RRStringArrayPtr rrcCallConv getEigenvalueIds

(

RRHandle

handle

)

Obtain the list of eigenvalue Ids.

Parameters

[in]

handle

Handle to a RoadRunner instance

Returns

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

getValue()

C_DECL_SPEC bool rrcCallConv getValue	(	RRHandle	handle,
		const char *	symbolId,
		double *	value
	)

Get the value for a given symbol, use getAvailableTimeCourseSymbols(void) for a list of symbols.

Example:

status = getValue (rrHandle, "S1", &value); 

Parameters

[in]	handle	Handle to a RoadRunner instance
	symbolId	The symbol that we wish to obtain the value for
	value	The value that will be retrieved

Returns

Returns true if successful

setValue()

C_DECL_SPEC bool rrcCallConv setValue	(	RRHandle	handle,
		const char *	symbolId,
		const double	value
	)

Set the value for a given symbol, use getAvailableTimeCourseSymbols(void) for a list of symbols.

Example:

status = setValue (rrHandle, "S1", 0.5); 

Parameters

[in]	handle	Handle to a RoadRunner instance
	symbolId	The symbol that we wish to set the value
	value	The value that will be set to the symbol

Returns

Returns true if successful