libroadrunner C API
Functions
rrc_api.h File Reference

libRoadRunner C wrappers 2012-2013 More...

#include "rrc_exporter.h"
#include "rrc_types.h"
#include "rrc_utilities.h"
#include "rrc_logging_api.h"
#include "rrc_nom_api.h"
#include "rrc_libstruct_api.h"

Go to the source code of this file.

Functions

C_DECL_SPEC RRHandle rrcCallConv createRRInstance (void)
 Initialize a new roadRunner instance and return a handle to it. More...
 
C_DECL_SPEC RRHandle rrcCallConv createRRInstanceEx (const char *tempFolder, const char *compiler)
 Initialize a new roadRunner instance and return a handle to it. More...
 
C_DECL_SPEC bool rrcCallConv freeRRInstance (RRHandle handle)
 Free the roadRunner instance. More...
 
char * getInstallFolder (void)
 Returns the folder in which the RoadRunner wrappers is installed. More...
 
C_DECL_SPEC bool rrcCallConv setInstallFolder (const char *folder)
 Set the internal string containing the folder in where the RoadRunner C wrappers is installed. More...
 
C_DECL_SPEC char *rrcCallConv getAPIVersion (void)
 Retrieve the current version number of the C wrappers library. More...
 
C_DECL_SPEC char *rrcCallConv getCPPAPIVersion (RRHandle handle)
 Retrieve the current version number of the C++ wrappers (Core RoadRunner wrappers) library. More...
 
C_DECL_SPEC int rrcCallConv getVersion ()
 
C_DECL_SPEC char *rrcCallConv getVersionStr ()
 
C_DECL_SPEC char *rrcCallConv getVersionEx ()
 
C_DECL_SPEC char *rrcCallConv getExtendedAPIInfo ()
 Retrieve extended wrappers info. More...
 
C_DECL_SPEC char *rrcCallConv getBuildDate (void)
 Retrieve the current build date of the library. More...
 
C_DECL_SPEC char *rrcCallConv getBuildTime (void)
 Retrieve the current build time (HH:MM:SS) of the library. More...
 
C_DECL_SPEC char *rrcCallConv getBuildDateTime (void)
 Retrieve the current build date + time of the library. More...
 
C_DECL_SPEC char *rrcCallConv getCopyright (void)
 Retrieve the current copyright notice for the library. More...
 
C_DECL_SPEC char *rrcCallConv getInfo (RRHandle handle)
 Retrieve info about current state of roadrunner, e.g. loaded model, conservationAnalysis etc. More...
 
C_DECL_SPEC char *rrcCallConv getlibSBMLVersion (RRHandle handle)
 Retrieve the current version number of the libSBML library. More...
 
C_DECL_SPEC bool rrcCallConv setTempFolder (RRHandle handle, const char *folder)
 Set the path to the temporary folder where the C code will be stored. More...
 
C_DECL_SPEC char *rrcCallConv getTempFolder (RRHandle handle)
 Retrieve the current temporary folder path. More...
 
C_DECL_SPEC char *rrcCallConv getWorkingDirectory (void)
 Retrieve the current working directory path. More...
 
C_DECL_SPEC char *rrcCallConv getRRCAPILocation (void)
 Retrieve the directory path of the shared rrCApi library. More...
 
C_DECL_SPEC bool rrcCallConv setCompiler (RRHandle handle, const char *fNameWithPath)
 Set the path and filename to the compiler to be used by roadrunner. More...
 
C_DECL_SPEC char *rrcCallConv getCompiler (RRHandle handle)
 Get the name of the compiler currently being used by roadrunner.
 
C_DECL_SPEC bool rrcCallConv setCompilerLocation (RRHandle handle, const char *folder)
 Set the path to a folder containing the compiler to be used. More...
 
C_DECL_SPEC char *rrcCallConv getCompilerLocation (RRHandle handle)
 Get the path to a folder containing the compiler being used. More...
 
C_DECL_SPEC bool rrcCallConv setSupportCodeFolder (RRHandle handle, const char *folder)
 Set the path to a folder containing support code for model generation. More...
 
C_DECL_SPEC char *rrcCallConv getSupportCodeFolder (RRHandle handle)
 Get the path to a folder containing support code. More...
 
C_DECL_SPEC bool rrcCallConv setCodeGenerationMode (RRHandle handle, int mode)
 Set the runtime generation option [Not yet implemented]. More...
 
C_DECL_SPEC bool rrcCallConv hasError (void)
 Check if there is an error string to retrieve. More...
 
C_DECL_SPEC char *rrcCallConv getLastError (void)
 Retrieve the current error string. More...
 
C_DECL_SPEC bool rrcCallConv setComputeAndAssignConservationLaws (RRHandle handle, const bool On_Or_Off)
 Enable or disable conservation analysis. More...
 
C_DECL_SPEC int rrcCallConv getComputeAndAssignConservationLaws (RRHandle handle, int *value)
 Get the value of the moiety conservation setting. More...
 
