libroadrunner C API
Functions
Reset methods

Methods for resetting instances to various initial states. More...

Functions

C_DECL_SPEC bool rrcCallConv reset (RRHandle handle)
 Resets all variables of the model to their current initial values. Does not change the parameters. More...
 
C_DECL_SPEC bool rrcCallConv resetAll (RRHandle handle)
 Resets all variables of the model to their current initial values, and resets all parameters to their original values. More...
 
C_DECL_SPEC bool rrcCallConv resetToOrigin (RRHandle handle)
 Resets the model to the state in which it was first loaded, including initial conditions, variables, and parameters. More...
 
C_DECL_SPEC bool rrcCallConv resetParameter (RRHandle handle)
 Resets all parameters of the model to their current initial values. More...
 

Detailed Description

Methods for resetting instances to various initial states.

Function Documentation

◆ reset()

C_DECL_SPEC bool rrcCallConv reset ( RRHandle  handle)

Resets all variables of the model to their current initial values. Does not change the parameters.

Parameters
[in]handleHandle to a RoadRunner instance
Returns
Boolean indicating success

◆ resetAll()

C_DECL_SPEC bool rrcCallConv resetAll ( RRHandle  handle)

Resets all variables of the model to their current initial values, and resets all parameters to their original values.

Parameters
[in]handleHandle to a RoadRunner instance
Returns
Boolean indicating success

◆ resetParameter()

C_DECL_SPEC bool rrcCallConv resetParameter ( RRHandle  handle)

Resets all parameters of the model to their current initial values.

Parameters
[in]handleHandle to a RoadRunner instance
Returns
Boolean indicating success

◆ resetToOrigin()

C_DECL_SPEC bool rrcCallConv resetToOrigin ( RRHandle  handle)

Resets the model to the state in which it was first loaded, including initial conditions, variables, and parameters.

Parameters
[in]handleHandle to a RoadRunner instance
Returns
Boolean indicating success