Set and Get information on compartments. More...

Functions
C_DECL_SPEC bool rrcCallConv	getCompartmentByIndex (RRHandle handle, const int index, double *value)
	Retrieve the compartment volume for a particular compartment. More...

C_DECL_SPEC bool rrcCallConv	setCompartmentByIndex (RRHandle handle, const int index, const double value)
	Set the volume for a particular compartment. More...

C_DECL_SPEC int rrcCallConv	getNumberOfCompartments (RRHandle handle)
	Returns the number of compartments in the model. More...

C_DECL_SPEC RRStringArrayPtr rrcCallConv	getCompartmentIds (RRHandle handle)
	Obtain the list of compartment Ids. More...

Detailed Description

Set and Get information on compartments.

Function Documentation

C_DECL_SPEC bool rrcCallConv getCompartmentByIndex	(	RRHandle	handle,
		const int	index,
		double *	value
	)

Retrieve the compartment volume for a particular compartment.

Parameters

[in]	handle	Handle to a RoadRunner instance
[in]	index	The index to the compartment (corresponds to position in getCompartmentIds(RRHandle handle))
[in]	value	The value returned by the method

C_DECL_SPEC RRStringArrayPtr rrcCallConv getCompartmentIds ( RRHandle handle )

Obtain the list of compartment Ids.

Example:

C_DECL_SPEC RRStringArrayPtr rrcCallConv getCompartmentIds(RRHandle handle)

Obtain the list of compartment Ids.

void * RRHandle

Void pointer to a RoadRunner instance.

Definition: rrc_types.h:50

Parameters

[in] handle Handle to a RoadRunner instance

Returns: Returns -1 if it fails, if successful it returns a pointer to a RRStringArrayPtr struct

C_DECL_SPEC int rrcCallConv getNumberOfCompartments ( RRHandle handle )

Returns the number of compartments in the model.

Parameters

[in] handle Handle to a RoadRunner instance

C_DECL_SPEC bool rrcCallConv setCompartmentByIndex	(	RRHandle	handle,
		const int	index,
		const double	value
	)

Set the volume for a particular compartment.

Parameters

[in]	handle	Handle to a RoadRunner instance
[in]	index	The index to the compartment (corresponds to position in getCompartmentIds(RRHandle handle))
[in]	value	The volume of the compartment to set