C_DECL_SPEC bool rrcCallConv loadSBML (RRHandle handle, const char *sbml)
 Load a model from an SBML string. More...
 
C_DECL_SPEC bool rrcCallConv loadSBMLEx (RRHandle handle, const char *sbml, bool forceRecompile)
 Load a model from an SBML string. More...
 
C_DECL_SPEC bool rrcCallConv saveState (RRHandle handle, const char *filename)
 Save a road runner instance's state to a platform-specific binary file. More...
 
C_DECL_SPEC bool rrcCallConv loadState (RRHandle handle, const char *filename)
 Reload a road runner instance's state saved by saveState. More...
 
C_DECL_SPEC bool rrcCallConv loadSBMLFromFile (RRHandle handle, const char *fileName)
 Load a model from a SBML file. More...
 
C_DECL_SPEC bool rrcCallConv loadSBMLFromFileE (RRHandle handle, const char *fileName, bool forceRecompile)
 Load a model from a SBML file, force recompilation. More...
 
C_DECL_SPEC bool rrcCallConv clearModel (RRHandle handle)
 Unload current model. More...
 
C_DECL_SPEC bool rrcCallConv isModelLoaded (RRHandle handle)
 check if a model is loaded More...
 
C_DECL_SPEC bool rrcCallConv loadSimulationSettings (RRHandle handle, const char *fileName)
 Load simulation settings from a file. More...
 
C_DECL_SPEC char *rrcCallConv getCurrentSBML (RRHandle handle)
 Retrieve the current state of the model in the form of an SBML string. More...
 
C_DECL_SPEC char *rrcCallConv getSBML (RRHandle handle)
 Retrieve the SBML model that was last loaded into roadRunner. More...
 
C_DECL_SPEC bool rrcCallConv addSpecies (RRHandle handle, const char *sid, const char *compartment, double initialAmount, bool hasOnlySubstanceUnits, bool boundaryCondition)
 Add a species to the current model. More...
 
C_DECL_SPEC bool rrcCallConv addSpeciesNoRegen (RRHandle handle, const char *sid, const char *compartment, double initialAmount, bool hasOnlySubstanceUnits, bool boundaryCondition)
 Add a species to the current model, without regenerating it The last modification must regenerate for the modifications to take effect. More...
 
C_DECL_SPEC bool rrcCallConv removeSpecies (RRHandle handle, const char *sid)
 Remove a species from the current model. More...
 
C_DECL_SPEC bool rrcCallConv removeSpeciesNoRegen (RRHandle handle, const char *sid)
 Remove a species from the current model, without regenerating it The last modification must regenerate for the modifications to take effect. More...
 
C_DECL_SPEC bool rrcCallConv setBoundary (RRHandle handle, const char *sid, bool boundaryCondition)
 Set the boundary condition of an existing species. More...
 
C_DECL_SPEC bool rrcCallConv setBoundaryNoRegen (RRHandle handle, const char *sid, bool boundaryCondition)
 Set the boundary condition of an existing species, without regenerating it The last modification must regenerate for the modifications to take effect. More...
 
C_DECL_SPEC bool rrcCallConv setHasOnlySubstanceUnits (RRHandle handle, const char *sid, bool hasOnlySubstanceUnits)
 Set the hasOnlySubstanceUnits attribute for an existing species. More...
 
C_DECL_SPEC bool rrcCallConv setHasOnlySubstanceUnitsNoRegen (RRHandle handle, const char *sid, bool hasOnlySubstanceUnits)
 Set the hasOnlySubstanceUnits attribute for an existing species, without regenerating it The last modification must regenerate for the modifications to take effect. More...
 
C_DECL_SPEC bool rrcCallConv setInitAmount (RRHandle handle, const char *sid, double initAmount)
 Set initial amount for an existing species. Initial amount/concentration set before will be unset. More...
 
C_DECL_SPEC bool rrcCallConv setInitAmountNoRegen (RRHandle handle, const char *sid, double initAmount)
 Set initial amount for an existing species, without regenerating it The last modification must regenerate for the modifications to take effect. More...
 
C_DECL_SPEC bool rrcCallConv setInitConcentration (RRHandle handle, const char *sid, double initConcentration)
 Set initial concentration for an existing species. Initial amount/concentration set before will be unset. More...
 
C_DECL_SPEC bool rrcCallConv setInitConcentrationNoRegen (RRHandle handle, const char *sid, double initConcentration)
 Set initial concentration for an existing species, without regenerating it The last modification must regenerate for the modifications to take effect. More...
 
C_DECL_SPEC bool rrcCallConv setConstant (RRHandle handle, const char *sid, bool constant)
 Set the constant attribute for an existing species/ parameter/ compartment. More...
 
C_DECL_SPEC bool rrcCallConv setConstantNoRegen (RRHandle handle, const char *sid, bool constant)
 Set the constant attribute for an existing species/ parameter/ compartment, without regenerating it The last modification must regenerate for the modifications to take effect. More...
 
C_DECL_SPEC bool rrcCallConv addReactionFromSBML (RRHandle handle, const char *sbmlRep)
 Add a reaction to the current model. More...
 
