Reflective wrappers for interacting with steady state solvers and integrators. More...

Functions
C_DECL_SPEC int rrcCallConv	getNumRegisteredIntegrators ()
	Get the number of registered integrators. More...

C_DECL_SPEC char *rrcCallConv	getRegisteredIntegratorName (int n)
	Get the name of a registered integrator (e.g. cvode etc.) More...

C_DECL_SPEC char *rrcCallConv	getRegisteredIntegratorHint (int n)
	Get the hint of a registered integrator (e.g. cvode etc.) More...

C_DECL_SPEC char *rrcCallConv	getRegisteredIntegratorDescription (int n)
	Get the description of a registered integrator (e.g. cvode etc.) More...

C_DECL_SPEC int rrcCallConv	getNumInstantiatedIntegrators (RRHandle handle)
	Get the number of instantiated integrators. \description To instantiate an integrator, use setCurrentIntegrator. More...

C_DECL_SPEC int rrcCallConv	setCurrentIntegrator (RRHandle handle, char *nameOfIntegrator)
	Specify the current integrator to be used for simulation. \description This method instantiates a new integrator of the given type (e.g. cvode, gillespie) if one does not currently exist. Otherwise, the existing integrator of this type is used. More...

C_DECL_SPEC char *rrcCallConv	getCurrentIntegratorName (RRHandle handle)
	Obtain a description of the current integrator. More...

C_DECL_SPEC char *rrcCallConv	getCurrentIntegratorDescription (RRHandle handle)
	Obtain a description of the current integrator. More...

C_DECL_SPEC char *rrcCallConv	getCurrentIntegratorHint (RRHandle handle)
	Obtain a short hint for the current integrator. More...

C_DECL_SPEC int rrcCallConv	getNumberOfCurrentIntegratorParameters (RRHandle handle)
	Get the number of adjustable settings for the current integrator. More...

C_DECL_SPEC char *rrcCallConv	getCurrentIntegratorNthParameterName (RRHandle handle, int n)
	Get the name of a parameter of the current integrator. More...

C_DECL_SPEC char *rrcCallConv	getCurrentIntegratorNthParameterDescription (RRHandle handle, int n)
	Get the description of a parameter of the current integrator. More...

C_DECL_SPEC char *rrcCallConv	getCurrentIntegratorNthParameterDisplayName (RRHandle handle, int n)
	Get the display name of a parameter of the current integrator. More...

C_DECL_SPEC char *rrcCallConv	getCurrentIntegratorNthParameterHint (RRHandle handle, int n)
	Get the hint of a parameter of the current integrator. More...

C_DECL_SPEC int rrcCallConv	getCurrentIntegratorNthParameterType (RRHandle handle, int n)
	Get the type of a parameter of the current integrator. More...

C_DECL_SPEC int rrcCallConv	resetCurrentIntegratorParameters (RRHandle handle)
	Reset the integrator parameters to their default values. More...

C_DECL_SPEC RRStringArrayPtr rrcCallConv	getListOfCurrentIntegratorParameterNames (RRHandle handle)
	Get the names of adjustable settings for the current integrator. More...

C_DECL_SPEC char *rrcCallConv	getCurrentIntegratorParameterDescription (RRHandle handle, char *parameterName)
	Get the description for a specific integrator setting. More...

C_DECL_SPEC char *rrcCallConv	getCurrentIntegratorParameterHint (RRHandle handle, char *parameterName)
	Get the hint for a specific integrator setting. More...

C_DECL_SPEC int rrcCallConv	getCurrentIntegratorParameterType (RRHandle handle, char *parameterName)
	Get the return type for a specific integrator setting. More...

C_DECL_SPEC int rrcCallConv	getCurrentIntegratorParameterInt (RRHandle handle, char *parameterName)
	Get the integer value for a specific integrator setting. More...

C_DECL_SPEC int rrcCallConv	setCurrentIntegratorParameterInt (RRHandle handle, char *parameterName, int value)
	Set the integer value for a specific integrator setting. More...

C_DECL_SPEC unsigned int rrcCallConv	getCurrentIntegratorParameterUInt (RRHandle handle, char *parameterName)
	Get the unsigned integer value for a specific integrator setting. More...

C_DECL_SPEC int rrcCallConv	setCurrentIntegratorParameterUInt (RRHandle handle, char *parameterName, unsigned int value)
	Set the unsigned integer value for a specific integrator setting. More...

C_DECL_SPEC double rrcCallConv	getCurrentIntegratorParameterDouble (RRHandle handle, char *parameterName)
	Get the double value for a specific integrator setting. More...

C_DECL_SPEC int rrcCallConv	setCurrentIntegratorParameterDouble (RRHandle handle, char *parameterName, double value)
	Set the double value for a specific integrator setting. More...

C_DECL_SPEC char *rrcCallConv	getCurrentIntegratorParameterString (RRHandle handle, char *parameterName)
	Get the string value for a specific integrator setting. More...

