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

Functions
C_DECL_SPEC char *rrcCallConv	getAPIVersion (void)
	Retrieve the current version number of the C wrappers library. More...

C_DECL_SPEC char *rrcCallConv	getCPPAPIVersion (RRHandle handle)
	Retrieve the current version number of the C++ wrappers (Core RoadRunner wrappers) library. More...

C_DECL_SPEC char *rrcCallConv	getExtendedAPIInfo ()
	Retrieve extended wrappers info. More...

C_DECL_SPEC char *rrcCallConv	getBuildDate (void)
	Retrieve the current build date of the library. More...

C_DECL_SPEC char *rrcCallConv	getBuildTime (void)
	Retrieve the current build time (HH:MM:SS) of the library. More...

C_DECL_SPEC char *rrcCallConv	getBuildDateTime (void)
	Retrieve the current build date + time of the library. More...

C_DECL_SPEC char *rrcCallConv	getCopyright (void)
	Retrieve the current copyright notice for the library. More...

C_DECL_SPEC char *rrcCallConv	getInfo (RRHandle handle)
	Retrieve info about current state of roadrunner, e.g. loaded model, conservationAnalysis etc. More...

C_DECL_SPEC char *rrcCallConv	getlibSBMLVersion (RRHandle handle)
	Retrieve the current version number of the libSBML library. More...

C_DECL_SPEC bool rrcCallConv	setTempFolder (RRHandle handle, const char *folder)
	Set the path to the temporary folder where the C code will be stored. More...

C_DECL_SPEC char *rrcCallConv	getTempFolder (RRHandle handle)
	Retrieve the current temporary folder path. More...

C_DECL_SPEC char *rrcCallConv	getWorkingDirectory (void)
	Retrieve the current working directory path. More...

C_DECL_SPEC char *rrcCallConv	getRRCAPILocation (void)
	Retrieve the directory path of the shared rrCApi library. More...

C_DECL_SPEC bool rrcCallConv	setCompiler (RRHandle handle, const char *fNameWithPath)
	Set the path and filename to the compiler to be used by roadrunner. More...

C_DECL_SPEC char *rrcCallConv	getCompiler (RRHandle handle)
	Get the name of the compiler currently being used by roadrunner.

C_DECL_SPEC bool rrcCallConv	setCompilerLocation (RRHandle handle, const char *folder)
	Set the path to a folder containing the compiler to be used. More...

C_DECL_SPEC char *rrcCallConv	getCompilerLocation (RRHandle handle)
	Get the path to a folder containing the compiler being used. More...

C_DECL_SPEC bool rrcCallConv	setSupportCodeFolder (RRHandle handle, const char *folder)
	Set the path to a folder containing support code for model generation. More...

C_DECL_SPEC char *rrcCallConv	getSupportCodeFolder (RRHandle handle)
	Get the path to a folder containing support code. More...

C_DECL_SPEC bool rrcCallConv	setCodeGenerationMode (RRHandle handle, int mode)
	Set the runtime generation option [Not yet implemented]. More...

Detailed Description

Various miscellaneous routines that return useful information about the library.

Function Documentation

◆ getAPIVersion()

C_DECL_SPEC char* rrcCallConv getAPIVersion ( void )

Retrieve the current version number of the C wrappers library.

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

◆ getBuildDate()

C_DECL_SPEC char* rrcCallConv getBuildDate ( void )

Retrieve the current build date of the library.

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

◆ getBuildDateTime()

C_DECL_SPEC char* rrcCallConv getBuildDateTime ( void )

Retrieve the current build date + time of the library.

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

◆ getBuildTime()

C_DECL_SPEC char* rrcCallConv 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

◆ getCompilerLocation()

C_DECL_SPEC char* rrcCallConv 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 successful, NULL otherwise

◆ getCopyright()

C_DECL_SPEC char* rrcCallConv getCopyright ( void )

Retrieve the current copyright notice for the library.

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

◆ getCPPAPIVersion()

C_DECL_SPEC char* rrcCallConv getCPPAPIVersion ( RRHandle handle )

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

Parameters

[in] handle RoadRunner instance handle

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

◆ getExtendedAPIInfo()

C_DECL_SPEC char* rrcCallConv getExtendedAPIInfo ( )

Retrieve extended wrappers info.

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

◆ getInfo()

C_DECL_SPEC char* rrcCallConv 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

◆ getlibSBMLVersion()

C_DECL_SPEC char* rrcCallConv 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

◆ getRRCAPILocation()

C_DECL_SPEC char* rrcCallConv getRRCAPILocation ( void )

Retrieve the directory path of the shared rrCApi library.

Returns: Returns null if it fails, otherwise it returns the path

◆ getSupportCodeFolder()

C_DECL_SPEC char* rrcCallConv 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 successful, NULL otherwise

◆ getTempFolder()

C_DECL_SPEC char* rrcCallConv getTempFolder ( RRHandle handle )

Retrieve the current temporary folder path.

When RoadRunner 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 temporary folder path.

Parameters

[in] handle Handle to a RoadRunner instance

Returns: Returns null if it fails, otherwise it returns the path

◆ getWorkingDirectory()

C_DECL_SPEC char* rrcCallConv getWorkingDirectory ( void )

Retrieve the current working directory path.

Returns: Returns null if it fails, otherwise it returns the path

◆ setCodeGenerationMode()

C_DECL_SPEC bool rrcCallConv setCodeGenerationMode	(	RRHandle	handle,
		int	mode
	)

Set the runtime generation option [Not yet implemented].

RoadRunner 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 RoadRunner generates C Code, if set to 1 RoadRunner uses its internal math interpreter.

Returns: Returns false if it fails,

◆ setCompiler()

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

◆ setCompilerLocation()

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

◆ setSupportCodeFolder()

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

◆ setTempFolder()

C_DECL_SPEC bool rrcCallConv setTempFolder	(	RRHandle	handle,
		const char *	folder
	)

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

When RoadRunner 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 holding folder path

Returns: Returns true if successful

Functions

Detailed Description

Function Documentation

◆ getAPIVersion()

◆ getBuildDate()

◆ getBuildDateTime()

◆ getBuildTime()

◆ getCompilerLocation()

◆ getCopyright()

◆ getCPPAPIVersion()

◆ getExtendedAPIInfo()

◆ getInfo()

◆ getlibSBMLVersion()

◆ getRRCAPILocation()

◆ getSupportCodeFolder()

◆ getTempFolder()

◆ getWorkingDirectory()

◆ setCodeGenerationMode()

◆ setCompiler()

◆ setCompilerLocation()

◆ setSupportCodeFolder()

◆ setTempFolder()