C_DECL_SPEC bool rrcCallConv addReactionFromSBMLNoRegen (RRHandle handle, const char *sbmlRep)
 Add a reaction to the current model, without regenerating it The last modification must regenerate for the modifications to take effect. More...
 
C_DECL_SPEC bool rrcCallConv addReaction (RRHandle handle, const char *rid, const char **reactants, int numReactants, const char **products, int numProducts, const char *kineticLaw)
 Add a reaction to the current model. More...
 
C_DECL_SPEC bool rrcCallConv addReactionNoRegen (RRHandle handle, const char *rid, const char **reactants, int numReactants, const char **products, int numProducts, const char *kineticLaw)
 Add a reaction to the current model, without regenerating it The last modification must regenerate for the modifications to take effect. More...
 
C_DECL_SPEC bool rrcCallConv removeReaction (RRHandle handle, const char *rid)
 Remove a reaction from the current model. More...
 
C_DECL_SPEC bool rrcCallConv removeReactionNoRegen (RRHandle handle, const char *rid)
 Remove a reaction from the current model, without regenerating it The last modification must regenerate for the modifications to take effect. More...
 
C_DECL_SPEC bool rrcCallConv setReversible (RRHandle handle, const char *rid, bool reversible)
 Set the reversible attribut for an existing reaction in the current model. More...
 
C_DECL_SPEC bool rrcCallConv setReversibleNoRegen (RRHandle handle, const char *rid, bool reversible)
 Set the reversible attribut for an existing reaction in the current model, without regenerating it The last modification must regenerate for the modifications to take effect. More...
 
C_DECL_SPEC bool rrcCallConv setKineticLaw (RRHandle handle, const char *rid, const char *kineticLaw)
 Set the kinetic law for a existing reaction in the current model. More...
 
C_DECL_SPEC bool rrcCallConv setKineticLawNoRegen (RRHandle handle, const char *rid, const char *kineticLaw)
 Set the kinetic law for a existing reaction in the current model, without regenerating it The last modification must regenerate for the modifications to take effect. More...
 
C_DECL_SPEC char *rrcCallConv getKineticLaw (RRHandle handle, const char *rid)
 Get the kinetic law for a existing reaction in the current model. More...
 
C_DECL_SPEC bool rrcCallConv addParameter (RRHandle handle, const char *pid, double value)
 Add a parameter to the current model. More...
 
C_DECL_SPEC bool rrcCallConv addParameterNoRegen (RRHandle handle, const char *pid, double value)
 Add a parameter to the current model, without regenerating it The last modification must regenerate for the modifications to take effect. More...
 
C_DECL_SPEC bool rrcCallConv removeParameter (RRHandle handle, const char *pid)
 Remove a parameter from the current model. More...
 
C_DECL_SPEC bool rrcCallConv removeParameterNoRegen (RRHandle handle, const char *pid)
 Remove a parameter from the current model, without regenerating it The last modification must regenerate for the modifications to take effect. More...
 
C_DECL_SPEC bool rrcCallConv addCompartment (RRHandle handle, const char *cid, double initVolume)
 Add a compartment to the current model. More...
 
C_DECL_SPEC bool rrcCallConv addCompartmentNoRegen (RRHandle handle, const char *cid, double initVolume)
 Add a compartment to the current model, without regenerating it The last modification must regenerate for the modifications to take effect. More...
 
C_DECL_SPEC bool rrcCallConv removeCompartment (RRHandle handle, const char *cid)
 Remove a compartment from the current model. More...
 
C_DECL_SPEC bool rrcCallConv removeCompartmentNoRegen (RRHandle handle, const char *cid)
 Remove a compartment from the current model, without regenerating it The last modification must regenerate for the modifications to take effect. More...
 
C_DECL_SPEC bool rrcCallConv addAssignmentRule (RRHandle handle, const char *vid, const char *formula)
 Add an assignment rule to the current model. More...
 
C_DECL_SPEC bool rrcCallConv addAssignmentRuleNoRegen (RRHandle handle, const char *vid, const char *formula)
 Add an assignment rule to the current model, without regenerating it The last modification must regenerate for the modifications to take effect. More...
 
C_DECL_SPEC bool rrcCallConv addRateRule (RRHandle handle, const char *vid, const char *formula)
 Add a rate rule to the current model. More...
 
C_DECL_SPEC bool rrcCallConv addRateRuleNoRegen (RRHandle handle, const char *vid, const char *formula)
 Add a rate rule to the current model, without regenerating it The last modification must regenerate for the modifications to take effect. More...
 
C_DECL_SPEC bool rrcCallConv removeRules (RRHandle handle, const char *vid)
 Remove rules related to given variable from the current model. More...
 
C_DECL_SPEC bool rrcCallConv removeRulesNoRegen (RRHandle handle, const char *vid)
 Remove rules related to given variable from the current model, without regenerating it The last modification must regenerate for the modifications to take effect. More...
 