C_DECL_SPEC int rrcCallConv	setCurrentIntegratorParameterString (RRHandle handle, char parameterName, char value)
	Set the string value for a specific integrator setting. More...

C_DECL_SPEC int rrcCallConv	getCurrentIntegratorParameterBoolean (RRHandle handle, char *parameterName)
	Get the boolean value for a specific integrator setting. More...

C_DECL_SPEC int rrcCallConv	setCurrentIntegratorParameterBoolean (RRHandle handle, char *parameterName, int value)
	Set the boolean value for a specific integrator setting. More...

C_DECL_SPEC int rrcCallConv	getCurrentIntegratorParameterDoubleArray (RRHandle handle, char parameterName, double value, int len)
	Get the double array value for a specific integrator setting. Should only used for absoluate tolerace. More...

C_DECL_SPEC int rrcCallConv	setCurrentIntegratorParameterDoubleArray (RRHandle handle, char parameterName, double value, int len)
	Set the double array value for a specific integrator setting. Should only used for absoluate tolerace. More...

C_DECL_SPEC int rrcCallConv	setCurrentIntegratorScalarConcentrationTolerance (RRHandle handle, double value)
	Set the scalar tolerance based on concentration for the current integrator. More...

C_DECL_SPEC int rrcCallConv	setCurrentIntegratorVectorConcentrationTolerance (RRHandle handle, double *value, int len)
	Set the vector tolerance based on concentration for the current integrator. More...

C_DECL_SPEC int rrcCallConv	setCurrentIntegratorIndividualTolerance (RRHandle handle, char *sid, double value)
	Set the double array value for a specific integrator setting. Should only used for absoluate tolerace. More...

C_DECL_SPEC int rrcCallConv	getNumRegisteredSteadyStateSolvers ()
	Get the number of registered steady state solvers. More...

C_DECL_SPEC char *rrcCallConv	getRegisteredSteadyStateSolverName (int n)
	Get the name of a registered steady state solver (e.g. cvode etc.) More...

C_DECL_SPEC char *rrcCallConv	getRegisteredSteadyStateSolverHint (int n)
	Get the hint of a registered steady state solver (e.g. cvode etc.) More...

C_DECL_SPEC char *rrcCallConv	getRegisteredSteadyStateSolverDescription (int n)
	Get the description of a registered steady state solver (e.g. cvode etc.) More...

C_DECL_SPEC int rrcCallConv	setCurrentSteadyStateSolver (RRHandle handle, char *nameOfSteadyStateSolver)
	Specify the current steady state solver to be used for simulation. \description This method instantiates a new steady state solver of the given type (e.g. cvode, gillespie) if one does not currently exist. Otherwise, the existing steady state solver of this type is used. More...

C_DECL_SPEC char *rrcCallConv	getCurrentSteadyStateSolverName (RRHandle handle)
	Obtain a description of the current steady state solver. More...

C_DECL_SPEC char *rrcCallConv	getCurrentSteadyStateSolverDescription (RRHandle handle)
	Obtain a description of the current steady state solver. More...

C_DECL_SPEC char *rrcCallConv	getCurrentSteadyStateSolverHint (RRHandle handle)
	Obtain a short hint for the current steady state solver. More...

C_DECL_SPEC int rrcCallConv	getNumberOfCurrentSteadyStateSolverParameters (RRHandle handle)
	Get the number of adjustable settings for the current steady state solver. More...

C_DECL_SPEC char *rrcCallConv	getCurrentSteadyStateSolverNthParameterName (RRHandle handle, int n)
	Get the name of a parameter of the current steady state solver. More...

C_DECL_SPEC char *rrcCallConv	getCurrentSteadyStateSolverNthParameterDisplayName (RRHandle handle, int n)
	Get the display name of a parameter of the current steady state solver. More...

C_DECL_SPEC char *rrcCallConv	getCurrentSteadyStateSolverNthParameterDescription (RRHandle handle, int n)
	Get the description of a parameter of the current steady state solver. More...

C_DECL_SPEC char *rrcCallConv	getCurrentSteadyStateSolverNthParameterHint (RRHandle handle, int n)
	Get the hint of a parameter of the current steady state solver. More...

C_DECL_SPEC int rrcCallConv	getCurrentSteadyStateSolverNthParameterType (RRHandle handle, int n)
	Get the type of a parameter of the current steady state solver. More...

C_DECL_SPEC int rrcCallConv	resetCurrentSteadyStateSolverParameters (RRHandle handle)
	Reset the steady state solver parameters to their default values. More...

C_DECL_SPEC const char *rrcCallConv	solverTypeToString (int code)
	Get a string description of the type [STATIC MEMORY - DO NOT FREE] \description Can call on return value of e.g. getCurrentSteadyStateSolverNthParameterType to retrieve human-readable string representation. More...

C_DECL_SPEC RRStringArrayPtr rrcCallConv	getListOfCurrentSteadyStateSolverParameterNames (RRHandle handle)
	Get the names of adjustable settings for the current steady state solver. More...

