libRoadRunner C API  1.0.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Functions
Library initialization and termination methods

Initialize library and terminate library instance. More...

Functions

RRHandle createRRInstance (void)
 Initialize a new roadRunner instance and return a handle to it. More...
 
RRHandle createRRInstanceEx (const char *tempFolder, const char *compiler)
 Initialize a new roadRunner instance and return a handle to it. More...
 
bool freeRRInstance (RRHandle handle)
 Free the roadRunner instance. More...
 
char * getInstallFolder (void)
 Returns the folder in which the RoadRunner API is installed. More...
 
bool setInstallFolder (const char *folder)
 Set the internal string containing the folder in where the RoadRunner C API is installed. More...
 
bool setComputeAndAssignConservationLaws (RRHandle handle, const bool On_Or_Off)
 Enable or disable conservation analysis. More...
 

Detailed Description

Initialize library and terminate library instance.

Function Documentation

RRHandle createRRInstance ( void  )

Initialize a new roadRunner instance and return a handle to it.

Returns
Returns a RoadRunner instance, returns null if it fails
RRHandle createRRInstanceEx ( const char *  tempFolder,
const char *  compiler 
)

Initialize a new roadRunner instance and return a handle to it.

Parameters
[in]tempFolderset the roadrunner temporary folder
[in]compilermay be NULL, if NULL, uses default compiler. If LLVM build is enabled, setting compiler to "llvm" enables llvm based model generation.
Returns
Returns a RoadRunner instance, returns null if it fails
Parameters
[in]tempFolderset roadrunners temporary folder
[in]compilermay be NULL, if NULL, uses default compiler. If LLVM build is enabled, setting compiler to "llvm" enables llvm based model generation.
Returns
Returns a RoadRunner instance, returns null if it fails
bool freeRRInstance ( RRHandle  handle)

Free the roadRunner instance.

Parameters
[in]handleHandle to a RoadRunner instance
char * getInstallFolder ( void  )

Returns the folder in which the RoadRunner API is installed.

Returns
Pointer to string holding the install folder
bool setComputeAndAssignConservationLaws ( RRHandle  handle,
const bool  On_Or_Off 
)

Enable or disable conservation analysis.

Parameters
[in]handleHandle to a RoadRunner instance
[in]On_Or_OffSet true to switch on conservation analysis
Returns
Returns true if successful
bool setInstallFolder ( const char *  folder)

Set the internal string containing the folder in where the RoadRunner C API is installed.

Parameters
[in]folderPointer to string holding the install folder
Returns
Boolean indicating success