C_DECL_SPEC bool rrcCallConv addEvent (RRHandle handle, const char *eid, bool useValuesFromTriggerTime, const char *trigger)
 Add an event to the current model. More...
 
C_DECL_SPEC bool rrcCallConv addEventNoRegen (RRHandle handle, const char *eid, bool useValuesFromTriggerTime, const char *trigger)
 Add an event to the current model, without regenerating it The last modification must regenerate for the modifications to take effect. More...
 
C_DECL_SPEC bool rrcCallConv addTrigger (RRHandle handle, const char *eid, const char *trigger)
 Add trigger to an existing event in the model If the given event already has a trigger object, the given trigger will replace the old trigger in the model. More...
 
C_DECL_SPEC bool rrcCallConv addTriggerNoRegen (RRHandle handle, const char *eid, const char *trigger)
 Add trigger to an existing event in the model, without regenerating it The last modification must regenerate for the modifications to take effect If the given event already has a trigger object, the given trigger will replace the old trigger in the model. More...
 
C_DECL_SPEC bool rrcCallConv setPersistent (RRHandle handle, const char *eid, bool persistent)
 Set the persistent attribute of the trigger of given event. More...
 
C_DECL_SPEC bool rrcCallConv setPersistentNoRegen (RRHandle handle, const char *eid, bool persistent)
 Set the persistent attribute of the trigger of given event, without regenerating it The last modification must regenerate for the modifications to take effect. More...
 
C_DECL_SPEC bool rrcCallConv setTriggerInitialValue (RRHandle handle, const char *eid, bool initValue)
 Set the initial value attribute of the trigger of given event. More...
 
C_DECL_SPEC bool rrcCallConv setTriggerInitialValueNoRegen (RRHandle handle, const char *eid, bool initValue)
 Set the initial value attribute of the trigger of given event, without regenerating it The last modification must regenerate for the modifications to take effect. More...
 
C_DECL_SPEC bool rrcCallConv addPriority (RRHandle handle, const char *eid, const char *priority)
 Add priority to an existing event in the model If the given event already has a priority object, the given priority will replace the old priority in the model. More...
 
C_DECL_SPEC bool rrcCallConv addPriorityNoRegen (RRHandle handle, const char *eid, const char *priority)
 Add priority to an existing event in the model, without regenerating it The last modification must regenerate for the modifications to take effect If the given event already has a priority object, the given priority will replace the old priority in the model. More...
 
C_DECL_SPEC bool rrcCallConv addDelay (RRHandle handle, const char *eid, const char *delay)
 Add delay to an existing event in the model If the given event already has a delay object, the given delay will replace the old delay in the model. More...
 
C_DECL_SPEC bool rrcCallConv addDelayNoRegen (RRHandle handle, const char *eid, const char *delay)
 Add delay to an existing event in the model, without regenerating it The last modification must regenerate for the modifications to take effect If the given event already has a delay object, the given delay will replace the old delay in the model. More...
 
C_DECL_SPEC bool rrcCallConv addEventAssignment (RRHandle handle, const char *eid, const char *vid, const char *formula)
 Add an event assignment to an existing event in the current model. More...
 
C_DECL_SPEC bool rrcCallConv addEventAssignmentNoRegen (RRHandle handle, const char *eid, const char *vid, const char *formula)
 Add an event assignment to an existing event in the current model, without regenerating it The last modification must regenerate for the modifications to take effect. More...
 
C_DECL_SPEC bool rrcCallConv removeEventAssignments (RRHandle handle, const char *eid, const char *vid)
 Remove event assignments for given variable from an existing event. More...
 
C_DECL_SPEC bool rrcCallConv removeEventAssignmentsNoRegen (RRHandle handle, const char *eid, const char *vid)
 Remove event assignments for given variable from an existing event, without regenerating it The last modification must regenerate for the modifications to take effect. More...
 
C_DECL_SPEC bool rrcCallConv removeEvent (RRHandle handle, const char *eid)
 Remove an event from the current model. More...
 
C_DECL_SPEC bool rrcCallConv removeEventsNoRegen (RRHandle handle, const char *eid)
 Remove an event from the current model, without regenerating it The last modification must regenerate for the modifications to take effect. More...
 
C_DECL_SPEC bool rrcCallConv validateCurrentSBML (RRHandle handle)
 Validate the current SBML file. More...
 
C_DECL_SPEC char *rrcCallConv getParamPromotedSBML (RRHandle handle, const char *sArg)
 Promote any local parameters to global status. More...
 
C_DECL_SPEC bool rrcCallConv setConfigurationXML (RRHandle handle, const char *caps)
 Set the simulator's capabilities. More...
 
C_DECL_SPEC char *rrcCallConv getConfigurationXML (RRHandle handle)
 Get the simulator's capabilities. More...
 
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...
 
C_DECL_SPEC bool rrcCallConv setTimeStart (RRHandle handle, double timeStart)
 Set the time start for a time course simulation. More...
 