C_DECL_SPEC char *rrcCallConv	getCurrentSteadyStateSolverParameterDescription (RRHandle handle, char *parameterName)
	Get the description for a specific steady state solver setting. More...

C_DECL_SPEC char *rrcCallConv	getCurrentSteadyStateSolverParameterHint (RRHandle handle, char *parameterName)
	Get the hint for a specific steady state solver setting. More...

C_DECL_SPEC int rrcCallConv	getCurrentSteadyStateSolverParameterType (RRHandle handle, char *parameterName)
	Get the return type for a specific steady state solver setting. More...

C_DECL_SPEC int rrcCallConv	getCurrentSteadyStateSolverParameterInt (RRHandle handle, char *parameterName)
	Get the integer value for a specific steady state solver setting. More...

C_DECL_SPEC int rrcCallConv	setCurrentSteadyStateSolverParameterInt (RRHandle handle, char *parameterName, int value)
	Set the integer value for a specific steady state solver setting. More...

C_DECL_SPEC unsigned int rrcCallConv	getCurrentSteadyStateSolverParameterUInt (RRHandle handle, char *parameterName)
	Get the unsigned integer value for a specific steady state solver setting. More...

C_DECL_SPEC int rrcCallConv	setCurrentSteadyStateSolverParameterUInt (RRHandle handle, char *parameterName, unsigned int value)
	Set the unsigned integer value for a specific steady state solver setting. More...

C_DECL_SPEC double rrcCallConv	getCurrentSteadyStateSolverParameterDouble (RRHandle handle, char *parameterName)
	Get the double value for a specific steady state solver setting. More...

C_DECL_SPEC int rrcCallConv	setCurrentSteadyStateSolverParameterDouble (RRHandle handle, char *parameterName, double value)
	Set the double value for a specific steady state solver setting. More...

C_DECL_SPEC char *rrcCallConv	getCurrentSteadyStateSolverParameterString (RRHandle handle, char *parameterName)
	Get the string value for a specific steady state solver setting. More...

C_DECL_SPEC int rrcCallConv	setCurrentSteadyStateSolverParameterString (RRHandle handle, char parameterName, char value)
	Set the string value for a specific steady state solver setting. More...

C_DECL_SPEC int rrcCallConv	getCurrentSteadyStateSolverParameterBoolean (RRHandle handle, char *parameterName)
	Get the boolean value for a specific steady state solver setting. More...

C_DECL_SPEC int rrcCallConv	setCurrentSteadyStateSolverParameterBoolean (RRHandle handle, char *parameterName, int value)
	Set the boolean value for a specific steady state solver setting. More...

Detailed Description

Reflective wrappers for interacting with steady state solvers and integrators.

Function Documentation

◆ getCurrentIntegratorDescription()

C_DECL_SPEC char* rrcCallConv getCurrentIntegratorDescription ( RRHandle handle )

Obtain a description of the current integrator.

Parameters

[in] handle Handle to a RoadRunner instance.

Returns: Returns a description of the current integrator.

◆ getCurrentIntegratorHint()

C_DECL_SPEC char* rrcCallConv getCurrentIntegratorHint ( RRHandle handle )

Obtain a short hint for the current integrator.

Parameters

[in] handle Handle to a RoadRunner instance.

Returns: Returns a short hint of the current integrator.

◆ getCurrentIntegratorName()

C_DECL_SPEC char* rrcCallConv getCurrentIntegratorName ( RRHandle handle )

Obtain a description of the current integrator.

Parameters

[in] handle Handle to a RoadRunner instance.

Returns: Returns a description of the current integrator.

◆ getCurrentIntegratorNthParameterDescription()

C_DECL_SPEC char* rrcCallConv getCurrentIntegratorNthParameterDescription	(	RRHandle	handle,
		int	n
	)

Get the description of a parameter of the current integrator.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	n	The index of the parameter (0 <= n < getNumberOfCurrentIntegratorParameters)

◆ getCurrentIntegratorNthParameterDisplayName()

C_DECL_SPEC char* rrcCallConv getCurrentIntegratorNthParameterDisplayName	(	RRHandle	handle,
		int	n
	)

Get the display name of a parameter of the current integrator.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	n	The index of the parameter (0 <= n < getNumberOfCurrentIntegratorParameters)

◆ getCurrentIntegratorNthParameterHint()

C_DECL_SPEC char* rrcCallConv getCurrentIntegratorNthParameterHint	(	RRHandle	handle,
		int	n
	)

Get the hint of a parameter of the current integrator.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	n	The index of the parameter (0 <= n < getNumberOfCurrentIntegratorParameters)

◆ getCurrentIntegratorNthParameterName()

C_DECL_SPEC char* rrcCallConv getCurrentIntegratorNthParameterName	(	RRHandle	handle,
		int	n
	)

