libroadrunner C API
Functions
Library initialization and termination methods

Initialize library and terminate library instance. More...

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

Detailed Description

Initialize library and terminate library instance.

Function Documentation

◆ createRRInstance()

C_DECL_SPEC RRHandle rrcCallConv createRRInstance ( void  )

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

Returns
Returns a RoadRunner instance, returns null if it fails

◆ createRRInstanceEx()

C_DECL_SPEC RRHandle rrcCallConv createRRInstanceEx ( const char *  tempFolder,
const char *  compiler 
)

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

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

◆ freeRRInstance()

C_DECL_SPEC bool rrcCallConv freeRRInstance ( RRHandle  handle)

Free the roadRunner instance.

Parameters
[in]handleHandle to a RoadRunner instance

◆ getComputeAndAssignConservationLaws()

C_DECL_SPEC int rrcCallConv getComputeAndAssignConservationLaws ( RRHandle  handle,
int *  value 
)

Get the value of the moiety conservation setting.

Parameters
[in]handleHandle to a RoadRunner instance
[out]valueA place to store the value
Returns
Returns true if successful

◆ getInstallFolder()

char* getInstallFolder ( void  )

Returns the folder in which the RoadRunner wrappers is installed.

Returns
Pointer to string holding the install folder

◆ setComputeAndAssignConservationLaws()

C_DECL_SPEC bool rrcCallConv 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

◆ setInstallFolder()

C_DECL_SPEC bool rrcCallConv setInstallFolder ( const char *  folder)

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

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