C_DECL_SPEC bool rrcCallConv setTimeEnd (RRHandle handle, double timeEnd)
 Set the time end for a time course simulation. More...
 
C_DECL_SPEC bool rrcCallConv setNumPoints (RRHandle handle, int numberOfPoints)
 Set the number of points to generate in a time course simulation. More...
 
C_DECL_SPEC bool rrcCallConv setTimeCourseSelectionList (RRHandle handle, const char *list)
 Set the selection list for output from simulate(void) or simulateEx(void) More...
 
C_DECL_SPEC RRStringArrayPtr rrcCallConv getTimeCourseSelectionList (RRHandle handle)
 Get the current selection list for simulate(void) or simulateEx(void) More...
 
C_DECL_SPEC RRCDataPtr rrcCallConv simulate (RRHandle handle)
 Carry out a time-course simulation. setTimeStart, setTimeEnd, setNumPoints, etc are used to set the simulation characteristics. More...
 
C_DECL_SPEC RRCDataPtr rrcCallConv getSimulationResult (RRHandle handle)
 Retrieve the result of the last simulation. More...
 
C_DECL_SPEC RRCDataPtr rrcCallConv simulateEx (RRHandle handle, const double timeStart, const double timeEnd, const int numberOfPoints)
 Carry out a time-course simulation based on the given arguments, time start, time end and number of points. More...
 
C_DECL_SPEC bool rrcCallConv oneStep (RRHandle handle, const double currentTime, const double stepSize, double *value)
 Carry out a one step integration of the model. More...
 
C_DECL_SPEC bool rrcCallConv getTimeStart (RRHandle handle, double *timeStart)
 Get the value of the current time start. More...
 
C_DECL_SPEC bool rrcCallConv getTimeEnd (RRHandle handle, double *timeEnd)
 Get the value of the current time end. More...
 
C_DECL_SPEC bool rrcCallConv getNumPoints (RRHandle handle, int *numPoints)
 Get the value of the current number of points. More...
 
C_DECL_SPEC bool rrcCallConv steadyState (RRHandle handle, double *value)
 Compute the steady state of the current model. More...
 
C_DECL_SPEC RRVectorPtr rrcCallConv computeSteadyStateValues (RRHandle handle)
 A convenient method for returning a vector of the steady state species concentrations. More...
 
C_DECL_SPEC bool rrcCallConv setSteadyStateSelectionList (RRHandle handle, const char *list)
 Set the selection list of the steady state analysis. More...
 
C_DECL_SPEC RRStringArrayPtr rrcCallConv getSteadyStateSelectionList (RRHandle handle)
 Get the selection list for the steady state analysis. More...
 
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 RRVectorPtr rrcCallConv getFloatingSpeciesConcentrations (RRHandle handle)
 Retrieve in a vector the concentrations for all the floating species. More...
 
C_DECL_SPEC RRVectorPtr rrcCallConv getFloatingSpeciesAmounts (RRHandle handle)
 
C_DECL_SPEC RRVectorPtr rrcCallConv getBoundarySpeciesConcentrations (RRHandle handle)
 Retrieve the concentrations for all the boundary species in a vector. More...
 
C_DECL_SPEC RRVectorPtr rrcCallConv getBoundarySpeciesAmounts (RRHandle handle)
 
C_DECL_SPEC RRVectorPtr rrcCallConv getGlobalParameterValues (RRHandle handle)
 Retrieve the values for all the global parameter values in a vector. More...
 
C_DECL_SPEC bool rrcCallConv setBoundarySpeciesByIndex (RRHandle handle, const unsigned int index, const double value)
 Set the concentration for a particular boundary species. More...
 
C_DECL_SPEC bool rrcCallConv setFloatingSpeciesInitialConcentrationByIndex (RRHandle handle, int index, double value)
 Set the initial concentration for a particular floating species. More...
 
C_DECL_SPEC bool rrcCallConv getFloatingSpeciesInitialConcentrationByIndex (RRHandle handle, int index, double *value)
 Get the initial concentration for a particular floating species. More...
 
C_DECL_SPEC bool rrcCallConv setFloatingSpeciesByIndex (RRHandle handle, const int index, const double value)
 Set the concentration for a particular floating species. More...
 
C_DECL_SPEC bool rrcCallConv setGlobalParameterByIndex (RRHandle handle, const int index, const double value)
 Set the value for a particular global parameter. More...
 
C_DECL_SPEC bool rrcCallConv getBoundarySpeciesByIndex (RRHandle handle, const int index, double *value)
 Retrieve the concentration for a particular floating species. More...
 
C_DECL_SPEC bool rrcCallConv getFloatingSpeciesByIndex (RRHandle handle, const int index, double *value)
 Retrieve the concentration for a particular floating species. More...
 
C_DECL_SPEC bool rrcCallConv getGlobalParameterByIndex (RRHandle handle, const int index, double *value)
 Retrieve the global parameter value. More...
 
C_DECL_SPEC bool rrcCallConv getCompartmentByIndex (RRHandle handle, const int index, double *value)
 Retrieve the compartment volume for a particular compartment. More...
 