Get the name of a parameter of the current integrator.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	n	The index of the parameter (0 <= n < getNumberOfCurrentIntegratorParameters)

◆ getCurrentIntegratorNthParameterType()

C_DECL_SPEC int rrcCallConv getCurrentIntegratorNthParameterType	(	RRHandle	handle,
		int	n
	)

Get the type of a parameter of the current integrator.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	n	The index of the parameter (0 <= n < getNumberOfCurrentIntegratorParameters)

◆ getCurrentIntegratorParameterBoolean()

C_DECL_SPEC int rrcCallConv getCurrentIntegratorParameterBoolean	(	RRHandle	handle,
		char *	parameterName
	)

Get the boolean value for a specific integrator setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the integrator setting.

Returns: Returns a boolean value for the integrator setting.

◆ getCurrentIntegratorParameterDescription()

C_DECL_SPEC char* rrcCallConv getCurrentIntegratorParameterDescription	(	RRHandle	handle,
		char *	parameterName
	)

Get the description for a specific integrator setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the integrator setting.

Returns: Returns a description for the integrator setting.

◆ getCurrentIntegratorParameterDouble()

C_DECL_SPEC double rrcCallConv getCurrentIntegratorParameterDouble	(	RRHandle	handle,
		char *	parameterName
	)

Get the double value for a specific integrator setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the integrator setting.

Returns: Returns a double value for the integrator setting.

◆ getCurrentIntegratorParameterDoubleArray()

C_DECL_SPEC int rrcCallConv getCurrentIntegratorParameterDoubleArray	(	RRHandle	handle,
		char *	parameterName,
		double **	value,
		int *	len
	)

Get the double array value for a specific integrator setting. Should only used for absoluate tolerace.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the integrator setting.
[in]	value	Return the values as in this double array.
[in]	len	Return the length double array.

Returns: Returns True if successful.

◆ getCurrentIntegratorParameterHint()

C_DECL_SPEC char* rrcCallConv getCurrentIntegratorParameterHint	(	RRHandle	handle,
		char *	parameterName
	)

Get the hint for a specific integrator setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the integrator setting.

Returns: Returns a hint for the integrator setting.

◆ getCurrentIntegratorParameterInt()

C_DECL_SPEC int rrcCallConv getCurrentIntegratorParameterInt	(	RRHandle	handle,
		char *	parameterName
	)

Get the integer value for a specific integrator setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the integrator setting.

Returns: Returns an integer value for the integrator setting.

◆ getCurrentIntegratorParameterString()

C_DECL_SPEC char* rrcCallConv getCurrentIntegratorParameterString	(	RRHandle	handle,
		char *	parameterName
	)

Get the string value for a specific integrator setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the integrator setting.

Returns: Returns a string value for the integrator setting.

◆ getCurrentIntegratorParameterType()

C_DECL_SPEC int rrcCallConv getCurrentIntegratorParameterType	(	RRHandle	handle,
		char *	parameterName
	)

Get the return type for a specific integrator setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the integrator setting.

Returns: Returns a integer that indicates the return type for the integrator setting. 0-STRING, 1-BOOL, 2-INT32, 3-UINT32, 4-INT64, 5-UINT64, 6-FLOAT, 7-DOUBLE, 8-CHAR, 9-UCHAR, 10-EMPTY

◆ getCurrentIntegratorParameterUInt()

C_DECL_SPEC unsigned int rrcCallConv getCurrentIntegratorParameterUInt	(	RRHandle	handle,
		char *	parameterName
	)

Get the unsigned integer value for a specific integrator setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the integrator setting.

Returns: Returns an integer value for the integrator setting.

◆ getCurrentSteadyStateSolverDescription()

C_DECL_SPEC char* rrcCallConv getCurrentSteadyStateSolverDescription ( RRHandle handle )

Obtain a description of the current steady state solver.

Parameters

[in] handle Handle to a RoadRunner instance.

Returns: Returns a description of the current steady state solver.

◆ getCurrentSteadyStateSolverHint()

C_DECL_SPEC char* rrcCallConv getCurrentSteadyStateSolverHint ( RRHandle handle )

Obtain a short hint for the current steady state solver.

Parameters

[in] handle Handle to a RoadRunner instance.

Returns: Returns a short hint of the current steady state solver.

◆ getCurrentSteadyStateSolverName()

C_DECL_SPEC char* rrcCallConv getCurrentSteadyStateSolverName ( RRHandle handle )

Obtain a description of the current steady state solver.

Parameters

[in] handle Handle to a RoadRunner instance.

Returns: Returns a description of the current steady state solver.

◆ getCurrentSteadyStateSolverNthParameterDescription()

C_DECL_SPEC char* rrcCallConv getCurrentSteadyStateSolverNthParameterDescription	(	RRHandle	handle,
		int	n
	)

Get the description of a parameter of the current steady state solver.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	n	The index of the parameter (0 <= n < getNumberOfCurrentSteadyStateSolverParameters)

