Utility Functions

Functions to help and assist in the use of the Plugins framework. More...

Functions
RRCDataPtr	createRRCData (RRDataHandle rrDataHandle)
	Create a RoadRunner C data structure (RRCDataPtr) from RoadRunner data. More...
int	getRRCDataNumRows (RRCDataPtr rrData)
	Retrieve the number of rows in the given RoadRunner C numberical data (returned from simulate(RRHandle handle)) More...
int	getRRCDataNumCols (RRCDataPtr rrData)
	Retrieve the number of columns in the given rrCData data (returned form simulat(RRHandle handle)) More...
bool	getRRCDataElementF (RRCDataPtr rrcData, int r, int c, double *value)
	Retrieves an element at a given row and column from a RRCData struct type variable. More...
bool	getRoadRunnerDataElement (RRDataHandle rrData, int r, int c, double *value)
	Retrieves an element at a given row and column from a RoadRunner data type variable. More...
char *	stringArrayToStringFWD (const RRStringArrayPtr list)
	Returns a string list in string form. More...
char *	getLastPluginError ()
	Return last API error. More...

Detailed Description

Functions to help and assist in the use of the Plugins framework.

Function Documentation

RRCDataPtr createRRCData

(

RRDataHandle

rrDataHandle

)

Create a RoadRunner C data structure (RRCDataPtr) from RoadRunner data.

Parameters

rrDataHandle

A pointer to a RoadRunner numerical data type variable

Returns

Returns NULL if fails, otherwise returns a RRCData handle

char* getLastPluginError

(

)

Return last API error.

Returns

Returns a string with the error

Note

Forwarded from roadruners C API

bool getRoadRunnerDataElement	(	RRDataHandle	rrData,
		int	r,
		int	c,
		double *	value
	)

Retrieves an element at a given row and column from a RoadRunner data type variable.

RoadRunner numerical data are indexed from zero

Example:

status = getRoadRunnerDataElement (rrDataHandle, 2, 4, *value); 

Parameters

	rrcData	A Handle o a RoadRunner data type variable
	r	-The row index to the rrData data
	c	- The column index to the rrData data
[out]	value	- The retrieved value from the rrData data

Returns

Returns true if succesful

bool getRRCDataElementF	(	RRCDataPtr	rrcData,
		int	r,
		int	c,
		double *	value
	)

Retrieves an element at a given row and column from a RRCData struct type variable.

RoadRunner numerical data are indexed from zero

Example:

status = getRRCDataElement (rrData, 2, 4, *value); 

Parameters

	rrcData	A pointer to a rrCData type variable
	r	-The row index to the rrData data
	c	- The column index to the rrData data
[out]	value	- The retrieved value from the rrData data

Returns

Returns true if succesful

Note

The F indicate this is a forwarde fucntion from RoadRUnners C API.

int getRRCDataNumCols

(

RRCDataPtr

rrData

)

Retrieve the number of columns in the given rrCData data (returned form simulat(RRHandle handle))

Example:

nRows = getResultNumCols (rrData); 

Parameters

rrData

A pointer to a rrData type variable

Returns

Returns -1 if fails, otherwise returns the number of columns

int getRRCDataNumRows

(

RRCDataPtr

rrData

)

Retrieve the number of rows in the given RoadRunner C numberical data (returned from simulate(RRHandle handle))

Example:

nRows = getRRDataNumRows (result); 

Parameters

rrData

A pointer to a RoadRunner numerical data type variable

Returns

Returns -1 if fails, otherwise returns the number of rows

char* stringArrayToStringFWD

(

const RRStringArrayPtr

list

)

Returns a string list in string form.

Returns

Returns string list as a character string

Note

Forwarded from roadruners C API