C_DECL_SPEC bool rrcCallConv setCompartmentByIndex (RRHandle handle, const int index, const double value)
 Set the volume for a particular compartment. More...
 
C_DECL_SPEC bool rrcCallConv setFloatingSpeciesConcentrations (RRHandle handle, const RRVectorPtr vec)
 Set the floating species concentration to the vector vec. More...
 
C_DECL_SPEC bool rrcCallConv setBoundarySpeciesConcentrations (RRHandle handle, const RRVectorPtr vec)
 Set the boundary species concentration to the vector vec. More...
 
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getFullJacobian (RRHandle handle)
 Retrieve the full Jacobian for the current model. More...
 
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getReducedJacobian (RRHandle handle)
 Retrieve the reduced Jacobian for the current model. More...
 
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getEigenvalues (RRHandle handle)
 Retrieve the eigenvalue matrix for the current model. More...
 
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getStoichiometryMatrix (RRHandle handle)
 Retrieve the stoichiometry matrix for the current model. More...
 
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getLinkMatrix (RRHandle handle)
 Retrieve the Link matrix for the current model. More...
 
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getNrMatrix (RRHandle handle)
 Retrieve the reduced stoichiometry matrix for the current model. More...
 
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getConservationMatrix (RRHandle handle)
 Retrieve the conservation matrix for the current model. More...
 
C_DECL_SPEC bool rrcCallConv setFloatingSpeciesInitialConcentrations (RRHandle handle, const RRVectorPtr vec)
 Set the initial floating species concentrations. More...
 
C_DECL_SPEC RRVectorPtr rrcCallConv getFloatingSpeciesInitialConcentrations (RRHandle handle)
 Get the initial floating species concentrations. More...
 
C_DECL_SPEC RRStringArrayPtr rrcCallConv getFloatingSpeciesInitialConditionIds (RRHandle handle)
 Get the initial floating species Ids. More...
 
C_DECL_SPEC RRStringArrayPtr rrcCallConv getFloatingSpeciesInitialConcentrationIds (RRHandle handle)
 Get the initial floating species Ids. More...
 
C_DECL_SPEC int rrcCallConv getNumberOfReactions (RRHandle handle)
 Obtain the number of reactions in the loaded model. More...
 
C_DECL_SPEC bool rrcCallConv getReactionRate (RRHandle handle, const int index, double *rate)
 Retrieve a give reaction rate as indicated by the index parameter. More...
 
C_DECL_SPEC RRVectorPtr rrcCallConv getReactionRates (RRHandle handle)
 Retrieve a vector of reaction rates as determined by the current state of the model. More...
 
C_DECL_SPEC RRVectorPtr rrcCallConv getReactionRatesEx (RRHandle handle, const RRVectorPtr vec)
 Retrieve a vector of reaction rates given a vector of species concentrations. More...
 
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...
 
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 int rrcCallConv getNumberOfCompartments (RRHandle handle)
 Returns the number of compartments in the model. More...
 
C_DECL_SPEC int rrcCallConv getNumberOfBoundarySpecies (RRHandle handle)
 Returns the number of boundary species in the model. More...
 
C_DECL_SPEC int rrcCallConv getNumberOfFloatingSpecies (RRHandle handle)
 Returns the number of floating species in the model. More...
 
C_DECL_SPEC int rrcCallConv getNumberOfGlobalParameters (RRHandle handle)
 Returns the number of global parameters in the model. More...
 
C_DECL_SPEC int rrcCallConv getNumberOfDependentSpecies (RRHandle handle)
 Returns the number of dependent species in the model. More...
 
C_DECL_SPEC int rrcCallConv getNumberOfIndependentSpecies (RRHandle handle)
 Returns the number of independent species in the model. More...
 
C_DECL_SPEC RRStringArrayPtr rrcCallConv getReactionIds (RRHandle handle)
 Obtain the list of reaction Ids. More...
 
C_DECL_SPEC RRStringArrayPtr rrcCallConv getBoundarySpeciesIds (RRHandle handle)
 Obtain the list of boundary species Ids. More...
 
C_DECL_SPEC RRStringArrayPtr rrcCallConv getBoundarySpeciesConcentrationIds (RRHandle handle)
 Obtain the list of boundary species concentration Ids. More...
 
C_DECL_SPEC RRStringArrayPtr rrcCallConv getFloatingSpeciesIds (RRHandle handle)
 Obtain the list of floating species Id. More...
 
C_DECL_SPEC RRStringArrayPtr rrcCallConv getDependentFloatingSpeciesIds (RRHandle handle)
 
C_DECL_SPEC RRStringArrayPtr rrcCallConv getFloatingSpeciesConcentrationIds (RRHandle handle)
 Obtain the list of floating species concentrations Id. More...
 
C_DECL_SPEC RRStringArrayPtr rrcCallConv getGlobalParameterIds (RRHandle handle)
 Obtain the list of global parameter Ids. More...
 
