libRoadRunner C API  1.0.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Functions
Read and write models

Read and write models to files or strings. Support for SBML formats. More...

Functions

bool loadSBML (RRHandle handle, const char *sbml)
 Load a model from an SBML string. More...
 
bool loadSBMLEx (RRHandle handle, const char *sbml, bool forceRecompile)
 Load a model from an SBML string. More...
 
bool loadSBMLFromFile (RRHandle handle, const char *fileName)
 Load a model from a SBML file. More...
 
bool loadSBMLFromFileE (RRHandle handle, const char *fileName, bool forceRecompile)
 Load a model from a SBML file, force recompilation. More...
 
bool clearModel (RRHandle handle)
 Unload current model. More...
 
bool isModelLoaded (RRHandle handle)
 check if a model is loaded More...
 
bool loadSimulationSettings (RRHandle handle, const char *fileName)
 Load simulation settings from a file. More...
 
char * getCurrentSBML (RRHandle handle)
 Retrieve the current state of the model in the form of an SBML string. More...
 
char * getSBML (RRHandle handle)
 Retrieve the SBML model that was last loaded into roadRunner. More...
 

Detailed Description

Read and write models to files or strings. Support for SBML formats.

Function Documentation

bool clearModel ( RRHandle  handle)

Unload current model.

Parameters
[in]handleHandle to a RoadRunner instance
Returns
Returns true if successful
char * getCurrentSBML ( RRHandle  handle)

Retrieve the current state of the model in the form of an SBML string.

Parameters
[in]handleHandle to a RoadRunner instance
Returns
Returns null if the call fails, otherwise returns a pointer to the SBML string
char * getSBML ( RRHandle  handle)

Retrieve the SBML model that was last loaded into roadRunner.

Parameters
[in]handleHandle to a RoadRunner instance
Returns
Returns null if the call fails, otherwise returns a pointer to the SBML string
bool isModelLoaded ( RRHandle  handle)

check if a model is loaded

Parameters
[in]handleHandle to a RoadRunner instance
Returns
Returns true/false indicating whether a model is loaded or not
bool loadSBML ( RRHandle  handle,
const char *  sbml 
)

Load a model from an SBML string.

Parameters
[in]handleHandle to a RoadRunner instance
[in]sbmlstring
Returns
Returns true if successful
bool loadSBMLEx ( RRHandle  handle,
const char *  sbml,
bool  forceRecompile 
)

Load a model from an SBML string.

Parameters
[in]handleHandle to a RoadRunner instance
[in]sbmlstring
[in]forceRecompileboolean. True means the model is recompiled. False causes roadrunner to use an already compiled model
Returns
Returns true if successful
bool loadSBMLFromFile ( RRHandle  handle,
const char *  fileName 
)

Load a model from a SBML file.

Parameters
[in]handleHandle to a RoadRunner instance
[in]fileNamefile name (or full path) to file that holds the SBML model
Returns
Returns true if successful
bool loadSBMLFromFileE ( RRHandle  handle,
const char *  fileName,
bool  forceRecompile 
)

Load a model from a SBML file, force recompilation.

Parameters
[in]handleHandle to a RoadRunner instance
[in]fileNamefile name (or full path) to file that holds the SBML model
[in]forceRecompileBoolean that forces recompilation if true. If false, no compilation occur if model dll exists
Returns
Returns true if successful
bool loadSimulationSettings ( RRHandle  handle,
const char *  fileName 
)

Load simulation settings from a file.

Parameters
[in]handleHandle to a RoadRunner instance
[in]fileNamefile name (or full path) to file that holds simulation settings
Returns
Returns true if successful