Read and write models

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

Functions
C_DECL_SPEC bool rrcCallConv	loadSBML (RRHandle handle, const char *sbml)
	Load a model from an SBML string. More...
C_DECL_SPEC bool rrcCallConv	loadSBMLEx (RRHandle handle, const char *sbml, bool forceRecompile)
	Load a model from an SBML string. More...
C_DECL_SPEC bool rrcCallConv	saveState (RRHandle handle, const char *filename)
	Save a road runner instance's state to a platform-specific binary file. More...
C_DECL_SPEC bool rrcCallConv	loadState (RRHandle handle, const char *filename)
	Reload a road runner instance's state saved by saveState. More...
C_DECL_SPEC bool rrcCallConv	loadSBMLFromFile (RRHandle handle, const char *fileName)
	Load a model from a SBML file. More...
C_DECL_SPEC bool rrcCallConv	loadSBMLFromFileE (RRHandle handle, const char *fileName, bool forceRecompile)
	Load a model from a SBML file, force recompilation. More...
C_DECL_SPEC bool rrcCallConv	clearModel (RRHandle handle)
	Unload current model. More...
C_DECL_SPEC bool rrcCallConv	isModelLoaded (RRHandle handle)
	check if a model is loaded More...
C_DECL_SPEC bool rrcCallConv	loadSimulationSettings (RRHandle handle, const char *fileName)
	Load simulation settings from a file. More...
C_DECL_SPEC char *rrcCallConv	getCurrentSBML (RRHandle handle)
	Retrieve the current state of the model in the form of an SBML string. More...
C_DECL_SPEC char *rrcCallConv	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

clearModel()

C_DECL_SPEC bool rrcCallConv clearModel

(

RRHandle

handle

)

Unload current model.

Parameters

[in]

handle

Handle to a RoadRunner instance

Returns

Returns true if successful

getCurrentSBML()

C_DECL_SPEC char* rrcCallConv getCurrentSBML

(

RRHandle

handle

)

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

Parameters

[in]

handle

Handle to a RoadRunner instance

Returns

Returns null if the call fails, otherwise returns a pointer to the SBML string

getSBML()

C_DECL_SPEC char* rrcCallConv getSBML

(

RRHandle

handle

)

Retrieve the SBML model that was last loaded into roadRunner.

Parameters

[in]

handle

Handle to a RoadRunner instance

Returns

Returns null if the call fails, otherwise returns a pointer to the SBML string

isModelLoaded()

C_DECL_SPEC bool rrcCallConv isModelLoaded

(

RRHandle

handle

)

check if a model is loaded

Parameters

[in]

handle

Handle to a RoadRunner instance

Returns

Returns true/false indicating whether a model is loaded or not

loadSBML()

C_DECL_SPEC bool rrcCallConv loadSBML	(	RRHandle	handle,
		const char *	sbml
	)

Load a model from an SBML string.

Parameters

[in]	handle	Handle to a RoadRunner instance
[in]	sbml	string

Returns

Returns true if successful

loadSBMLEx()

C_DECL_SPEC bool rrcCallConv loadSBMLEx	(	RRHandle	handle,
		const char *	sbml,
		bool	forceRecompile
	)

Load a model from an SBML string.

Parameters

[in]	handle	Handle to a RoadRunner instance
[in]	sbml	string
[in]	forceRecompile	boolean. True means the model is recompiled. False causes roadrunner to use an already compiled model

Returns

Returns true if successful

loadSBMLFromFile()

C_DECL_SPEC bool rrcCallConv loadSBMLFromFile	(	RRHandle	handle,
		const char *	fileName
	)

Load a model from a SBML file.

Parameters

[in]	handle	Handle to a RoadRunner instance
[in]	fileName	file name (or full path) to file that holds the SBML model

Returns

Returns true if successful

loadSBMLFromFileE()

C_DECL_SPEC bool rrcCallConv loadSBMLFromFileE	(	RRHandle	handle,
		const char *	fileName,
		bool	forceRecompile
	)

Load a model from a SBML file, force recompilation.

Parameters

[in]	handle	Handle to a RoadRunner instance
[in]	fileName	file name (or full path) to file that holds the SBML model
[in]	forceRecompile	Boolean that forces recompilation if true. If false, no compilation occur if model dll exists

Returns

Returns true if successful

loadSimulationSettings()

C_DECL_SPEC bool rrcCallConv loadSimulationSettings	(	RRHandle	handle,
		const char *	fileName
	)

Load simulation settings from a file.

Parameters

[in]	handle	Handle to a RoadRunner instance
[in]	fileName	file name (or full path) to file that holds simulation settings

Returns

Returns true if successful

loadState()

C_DECL_SPEC bool rrcCallConv loadState	(	RRHandle	handle,
		const char *	filename
	)

Reload a road runner instance's state saved by saveState.

Parameters

[in]	handle	Handle to the RoadRunner instance to be loaded into
[in]	filename	path to the file to be loaded from

Returns

Returns true if successful

saveState()

C_DECL_SPEC bool rrcCallConv saveState	(	RRHandle	handle,
		const char *	filename
	)

Save a road runner instance's state to a platform-specific binary file.

Parameters

[in]	handle	Handle to the RoadRunner instance to be saved
[in]	filename	path to the file to be saved to

Returns

Returns true if successful