C_DECL_SPEC RRStringArrayPtr rrcCallConv getCompartmentIds (RRHandle handle)
 Obtain the list of compartment Ids. 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...
 
C_DECL_SPEC RRListPtr rrcCallConv getElasticityCoefficientIds (RRHandle handle)
 Obtain the list of elasticity coefficient Ids. More...
 
C_DECL_SPEC RRListPtr rrcCallConv getUnscaledFluxControlCoefficientIds (RRHandle handle)
 Obtain the list of unscaled flux control coefficient Ids. More...
 
C_DECL_SPEC RRListPtr rrcCallConv getFluxControlCoefficientIds (RRHandle handle)
 Obtain the list of flux control coefficient Ids. More...
 
C_DECL_SPEC RRListPtr rrcCallConv getUnscaledConcentrationControlCoefficientIds (RRHandle handle)
 Obtain the list of unscaled concentration control coefficient Ids. More...
 
C_DECL_SPEC RRListPtr rrcCallConv getConcentrationControlCoefficientIds (RRHandle handle)
 Obtain the list of concentration coefficient Ids. More...
 
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getUnscaledElasticityMatrix (RRHandle handle)
 Retrieve the unscaled elasticity matrix for the current model. More...
 
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getScaledElasticityMatrix (RRHandle handle)
 Retrieve the scaled elasticity matrix for the current model. More...
 
C_DECL_SPEC bool rrcCallConv getScaledFloatingSpeciesElasticity (RRHandle handle, const char *reactionId, const char *speciesId, double *value)
 Retrieve the scaled elasticity matrix for the current model. More...
 
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getUnscaledConcentrationControlCoefficientMatrix (RRHandle handle)
 Retrieve the matrix of unscaled concentration control coefficients for the current model. More...
 
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getScaledConcentrationControlCoefficientMatrix (RRHandle handle)
 Retrieve the matrix of scaled concentration control coefficients for the current model. More...
 
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getUnscaledFluxControlCoefficientMatrix (RRHandle handle)
 Retrieve the matrix of unscaled flux control coefficients for the current model. More...
 
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getScaledFluxControlCoefficientMatrix (RRHandle handle)
 Retrieve the matrix of scaled flux control coefficients for the current model. More...
 
C_DECL_SPEC bool rrcCallConv getuCC (RRHandle handle, const char *variable, const char *parameter, double *value)
 Retrieve a single unscaled control coefficient. More...
 
C_DECL_SPEC bool rrcCallConv getCC (RRHandle handle, const char *variable, const char *parameter, double *value)
 Retrieve a single control coefficient. More...
 
C_DECL_SPEC bool rrcCallConv getEE (RRHandle handle, const char *name, const char *species, double *value)
 Retrieve a single elasticity coefficient. More...
 
C_DECL_SPEC bool rrcCallConv getuEE (RRHandle handle, const char *name, const char *species, double *value)
 Retrieve a single unscaled elasticity coefficient. More...
 
C_DECL_SPEC bool rrcCallConv getSeed (RRHandle handle, long *seed)
 Determine the current seed used by the random generator. More...
 
C_DECL_SPEC bool rrcCallConv setSeed (RRHandle handle, long seed)
 Set the current seed used by the random generator. More...
 
C_DECL_SPEC RRCDataPtr rrcCallConv gillespie (RRHandle handle)
 Carry out a time-course simulation using the Gillespie algorithm with variable step size. setTimeStart, setTimeEnd, etc are used to set the simulation characteristics. More...
 
C_DECL_SPEC RRCDataPtr rrcCallConv gillespieEx (RRHandle handle, double timeStart, double timeEnd)
 Carry out a time-course simulation using the Gillespie algorithm based on the given arguments, time start, time end and number of points. More...
 
C_DECL_SPEC RRCDataPtr rrcCallConv gillespieOnGrid (RRHandle handle)
 Carry out a time-course simulation using the Gillespie algorithm with fixed step size. setTimeStart, setTimeEnd, setNumPoints, etc are used to set the simulation characteristics. More...
 
C_DECL_SPEC RRCDataPtr rrcCallConv gillespieOnGridEx (RRHandle handle, double timeStart, double timeEnd, int numberOfPoints)
 Carry out a time-course simulation using the Gillespie algorithm with fixed step size based on the given arguments, time start, time end, and number of points. More...
 
C_DECL_SPEC RRCDataPtr rrcCallConv gillespieMeanOnGrid (RRHandle handle, int numberOfSimulations)
 Carry out a series of time-course simulations using the Gillespie algorithm with fixed step size, then return the average of the simulations. setTimeStart, setTimeEnd, setNumPoints, etc are used to set the simulation characteristics. More...
 
C_DECL_SPEC RRCDataPtr rrcCallConv gillespieMeanOnGridEx (RRHandle handle, double timeStart, double timeEnd, int numberOfPoints, int numberOfSimulations)
 Carry out a series of time-course simulations using the Gillespie algorithm with fixed step size, then return the average of the simulations. Based on the given arguments, time start, time end, and number of points. More...
 
