libroadrunner C API
Functions
Edit models

Add or remove species or reactions without modifying SBML files and reloading. More...

Functions

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...
 

Detailed Description

Add or remove species or reactions without modifying SBML files and reloading.

Function Documentation

◆ addAssignmentRule()

C_DECL_SPEC bool rrcCallConv addAssignmentRule ( RRHandle  handle,
const char *  vid,
const char *  formula 
)

Add an assignment rule to the current model.

Parameters
[in]handleHandle to a RoadRunner instance
[in]vidID of variable that rules assigns formula to
[in]formulathe math formula of assignment rule to be added
Returns
Returns false if the call fails, otherwise returns a true

◆ addAssignmentRuleNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]vidID of variable that rules assigns formula to
[in]formulathe math formula of assignment rule to be added
Returns
Returns false if the call fails, otherwise returns a true

◆ addCompartment()

C_DECL_SPEC bool rrcCallConv addCompartment ( RRHandle  handle,
const char *  cid,
double  initVolume 
)

Add a compartment to the current model.

Parameters
[in]handleHandle to a RoadRunner instance
[in]cidID of the compartment to be added
[in]initVolumethe initial volume of the compartment to be added
Returns
Returns false if the call fails, otherwise returns a true

◆ addCompartmentNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]cidID of the compartment to be added
[in]initVolumethe initial volume of the compartment to be added
Returns
Returns false if the call fails, otherwise returns a true

◆ addDelay()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]eidID of the event to add delay
[in]prioritythe math formula of event priority
Returns
Returns false if the call fails, otherwise returns a true

◆ addDelayNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]eidID of the event to add delay
[in]delaythe math formula of event delay
Returns
Returns false if the call fails, otherwise returns a true

◆ addEvent()

C_DECL_SPEC bool rrcCallConv addEvent ( RRHandle  handle,
const char *  eid,
bool  useValuesFromTriggerTime,
const char *  trigger 
)

Add an event to the current model.

Parameters
[in]handleHandle to a RoadRunner instance
[in]eidID of the event to be added
[in]useValuesFromTriggerTimeindicate the moment at which the event�s assignments are to be evaluated
[in]triggerthe math formula of event trigger
Returns
Returns false if the call fails, otherwise returns a true

◆ addEventAssignment()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]eidID of the event to add assignment
[in]vidthe ID of the variable to assign formula
[in]fomulathe math formula to assign
Returns
Returns false if the call fails, otherwise returns a true

◆ addEventAssignmentNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]eidID of the event to add assignment
[in]vidthe ID of the variable to assign formula
[in]fomulathe math formula to assign
Returns
Returns false if the call fails, otherwise returns a true

◆ addEventNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]eidID of the event to be added
[in]useValuesFromTriggerTimeindicate the moment at which the event�s assignments are to be evaluated
[in]triggerthe math formula of event trigger
Returns
Returns false if the call fails, otherwise returns a true

◆ addParameter()

C_DECL_SPEC bool rrcCallConv addParameter ( RRHandle  handle,
const char *  pid,
double  value 
)

Add a parameter to the current model.

Parameters
[in]handleHandle to a RoadRunner instance
[in]pidID of the parameter to be added
[in]valuethe value of the parameter to be added
Returns
Returns false if the call fails, otherwise returns a true

◆ addParameterNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]pidID of the parameter to be added
[in]valuethe value of the parameter to be added
Returns
Returns false if the call fails, otherwise returns a true

◆ addPriority()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]eidID of the event to add priority
[in]prioritythe math formula of event priority
Returns
Returns false if the call fails, otherwise returns a true

◆ addPriorityNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]eidID of the event to add priority
[in]prioritythe math formula of event priority
Returns
Returns false if the call fails, otherwise returns a true

◆ addRateRule()

C_DECL_SPEC bool rrcCallConv addRateRule ( RRHandle  handle,
const char *  vid,
const char *  formula 
)

Add a rate rule to the current model.

Parameters
[in]handleHandle to a RoadRunner instance
[in]vidID of variable that rules assigns formula to
[in]formulathe he math formula of rate rule to be added
Returns
Returns false if the call fails, otherwise returns a true

◆ addRateRuleNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]vidID of variable that rules assigns formula to
[in]formulathe he math formula of rate rule to be added
Returns
Returns false if the call fails, otherwise returns a true

◆ addReaction()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]ridID of the reaction to be added
[in]reactantsList of reactants ID of reaction to be added, double value could be inserted before ID as stoichiometry
[in]numReactantsNumber of reactants of reaction to be added
[in]productsList of products ID of reaction to be added, double value could be inserted before ID as stoichiometry
[in]numProductsNumber of products of reaction to be added
[in]kineticLawkinetic formular of reaction to be added
Returns
Returns false if the call fails, otherwise returns a true

◆ addReactionFromSBML()

C_DECL_SPEC bool rrcCallConv addReactionFromSBML ( RRHandle  handle,
const char *  sbmlRep 
)

Add a reaction to the current model.