◆ getCurrentSteadyStateSolverNthParameterDisplayName()

C_DECL_SPEC char* rrcCallConv getCurrentSteadyStateSolverNthParameterDisplayName	(	RRHandle	handle,
		int	n
	)

Get the display name of a parameter of the current steady state solver.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	n	The index of the parameter (0 <= n < getNumberOfCurrentSteadyStateSolverParameters)

◆ getCurrentSteadyStateSolverNthParameterHint()

C_DECL_SPEC char* rrcCallConv getCurrentSteadyStateSolverNthParameterHint	(	RRHandle	handle,
		int	n
	)

Get the hint of a parameter of the current steady state solver.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	n	The index of the parameter (0 <= n < getNumberOfCurrentSteadyStateSolverParameters)

◆ getCurrentSteadyStateSolverNthParameterName()

C_DECL_SPEC char* rrcCallConv getCurrentSteadyStateSolverNthParameterName	(	RRHandle	handle,
		int	n
	)

Get the name of a parameter of the current steady state solver.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	n	The index of the parameter (0 <= n < getNumberOfCurrentSteadyStateSolverParameters)

◆ getCurrentSteadyStateSolverNthParameterType()

C_DECL_SPEC int rrcCallConv getCurrentSteadyStateSolverNthParameterType	(	RRHandle	handle,
		int	n
	)

Get the type of a parameter of the current steady state solver.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	n	The index of the parameter (0 <= n < getNumberOfCurrentSteadyStateSolverParameters)

◆ getCurrentSteadyStateSolverParameterBoolean()

C_DECL_SPEC int rrcCallConv getCurrentSteadyStateSolverParameterBoolean	(	RRHandle	handle,
		char *	parameterName
	)

Get the boolean value for a specific steady state solver setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the steady state solver setting.

Returns: Returns a boolean value for the steady state solver setting.

◆ getCurrentSteadyStateSolverParameterDescription()

C_DECL_SPEC char* rrcCallConv getCurrentSteadyStateSolverParameterDescription	(	RRHandle	handle,
		char *	parameterName
	)

Get the description for a specific steady state solver setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the steady state solver setting.

Returns: Returns a description for the steady state solver setting.

◆ getCurrentSteadyStateSolverParameterDouble()

C_DECL_SPEC double rrcCallConv getCurrentSteadyStateSolverParameterDouble	(	RRHandle	handle,
		char *	parameterName
	)

Get the double value for a specific steady state solver setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the steady state solver setting.

Returns: Returns a double value for the steady state solver setting.

◆ getCurrentSteadyStateSolverParameterHint()

C_DECL_SPEC char* rrcCallConv getCurrentSteadyStateSolverParameterHint	(	RRHandle	handle,
		char *	parameterName
	)

Get the hint for a specific steady state solver setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the steady state solver setting.

Returns: Returns a hint for the steady state solver setting.

◆ getCurrentSteadyStateSolverParameterInt()

C_DECL_SPEC int rrcCallConv getCurrentSteadyStateSolverParameterInt	(	RRHandle	handle,
		char *	parameterName
	)

Get the integer value for a specific steady state solver setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the steady state solver setting.

Returns: Returns an integer value for the steady state solver setting.

◆ getCurrentSteadyStateSolverParameterString()

C_DECL_SPEC char* rrcCallConv getCurrentSteadyStateSolverParameterString	(	RRHandle	handle,
		char *	parameterName
	)

Get the string value for a specific steady state solver setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the steady state solver setting.

Returns: Returns a string value for the steady state solver setting.

◆ getCurrentSteadyStateSolverParameterType()

C_DECL_SPEC int rrcCallConv getCurrentSteadyStateSolverParameterType	(	RRHandle	handle,
		char *	parameterName
	)

Get the return type for a specific steady state solver setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the steady state solver setting.

Returns: Returns a integer that indicates the return type for the steady state solver setting. 0-STRING, 1-BOOL, 2-INT32, 3-UINT32, 4-INT64, 5-UINT64, 6-FLOAT, 7-DOUBLE, 8-CHAR, 9-UCHAR, 10-EMPTY

◆ getCurrentSteadyStateSolverParameterUInt()

C_DECL_SPEC unsigned int rrcCallConv getCurrentSteadyStateSolverParameterUInt	(	RRHandle	handle,
		char *	parameterName
	)

Get the unsigned integer value for a specific steady state solver setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the steady state solver setting.

Returns: Returns an integer value for the steady state solver setting.

◆ getListOfCurrentIntegratorParameterNames()

C_DECL_SPEC RRStringArrayPtr rrcCallConv getListOfCurrentIntegratorParameterNames ( RRHandle handle )

Get the names of adjustable settings for the current integrator.

Parameters

[in] handle Handle to a RoadRunner instance.

Returns: Returns a list that contains the names of adjustable integrator settings.

◆ getListOfCurrentSteadyStateSolverParameterNames()