C_DECL_SPEC RRCDataPtr rrcCallConv gillespieMeanSDOnGrid (RRHandle handle, int numberOfSimulations)
 Carry out a series of time-course simulations using the Gillespie algorithm with fixed step size, then return the average and standard deviation of the simulations. setTimeStart, setTimeEnd, setNumPoints, etc are used to set the simulation characteristics. More...
 
C_DECL_SPEC RRCDataPtr rrcCallConv gillespieMeanSDOnGridEx (RRHandle handle, double timeStart, double timeEnd, int numberOfSteps, int numberOfSimulations)
 Carry out a series of time-course simulations using the Gillespie algorithm with fixed step size, then return the average and standard deviation of the simulations. Based on the given arguments, time start, time end, number of points, and number of simulations. More...
 
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...
 
C_DECL_SPEC int rrcCallConv setConfigBool (const char *key, int value)
 Set a boolean configuration value. More...
 
C_DECL_SPEC int rrcCallConv getConfigBool (const char *key)
 Get a boolean configuration value. More...
 
C_DECL_SPEC int rrcCallConv setConfigInt (const char *key, int value)
 Set an integer configuration value. More...
 
C_DECL_SPEC int rrcCallConv getConfigInt (const char *key)
 Get an integer configuration value. More...
 
C_DECL_SPEC int rrcCallConv setConfigDouble (const char *key, double value)
 Set a double configuration value. More...
 
C_DECL_SPEC int rrcCallConv _getNumIndFloatingSpecies (RRHandle handle)
 
C_DECL_SPEC int rrcCallConv _getNumRateRules (RRHandle handle)
 
C_DECL_SPEC double rrcCallConv _getTime (RRHandle handle)
 
C_DECL_SPEC int rrcCallConv _getStateVector (RRHandle handle)
 
C_DECL_SPEC void rrcCallConv _getStateVectorRate (RRHandle handle, double time, double *value)
 
C_DECL_SPEC double rrcCallConv getConfigDouble (const char *key)
 Get a double configuration value. More...
 
C_DECL_SPEC RRStringArrayPtr rrcCallConv getListOfConfigKeys ()
 Get a list of all possible config keys.
 

Detailed Description

libRoadRunner C wrappers 2012-2013

Author
Totte Karlsson & Herbert M Sauro

<-----------------------------------------------------------— This file is part of libRoadRunner. See http://code.google.com/p/roadrunnerlib/ for more details.

Copyright (C) 2012 University of Washington, Seattle, WA, USA

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

In plain english this means:

You CAN freely download and use this software, in whole or in part, for personal, company internal, or commercial purposes;

You CAN use the software in packages or distributions that you create.

You SHOULD include a copy of the license in any redistribution you may make;

You are NOT required include the source of software, or of any modifications you may have made to it, in any redistribution you may assemble that includes it.

YOU CANNOT:

redistribute any piece of this software without proper attribution;

Function Documentation

◆ _getNumIndFloatingSpecies()

C_DECL_SPEC int rrcCallConv _getNumIndFloatingSpecies ( RRHandle  handle)
Returns
the number of floating species pointed by the model by handle

◆ _getNumRateRules()

C_DECL_SPEC int rrcCallConv _getNumRateRules ( RRHandle  handle)
Returns
the number of rate rules pointed by the model by handle

◆ _getStateVector()

C_DECL_SPEC int rrcCallConv _getStateVector ( RRHandle  handle)
Returns
getsteadyvectorrate

◆ _getStateVectorRate()

C_DECL_SPEC void rrcCallConv _getStateVectorRate ( RRHandle  handle,
double  time,
double *  value 
)
Returns
getsteadyvectorrate

◆ _getTime()

C_DECL_SPEC double rrcCallConv _getTime ( RRHandle  handle)
Returns
the time for getsteadyvectorrate

◆ getParamPromotedSBML()

C_DECL_SPEC char* rrcCallConv getParamPromotedSBML ( RRHandle  handle,
const char *  sArg 
)

Promote any local parameters to global status.

This routine will convert any local reaction parameters and promote them to global status. The promoted parameters are prefixed with the name of the reaction to make them unique.

Parameters
[in]handleHandle to a RoadRunner instance
[in]sArgpoints to the SBML model to promote
Returns
Returns null if it fails otherwise it returns the promoted SBML model as a string

◆ getVersion()

C_DECL_SPEC int rrcCallConv getVersion ( )

Get the version number.

Returns
the roadrunner version number in the form or 102030 if the number is 1.2.3

returns the individual version numbers as XXYYZZ where XX is the major version, YY the minor and ZZ the revision, eg 10000, or 10100, 20000 etc

◆ getVersionEx()

C_DECL_SPEC char* rrcCallConv getVersionEx ( )

returns something like "1.0.0; compiled with clang "3.3 (tags/RELEASE_33/final)" on date Dec 8 2013, 17:24:57'

◆ getVersionStr()

C_DECL_SPEC char* rrcCallConv getVersionStr ( )

returns roadrunner as a string, i.e. "1.0.0"