Parameters
[in]handleHandle to a RoadRunner instance
[in]sbmlRepthe SBML representation (i.e. a reaction tag) describing the reaction to be added
Returns
Returns false if the call fails, otherwise returns a true

◆ addReactionFromSBMLNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]sbmlRepthe SBML representation (i.e. a reaction tag) describing the reaction to be added
Returns
Returns false if the call fails, otherwise returns a true

◆ addReactionNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]ridID of the reaction to be added
[in]reactantsList of reactants ID of reaction to be added
[in]numReactantsNumber of reactants of reaction to be added
[in]productsList of products ID of reaction to be added
[in]numProductsNumber of products of reaction to be added
[in]kineticLawkinetic formular of reaction to be added
Returns
Returns false if the call fails, otherwise returns a true

◆ addSpecies()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]sidID of the species to be added
[in]compartmentCompartment of the species to be added
[in]initialAmountInitial amount of the species to be added
[in]substanceUnitSubstance unit of the species to be added
Returns
Returns false if the call fails, otherwise returns a true

◆ addSpeciesNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]sidID of the species to be added
[in]compartmentCompartment of the species to be added
[in]initialAmountInitial amount of the species to be added
[in]substanceUnitSubstance unit of the species to be added
Returns
Returns false if the call fails, otherwise returns a true

◆ addTrigger()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]eidID of the event to add trigger
[in]triggerthe math formula of event trigger
Returns
Returns false if the call fails, otherwise returns a true

◆ addTriggerNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]eidID of the event to add trigger
[in]triggerthe math formula of event trigger
Returns
Returns false if the call fails, otherwise returns a true

◆ getKineticLaw()

C_DECL_SPEC char* rrcCallConv getKineticLaw ( RRHandle  handle,
const char *  rid 
)

Get the kinetic law for a existing reaction in the current model.

Parameters
[in]handleHandle to a RoadRunner instance
[in]ridID of reaction to be modified
Returns
Returns the kinetic law.

◆ removeCompartment()

C_DECL_SPEC bool rrcCallConv removeCompartment ( RRHandle  handle,
const char *  cid 
)

Remove a compartment from the current model.

Parameters
[in]handleHandle to a RoadRunner instance
[in]cidID of the compartment to be removed
Returns
Returns false if the call fails, otherwise returns a true

◆ removeCompartmentNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]cidID of the compartment to be removed
Returns
Returns false if the call fails, otherwise returns a true

◆ removeEvent()

C_DECL_SPEC bool rrcCallConv removeEvent ( RRHandle  handle,
const char *  eid 
)

Remove an event from the current model.

Parameters
[in]handleHandle to a RoadRunner instance
[in]eidID of the event to be removed
Returns
Returns false if the call fails, otherwise returns a true

◆ removeEventAssignments()

C_DECL_SPEC bool rrcCallConv removeEventAssignments ( RRHandle  handle,
const char *  eid,
const char *  vid 
)

Remove event assignments for given variable from an existing event.

Parameters
[in]handleHandle to a RoadRunner instance
[in]eidID of the event
[in]vidthe ID of the variable of the event assignments
Returns
Returns false if the call fails, otherwise returns a true

◆ removeEventAssignmentsNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]eidID of the event
[in]vidthe ID of the variable of the event assignments
Returns
Returns false if the call fails, otherwise returns a true

◆ removeEventsNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]eidID of the event to be removed
Returns
Returns false if the call fails, otherwise returns a true

◆ removeParameter()

C_DECL_SPEC bool rrcCallConv removeParameter ( RRHandle  handle,
const char *  pid 
)

Remove a parameter from the current model.

Parameters
[in]handleHandle to a RoadRunner instance
[in]pidID of the parameter to be removed
Returns
Returns false if the call fails, otherwise returns a true

◆ removeParameterNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]pidID of the parameter to be removed
Returns
Returns false if the call fails, otherwise returns a true

◆ removeReaction()

C_DECL_SPEC bool rrcCallConv removeReaction ( RRHandle  handle,
const char *  rid 
)

Remove a reaction from the current model.

Parameters
[in]handleHandle to a RoadRunner instance
[in]ridID of the reaction to be removed
Returns
Returns false if the call fails, otherwise returns a true

◆ removeReactionNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]ridID of the reaction to be removed
Returns
Returns false if the call fails, otherwise returns a true

◆ removeRules()

C_DECL_SPEC bool rrcCallConv removeRules ( RRHandle  handle,
const char *  vid 
)

Remove rules related to given variable from the current model.

Parameters
[in]handleHandle to a RoadRunner instance
[in]vidID of variable that rules assigns formula to
Returns
Returns false if the call fails, otherwise returns a true

◆ removeRulesNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]vidID of variable that rules assigns formula to
Returns
Returns false if the call fails, otherwise returns a true

◆ removeSpecies()

C_DECL_SPEC bool rrcCallConv removeSpecies ( RRHandle  handle,
const char *  sid 
)

Remove a species from the current model.