C_DECL_SPEC RRStringArrayPtr rrcCallConv getListOfCurrentSteadyStateSolverParameterNames ( RRHandle handle )

Get the names of adjustable settings for the current steady state solver.

Parameters

[in] handle Handle to a RoadRunner instance.

Returns: Returns a list that contains the names of adjustable steady state solver settings.

◆ getNumberOfCurrentIntegratorParameters()

C_DECL_SPEC int rrcCallConv getNumberOfCurrentIntegratorParameters ( RRHandle handle )

Get the number of adjustable settings for the current integrator.

Parameters

[in] handle Handle to a RoadRunner instance.

Returns: Returns an integer that corresponds to the number of adjustable integrator settings.

◆ getNumberOfCurrentSteadyStateSolverParameters()

C_DECL_SPEC int rrcCallConv getNumberOfCurrentSteadyStateSolverParameters ( RRHandle handle )

Get the number of adjustable settings for the current steady state solver.

Parameters

[in] handle Handle to a RoadRunner instance.

Returns: Returns an integer that corresponds to the number of adjustable steady state solver settings.

◆ getNumInstantiatedIntegrators()

C_DECL_SPEC int rrcCallConv getNumInstantiatedIntegrators ( RRHandle handle )

Get the number of instantiated integrators. \description To instantiate an integrator, use setCurrentIntegrator.

Parameters

[in] handle Handle to a RoadRunner instance.

Returns: Returns an integer that corresponds to the number of currently registered integrators.

◆ getNumRegisteredIntegrators()

C_DECL_SPEC int rrcCallConv getNumRegisteredIntegrators ( )

Get the number of registered integrators.

Returns: Returns an integer that corresponds to the number of currently registered integrators.

◆ getNumRegisteredSteadyStateSolvers()

C_DECL_SPEC int rrcCallConv getNumRegisteredSteadyStateSolvers ( )

Get the number of registered steady state solvers.

Returns: Returns an integer that corresponds to the number of currently registered steady state solvers.

◆ getRegisteredIntegratorDescription()

C_DECL_SPEC char* rrcCallConv getRegisteredIntegratorDescription ( int n )

Get the description of a registered integrator (e.g. cvode etc.)

Parameters

[in] n The index of the registered integrator

Note: Callee owns memory

◆ getRegisteredIntegratorHint()

C_DECL_SPEC char* rrcCallConv getRegisteredIntegratorHint ( int n )

Get the hint of a registered integrator (e.g. cvode etc.)

Parameters

[in] n The index of the registered integrator

Note: Callee owns memory

◆ getRegisteredIntegratorName()

C_DECL_SPEC char* rrcCallConv getRegisteredIntegratorName ( int n )

Get the name of a registered integrator (e.g. cvode etc.)

Parameters

[in] n The index of the registered integrator

Note: Callee owns memory

◆ getRegisteredSteadyStateSolverDescription()

C_DECL_SPEC char* rrcCallConv getRegisteredSteadyStateSolverDescription ( int n )

Get the description of a registered steady state solver (e.g. cvode etc.)

Parameters

[in] n The index of the registered steady state solver

Note: Callee owns memory

◆ getRegisteredSteadyStateSolverHint()

C_DECL_SPEC char* rrcCallConv getRegisteredSteadyStateSolverHint ( int n )

Get the hint of a registered steady state solver (e.g. cvode etc.)

Parameters

[in] n The index of the registered steady state solver

Note: Callee owns memory

◆ getRegisteredSteadyStateSolverName()

C_DECL_SPEC char* rrcCallConv getRegisteredSteadyStateSolverName ( int n )

Get the name of a registered steady state solver (e.g. cvode etc.)

Parameters

[in] n The index of the registered steady state solver

Note: Callee owns memory

◆ resetCurrentIntegratorParameters()

C_DECL_SPEC int rrcCallConv resetCurrentIntegratorParameters ( RRHandle handle )

Reset the integrator parameters to their default values.

Parameters

[in] handle Handle to a RoadRunner instance.

Returns: Returns True if successful.

◆ resetCurrentSteadyStateSolverParameters()

C_DECL_SPEC int rrcCallConv resetCurrentSteadyStateSolverParameters ( RRHandle handle )

Reset the steady state solver parameters to their default values.

Parameters

[in] handle Handle to a RoadRunner instance.

Returns: Returns True if successful.

◆ setCurrentIntegrator()

C_DECL_SPEC int rrcCallConv setCurrentIntegrator	(	RRHandle	handle,
		char *	nameOfIntegrator
	)

Specify the current integrator to be used for simulation. \description This method instantiates a new integrator of the given type (e.g. cvode, gillespie) if one does not currently exist. Otherwise, the existing integrator of this type is used.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	nameOfIntegrator	Name of the integrator to be used.

Returns: Returns True if successful.

◆ setCurrentIntegratorIndividualTolerance()

C_DECL_SPEC int rrcCallConv setCurrentIntegratorIndividualTolerance	(	RRHandle	handle,
		char *	sid,
		double	value
	)

