Utility functions

Various miscellaneous routines that return useful inforamtion about the library. More...

Functions
char *	getAPIVersion (void)
	Retrieve the current version number of the C API library. More...
char *	getCPPAPIVersion (RRHandle handle)
	Retrieve the current version number of the C++ API (Core RoadRunner API) library. More...
char *	getExtendedAPIInfo ()
	Retrieve extended API info. More...
char *	getBuildDate (void)
	Retrieve the current build date of the library. More...
char *	getBuildTime (void)
	Retrieve the current build time (HH:MM:SS) of the library. More...
char *	getBuildDateTime (void)
	Retrieve the current build date + time of the library. More...
char *	getCopyright (void)
	Retrieve the current copyright notice for the library. More...
char *	getInfo (RRHandle handle)
	Retrieve info about current state of roadrunner, e.g. loaded model, conservationAnalysis etc. More...
char *	getlibSBMLVersion (RRHandle handle)
	Retrieve the current version number of the libSBML library. More...
bool	setTempFolder (RRHandle handle, const char *folder)
	Set the path to the temporary folder where the C code will be stored. More...
char *	getTempFolder (RRHandle handle)
	Retrieve the current temporary folder path. More...
char *	getWorkingDirectory (void)
	Retrieve the current working directory path. More...
char *	getRRCAPILocation (void)
	Retrieve the directory path of the shared rrCApi library. More...
bool	setCompiler (RRHandle handle, const char *fNameWithPath)
	Set the path and filename to the compiler to be used by roadrunner. More...
char *	getCompiler (RRHandle handle)
	Get the name of the compiler currently being used by roadrunner.
bool	setCompilerLocation (RRHandle handle, const char *folder)
	Set the path to a folder containing the compiler to be used. More...
char *	getCompilerLocation (RRHandle handle)
	Get the path to a folder containing the compiler being used. More...
bool	setSupportCodeFolder (RRHandle handle, const char *folder)
	Set the path to a folder containing support code for model generation. More...
char *	getSupportCodeFolder (RRHandle handle)
	Get the path to a folder containing support code. More...
bool	setCodeGenerationMode (RRHandle handle, int mode)
	Set the runtime generation option [Not yet implemented]. More...

Detailed Description

Various miscellaneous routines that return useful inforamtion about the library.

Function Documentation

char* getAPIVersion

(

void

)

Retrieve the current version number of the C API library.

Returns

Returns null if it fails, otherwise it returns the version number of the C API library

char* getBuildDate

(

void

)

Retrieve the current build date of the library.

Returns

Returns null if it fails, otherwise it returns the build date

char* getBuildDateTime

(

void

)

Retrieve the current build date + time of the library.

Returns

Returns null if it fails, otherwise it returns the build date + time

char* getBuildTime

(

void

)

Retrieve the current build time (HH:MM:SS) of the library.

Returns

Returns null if it fails, otherwise it returns the build time

char* getCompilerLocation

(

RRHandle

handle

)

Get the path to a folder containing the compiler being used.

Parameters

[in]

handle

Handle to a RoadRunner instance

Returns

Returns the path if succesful, NULL otherwise

char* getCopyright

(

void

)

Retrieve the current copyright notice for the library.

Returns

Returns null if it fails, otherwise it returns the copyright string

char* getCPPAPIVersion

(

RRHandle

handle

)

Retrieve the current version number of the C++ API (Core RoadRunner API) library.

Parameters

[in]

handle

RoadRunner instance handle

Returns

Returns null if it fails, otherwise it returns the version number of the C++ API library

char* getExtendedAPIInfo

(

)

Retrieve extended API info.

Returns

Returns null if it fails, otherwise it returns a string with the info

char* getInfo

(

RRHandle

handle

)

Retrieve info about current state of roadrunner, e.g. loaded model, conservationAnalysis etc.

Parameters

[in]

handle

Handle to a RoadRunner instance

Returns

Returns null if it fails, otherwise it returns a string with the info

char* getlibSBMLVersion

(

RRHandle

handle

)

Retrieve the current version number of the libSBML library.

Parameters

[in]

handle

Handle to a RoadRunner instance

Returns

Returns null if it fails, otherwise it returns the version number of the library

char* getRRCAPILocation

(

void

)

Retrieve the directory path of the shared rrCApi library.

Returns

Returns null if it fails, otherwise it returns the path

char* getSupportCodeFolder

(

RRHandle

handle

)

Get the path to a folder containing support code.

Parameters

[in]

handle

Handle to a RoadRunner instance

Returns

Returns the path if succesful, NULL otherwise

char* getTempFolder

(

RRHandle

handle

)

Retrieve the current temporary folder path.

When cRoadRunner is run in C generation mode its uses a temporary folder to store the generate C source code. This method can be used to get the current value for the the temporary folder path.

Parameters

[in]

handle

Handle to a RoadRunner instance

Returns

Returns null if it fails, otherwise it returns the path

char* getWorkingDirectory

(

void

)

Retrieve the current working directory path.

Returns

Returns null if it fails, otherwise it returns the path

bool setCodeGenerationMode	(	RRHandle	handle,
		int	mode
	)

Set the runtime generation option [Not yet implemented].

cRoadRunner can either execute a model by generating, compiling and linking self-generated C code or it can employ an internal interpreter to evaluate the model equations. The later method is useful when the OS forbids the compiling of externally generated code.

Parameters

[in]	handle	Handle to a RoadRunner instance
[in]	mode	is set to 0 cRoadRunner generates C Code, if set to 1 cRoadRunner uses its internal math interpreter.

Returns

Returns false if it fails,

bool setCompiler	(	RRHandle	handle,
		const char *	fNameWithPath
	)

Set the path and filename to the compiler to be used by roadrunner.

Parameters

[in]	handle	Handle to a RoadRunner instance
[in]	fNameWithPath	Pointer to string holding the fileName and path to a compiler

Returns

Returns true if succesful

bool setCompilerLocation	(	RRHandle	handle,
		const char *	folder
	)

Set the path to a folder containing the compiler to be used.

Parameters

[in]	handle	Handle to a RoadRunner instance
[in]	folder	Pointer to string holding the path to a compiler

Returns

Returns true if succesful

bool setSupportCodeFolder	(	RRHandle	handle,
		const char *	folder
	)

Set the path to a folder containing support code for model generation.

Parameters

[in]	handle	Handle to a RoadRunner instance
[in]	folder	Pointer to string holding the path to the support code folder

Returns

Returns true if succesful

bool setTempFolder	(	RRHandle	handle,
		const char *	folder
	)

Set the path to the temporary folder where the C code will be stored.

When cRoadRunner is run in C generation mode its uses a temporary folder to store the generated C source code. This method can be used to set the temporary folder path if necessary.

Parameters

[in]	handle	Handle to a RoadRunner instance
[in]	folder	Pointer to string holdind folder path

Returns

Returns true if succesful