Parameters
[in]handleHandle to a RoadRunner instance
[in]sidID of the species to be removed
Returns
Returns false if the call fails, otherwise returns a true

◆ removeSpeciesNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]sidID of the species to be removed
Returns
Returns false if the call fails, otherwise returns a true

◆ setBoundary()

C_DECL_SPEC bool rrcCallConv setBoundary ( RRHandle  handle,
const char *  sid,
bool  boundaryCondition 
)

Set the boundary condition of an existing species.

Parameters
[in]handleHandle to a RoadRunner instance
[in]sidID of the species
[in]boundaryConditionBoundary condition to be set
Returns
Returns false if the call fails, otherwise returns a true

◆ setBoundaryNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]sidID of the species
[in]boundaryConditionBoundary condition to be set
Returns
Returns false if the call fails, otherwise returns a true

◆ setConstant()

C_DECL_SPEC bool rrcCallConv setConstant ( RRHandle  handle,
const char *  sid,
bool  constant 
)

Set the constant attribute for an existing species/ parameter/ compartment.

Parameters
[in]handleHandle to a RoadRunner instance
[in]sidID of the species/ parameter/ compartment
[in]constantThe constant attribute to be set
Returns
Returns false if the call fails, otherwise returns a true

◆ setConstantNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]sidID of the species/ parameter/ compartment
[in]constantThe constant attribute to be set
Returns
Returns false if the call fails, otherwise returns a true

◆ setHasOnlySubstanceUnits()

C_DECL_SPEC bool rrcCallConv setHasOnlySubstanceUnits ( RRHandle  handle,
const char *  sid,
bool  hasOnlySubstanceUnits 
)

Set the hasOnlySubstanceUnits attribute for an existing species.

Parameters
[in]handleHandle to a RoadRunner instance
[in]sidID of the species
[in]hasOnlySubstanceUnitsValue of hasOnlySubstanceUnits attribute to be set
Returns
Returns false if the call fails, otherwise returns a true

◆ setHasOnlySubstanceUnitsNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]sidID of the species
[in]hasOnlySubstanceUnitsValue of hasOnlySubstanceUnits attribute to be set
Returns
Returns false if the call fails, otherwise returns a true

◆ setInitAmount()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]sidID of the species
[in]initAmountInitial amount to be set
Returns
Returns false if the call fails, otherwise returns a true

◆ setInitAmountNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]sidID of the species
[in]initAmountInitial amount to be set
Returns
Returns false if the call fails, otherwise returns a true

◆ setInitConcentration()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]sidID of the species
[in]initConcentrationInitial concentration to be set
Returns
Returns false if the call fails, otherwise returns a true

◆ setInitConcentrationNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]sidID of the species
[in]initConcentrationInitial concentration to be set
Returns
Returns false if the call fails, otherwise returns a true

◆ setKineticLaw()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]ridID of reaction to be modified
[in]kineticLawthe kinetic formular of reaction
Returns
Returns false if the call fails, otherwise returns a true

◆ setKineticLawNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]ridID of reaction to be modified
[in]kineticLawthe kinetic formular of reaction
Returns
Returns false if the call fails, otherwise returns a true

◆ setPersistent()

C_DECL_SPEC bool rrcCallConv setPersistent ( RRHandle  handle,
const char *  eid,
bool  persistent 
)

Set the persistent attribute of the trigger of given event.

Parameters
[in]handleHandle to a RoadRunner instance
[in]eidID of the event of the trigger
[in]reversibleReversible attribute to be set
Returns
Returns false if the call fails, otherwise returns a true

◆ setPersistentNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]eidID of the event of the trigger
[in]reversibleReversible attribute to be set
Returns
Returns false if the call fails, otherwise returns a true

◆ setReversible()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]ridthe ID of reaction to be modified
[in]reversibleReversible attribute to be set
Returns
Returns false if the call fails, otherwise returns a true

◆ setReversibleNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]ridID of reaction to be modified
[in]reversibleReversible attribute to be set
Returns
Returns false if the call fails, otherwise returns a true

◆ setTriggerInitialValue()

C_DECL_SPEC bool rrcCallConv setTriggerInitialValue ( RRHandle  handle,
const char *  eid,
bool  initValue 
)

Set the initial value attribute of the trigger of given event.

Parameters
[in]handleHandle to a RoadRunner instance
[in]eidID of the event of the trigger
[in]initValueInitial value attribute to be set
Returns
Returns false if the call fails, otherwise returns a true

◆ setTriggerInitialValueNoRegen()

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.

Parameters
[in]handleHandle to a RoadRunner instance
[in]eidID of the event of the trigger
[in]initValueInitial value attribute to be set
Returns
Returns false if the call fails, otherwise returns a true

◆ validateCurrentSBML()

C_DECL_SPEC bool rrcCallConv validateCurrentSBML ( RRHandle  handle)

Validate the current SBML file.

Parameters
[in]handleHandle to a RoadRunner instance
Returns
Returns false if the current SBML file is not valid, otherwise returns a true