Set the double array value for a specific integrator setting. Should only used for absoluate tolerace.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the integrator setting.
[in]	value	The double array value for the integrator setting.
[in]	len	The length of given soubld array.

Returns: Returns True if successful.

◆ setCurrentIntegratorParameterBoolean()

C_DECL_SPEC int rrcCallConv setCurrentIntegratorParameterBoolean	(	RRHandle	handle,
		char *	parameterName,
		int	value
	)

Set the boolean value for a specific integrator setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the integrator setting.
[in]	value	The boolean value for the integrator setting.

Returns: Returns True if successful.

◆ setCurrentIntegratorParameterDouble()

C_DECL_SPEC int rrcCallConv setCurrentIntegratorParameterDouble	(	RRHandle	handle,
		char *	parameterName,
		double	value
	)

Set the double value for a specific integrator setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the integrator setting.
[in]	value	The double value for the integrator setting.

Returns: Returns True if successful.

◆ setCurrentIntegratorParameterDoubleArray()

C_DECL_SPEC int rrcCallConv setCurrentIntegratorParameterDoubleArray	(	RRHandle	handle,
		char *	parameterName,
		double *	value,
		int	len
	)

Set the double array value for a specific integrator setting. Should only used for absoluate tolerace.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the integrator setting.
[in]	value	The double array value for the integrator setting.
[in]	len	The length of given soubld array.

Returns: Returns True if successful.

◆ setCurrentIntegratorParameterInt()

C_DECL_SPEC int rrcCallConv setCurrentIntegratorParameterInt	(	RRHandle	handle,
		char *	parameterName,
		int	value
	)

Set the integer value for a specific integrator setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the integrator setting.
[in]	value	The integer value for the integrator setting.

Returns: Returns True if successful.

◆ setCurrentIntegratorParameterString()

C_DECL_SPEC int rrcCallConv setCurrentIntegratorParameterString	(	RRHandle	handle,
		char *	parameterName,
		char *	value
	)

Set the string value for a specific integrator setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the integrator setting.
[in]	value	The string value for the integrator setting.

Returns: Returns True if successful.

◆ setCurrentIntegratorParameterUInt()

C_DECL_SPEC int rrcCallConv setCurrentIntegratorParameterUInt	(	RRHandle	handle,
		char *	parameterName,
		unsigned int	value
	)

Set the unsigned integer value for a specific integrator setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the integrator setting.
[in]	value	The integer value for the integrator setting.

Returns: Returns True if successful.

◆ setCurrentIntegratorScalarConcentrationTolerance()

C_DECL_SPEC int rrcCallConv setCurrentIntegratorScalarConcentrationTolerance	(	RRHandle	handle,
		double	value
	)

Set the scalar tolerance based on concentration for the current integrator.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	value	The double value for the integrator setting.

Returns: Returns True if successful.

◆ setCurrentIntegratorVectorConcentrationTolerance()

C_DECL_SPEC int rrcCallConv setCurrentIntegratorVectorConcentrationTolerance	(	RRHandle	handle,
		double *	value,
		int	len
	)

Set the vector tolerance based on concentration for the current integrator.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	value	The double array value for the integrator setting.
[in]	len	The length of given soubld array.

Returns: Returns True if successful.

◆ setCurrentSteadyStateSolver()

C_DECL_SPEC int rrcCallConv setCurrentSteadyStateSolver	(	RRHandle	handle,
		char *	nameOfSteadyStateSolver
	)

Specify the current steady state solver to be used for simulation. \description This method instantiates a new steady state solver of the given type (e.g. cvode, gillespie) if one does not currently exist. Otherwise, the existing steady state solver of this type is used.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	nameOfSteadyStateSolver	Name of the steady state solver to be used.

Returns: Returns True if successful.

◆ setCurrentSteadyStateSolverParameterBoolean()

C_DECL_SPEC int rrcCallConv setCurrentSteadyStateSolverParameterBoolean	(	RRHandle	handle,
		char *	parameterName,
		int	value
	)

Set the boolean value for a specific steady state solver setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the steady state solver setting.
[in]	value	The boolean value for the steady state solver setting.

Returns: Returns True if successful.

◆ setCurrentSteadyStateSolverParameterDouble()

C_DECL_SPEC int rrcCallConv setCurrentSteadyStateSolverParameterDouble	(	RRHandle	handle,
		char *	parameterName,
		double	value
	)

Set the double value for a specific steady state solver setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the steady state solver setting.
[in]	value	The double value for the steady state solver setting.

Returns: Returns True if successful.

◆ setCurrentSteadyStateSolverParameterInt()

C_DECL_SPEC int rrcCallConv setCurrentSteadyStateSolverParameterInt	(	RRHandle	handle,
		char *	parameterName,
		int	value
	)

Set the integer value for a specific steady state solver setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the steady state solver setting.
[in]	value	The integer value for the steady state solver setting.

