libRoadRunner C API  1.0.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Functions
Parameters group

Set and get global and local parameters. More...

Functions

RRVectorPtr getGlobalParameterValues (RRHandle handle)
 Retrieve the values for all the global parameter values in a vector. More...
 
bool setGlobalParameterByIndex (RRHandle handle, const int index, const double value)
 Set the value for a particular global parameter. More...
 
bool getGlobalParameterByIndex (RRHandle handle, const int index, double *value)
 Retrieve the global parameter value. More...
 
int getNumberOfGlobalParameters (RRHandle handle)
 Returns the number of global parameters in the model. More...
 
RRStringArrayPtr getGlobalParameterIds (RRHandle handle)
 Obtain the list of global parameter Ids. More...
 

Detailed Description

Set and get global and local parameters.

Function Documentation

bool getGlobalParameterByIndex ( RRHandle  handle,
const int  index,
double *  value 
)

Retrieve the global parameter value.

Parameters
[in]handleHandle to a RoadRunner instance
indexThe index to the global parameter (corresponds to position in getGlobalParametersIds(RRHandle handle))
valueThe value returned by the method
Returns
Returns true if successful, false otherwise
RRStringArrayPtr getGlobalParameterIds ( RRHandle  handle)

Obtain the list of global parameter Ids.

Parameters
[in]handleHandle to a RoadRunner instance
Returns
Returns null if it fails, if successful it returns a pointer to a RRStringArrayPtr struct
RRVectorPtr getGlobalParameterValues ( RRHandle  handle)

Retrieve the values for all the global parameter values in a vector.

Example:

1 RRVectorPtr values = getGlobalParameterValues (void);
Parameters
[in]handleHandle to a RoadRunner instance
Returns
Returns the vector of global parameter values or null if an error occurred
int getNumberOfGlobalParameters ( RRHandle  handle)

Returns the number of global parameters in the model.

Parameters
[in]handleHandle to a RoadRunner instance
bool setGlobalParameterByIndex ( RRHandle  handle,
const int  index,
const double  value 
)

Set the value for a particular global parameter.

Parameters
[in]handleHandle to a RoadRunner instance
indexThe index to the global parameter (corresponds to position in getGlobalParameterIds(RRHandle handle))
valueThe value of the parameter to set
Returns
Returns true if successful