Returns: Returns True if successful.

◆ setCurrentSteadyStateSolverParameterString()

C_DECL_SPEC int rrcCallConv setCurrentSteadyStateSolverParameterString	(	RRHandle	handle,
		char *	parameterName,
		char *	value
	)

Set the string value for a specific steady state solver setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the steady state solver setting.
[in]	value	The string value for the steady state solver setting.

Returns: Returns True if successful.

◆ setCurrentSteadyStateSolverParameterUInt()

C_DECL_SPEC int rrcCallConv setCurrentSteadyStateSolverParameterUInt	(	RRHandle	handle,
		char *	parameterName,
		unsigned int	value
	)

Set the unsigned integer value for a specific steady state solver setting.

Parameters

[in]	handle	Handle to a RoadRunner instance.
[in]	parameterName	Name of the steady state solver setting.
[in]	value	The integer value for the steady state solver setting.

Returns: Returns True if successful.

◆ solverTypeToString()

C_DECL_SPEC const char* rrcCallConv solverTypeToString ( int code )

Get a string description of the type [STATIC MEMORY - DO NOT FREE] \description Can call on return value of e.g. getCurrentSteadyStateSolverNthParameterType to retrieve human-readable string representation.

Parameters

[in] code Type code for the parameter

Functions

Detailed Description

Function Documentation

◆ getCurrentIntegratorDescription()

◆ getCurrentIntegratorHint()

◆ getCurrentIntegratorName()

◆ getCurrentIntegratorNthParameterDescription()

◆ getCurrentIntegratorNthParameterDisplayName()

◆ getCurrentIntegratorNthParameterHint()

◆ getCurrentIntegratorNthParameterName()

◆ getCurrentIntegratorNthParameterType()

◆ getCurrentIntegratorParameterBoolean()

◆ getCurrentIntegratorParameterDescription()

◆ getCurrentIntegratorParameterDouble()

◆ getCurrentIntegratorParameterDoubleArray()

◆ getCurrentIntegratorParameterHint()

◆ getCurrentIntegratorParameterInt()

◆ getCurrentIntegratorParameterString()

◆ getCurrentIntegratorParameterType()

◆ getCurrentIntegratorParameterUInt()

◆ getCurrentSteadyStateSolverDescription()

◆ getCurrentSteadyStateSolverHint()

◆ getCurrentSteadyStateSolverName()

◆ getCurrentSteadyStateSolverNthParameterDescription()

◆ getCurrentSteadyStateSolverNthParameterDisplayName()

◆ getCurrentSteadyStateSolverNthParameterHint()

◆ getCurrentSteadyStateSolverNthParameterName()

◆ getCurrentSteadyStateSolverNthParameterType()

◆ getCurrentSteadyStateSolverParameterBoolean()

◆ getCurrentSteadyStateSolverParameterDescription()

◆ getCurrentSteadyStateSolverParameterDouble()

◆ getCurrentSteadyStateSolverParameterHint()

◆ getCurrentSteadyStateSolverParameterInt()

◆ getCurrentSteadyStateSolverParameterString()

◆ getCurrentSteadyStateSolverParameterType()

◆ getCurrentSteadyStateSolverParameterUInt()

◆ getListOfCurrentIntegratorParameterNames()

◆ getListOfCurrentSteadyStateSolverParameterNames()

◆ getNumberOfCurrentIntegratorParameters()

◆ getNumberOfCurrentSteadyStateSolverParameters()

◆ getNumInstantiatedIntegrators()

◆ getNumRegisteredIntegrators()

◆ getNumRegisteredSteadyStateSolvers()

◆ getRegisteredIntegratorDescription()

◆ getRegisteredIntegratorHint()

◆ getRegisteredIntegratorName()

◆ getRegisteredSteadyStateSolverDescription()

◆ getRegisteredSteadyStateSolverHint()

◆ getRegisteredSteadyStateSolverName()

◆ resetCurrentIntegratorParameters()

◆ resetCurrentSteadyStateSolverParameters()

◆ setCurrentIntegrator()

◆ setCurrentIntegratorIndividualTolerance()

◆ setCurrentIntegratorParameterBoolean()

◆ setCurrentIntegratorParameterDouble()

◆ setCurrentIntegratorParameterDoubleArray()

◆ setCurrentIntegratorParameterInt()

◆ setCurrentIntegratorParameterString()

◆ setCurrentIntegratorParameterUInt()

◆ setCurrentIntegratorScalarConcentrationTolerance()

◆ setCurrentIntegratorVectorConcentrationTolerance()

◆ setCurrentSteadyStateSolver()

◆ setCurrentSteadyStateSolverParameterBoolean()

◆ setCurrentSteadyStateSolverParameterDouble()

◆ setCurrentSteadyStateSolverParameterInt()

◆ setCurrentSteadyStateSolverParameterString()

◆ setCurrentSteadyStateSolverParameterUInt()

◆ solverTypeToString()