Plugin Parameters

Plugins Parameter related functions. More...

Functions
RRParameterHandle	createParameter (const char *label, const char *type, const char *hint, void *value)
	Create a parameter of type "type". More...
bool	freeParameter (RRParameterHandle para)
	Free the memory created by a parameter. More...
bool	addParameterToList (RRParametersHandle handle, RRParameterHandle para)
	Add a parameter to a parameters container, from a parameter pointer. More...
bool	setParameterByString (RRParameterHandle handle, const char *value)
	Set a parameter by a string. More...
bool	getBoolParameter (RRParameterHandle handle, bool *value)
	Get a boolean parameter. More...
bool	setBoolParameter (RRParameterHandle handle, bool value)
	Set a boolean parameter. More...
bool	setIntParameter (RRParameterHandle handle, int value)
	Set an int parameter. More...
bool	getIntParameter (RRParameterHandle handle, int *value)
	Get the value of an int parameter. More...
bool	setDoubleParameter (RRParameterHandle handle, double value)
	Set a double parameter. More...
bool	getDoubleParameter (RRParameterHandle handle, double *value)
	Get the value of a double parameter. More...
bool	setStringParameter (RRParameterHandle handle, char *value)
	Set a string (char*) parameter. More...
bool	getStringParameter (RRParameterHandle handle, const char *(*value))
	Get the value of a string (char*) parameter. More...
bool	setListParameter (RRParameterHandle handle, void *(value))
	Set a listOfParameters (Parameters) parameter. More...
bool	getListParameter (RRParameterHandle handle, void *(value))
	Get the value of a listOfParameters (Parameters) parameter. More...
bool	setRoadRunnerDataParameter (RRParameterHandle handle, void *value)
	Set a roadRunnerDataParameter parameter. More...
bool	getRoadRunnerDataParameter (RRParameterHandle handle, void *value)
	Get the value of a roadRunnerDataParameter parameter. More...
char *	getParameterInfo (RRParameterHandle handle)
	Get a parameters info. More...
char *	getParameterValueAsString (RRParameterHandle handle)
	Get a parameters value as char*. More...
void *	getParameterValueHandle (RRParameterHandle handle)
	Get a handle to a parameters value. More...
char *	getParameterName (RRParameterHandle handle)
	Get a parameters name. More...
char *	getParameterHint (RRParameterHandle handle)
	Get a parameters hint. More...
bool	setParameterHint (RRParameterHandle handle, const char *value)
	Set a parameters hint. More...
char *	getParameterDescription (RRParameterHandle handle)
	Get a parameters description. More...
bool	setParameterDescription (RRParameterHandle handle, const char *value)
	Set a parameters Description. More...
char *	getParameterType (RRParameterHandle handle)
	Get a parameters type. More...
RRParameterHandle	getFirstParameter (RRParametersHandle handle)
RRParameterHandle	getNextParameter (RRParametersHandle handle)
RRParameterHandle	getPreviousParameter (RRParametersHandle handle)
RRParameterHandle	getCurrentParameter (RRParametersHandle handle)

Detailed Description

Plugins Parameter related functions.

Function Documentation

bool addParameterToList	(	RRParametersHandle	handle,
		RRParameterHandle	para
	)

Add a parameter to a parameters container, from a parameter pointer.

Parameters

handle	Handle to a RoadRunner instance
para	Handle to a roadrunner parameter

Returns

Returns a booelan indicating success

RRParameterHandle createParameter	(	const char *	label,
		const char *	type,
		const char *	hint,
		void *	value
	)

Create a parameter of type "type".

Parameters

label	The parameters label as a string
type	The parameters type as string. Possible values can be 'double', 'int', 'char*' etc,
hint	The parameters hint as string.
value	The parameters initial value casted to a (void*) pointer

Returns

Returns a handle to a new parameter, if succesful, NULL otherwise

bool freeParameter

(

RRParameterHandle

para

)

Free the memory created by a parameter.

Parameters

paraHandle

A handle to the parameter

Returns

Returns true if sucessful, false otherwise

bool getBoolParameter	(	RRParameterHandle	handle,
		bool *	value
	)

Get a boolean parameter.

Parameters

handle	to a Parameter instance
value	to assign to the parameter.

Returns

Returns true if sucessful, false otherwise

bool getDoubleParameter	(	RRParameterHandle	handle,
		double *	value
	)

Get the value of a double parameter.

Parameters

handle	to a Parameter instance
value	to assign to the parameter.

Returns

Returns true if sucessful, false otherwise

bool getIntParameter	(	RRParameterHandle	handle,
		int *	value
	)

Get the value of an int parameter.

Parameters

handle	to a Parameter instance
value	to assign to the parameter.

Returns

Returns true if sucessful, false otherwise

bool getListParameter	(	RRParameterHandle	handle,
		void *	value
	)

Get the value of a listOfParameters (Parameters) parameter.

Parameters

handle	to a Parameter instance
value	to assign to the parameter.

Returns

Returns true if sucessful, false otherwise

char* getParameterDescription

(

RRParameterHandle

handle

)

Get a parameters description.

Parameters

handle

to a Parameter instance

Returns

Returns the parameters description as a string sucessful, NULL otherwise

char* getParameterHint

(

RRParameterHandle

handle

)

Get a parameters hint.

Parameters

handle

to a Parameter instance

Returns

Returns the parameters hint if sucessful, NULL otherwise

char* getParameterInfo

(

RRParameterHandle

handle

)

Get a parameters info.

Parameters

handle

Handle to a parameter instance

Returns

Returns informational text about the parameter if sucessful, NULL otherwise

char* getParameterName

(

RRParameterHandle

handle

)

Get a parameters name.

Parameters

handle

to a Parameter instance

Returns

Returns the parameters name if sucessful, NULL otherwise

char* getParameterType

(

RRParameterHandle

handle

)

Get a parameters type.

Parameters

handle

to a Parameter instance

Returns

Returns the parameters type if sucessful, NULL otherwise

char* getParameterValueAsString

(

RRParameterHandle

handle

)

Get a parameters value as char*.

Parameters

handle

to a Parameter instance

Returns

Returns the parameters value if sucessful, NULL otherwise

void* getParameterValueHandle

(

RRParameterHandle

handle

)

Get a handle to a parameters value.

Parameters

handle

to a Parameter instance

Returns

Returns a Handle to the parameters value if sucessful, NULL otherwise

bool getRoadRunnerDataParameter	(	RRParameterHandle	handle,
		void *	value
	)

Get the value of a roadRunnerDataParameter parameter.

Parameters

handle	to a Parameter instance
value	to assign to the parameter.

Returns

Returns true if sucessful, false otherwise

bool getStringParameter	(	RRParameterHandle	handle,
		const char **	value
	)

Get the value of a string (char*) parameter.

Parameters

handle	to a Parameter instance
value	to assign to the parameter.

Returns

Returns true if sucessful, false otherwise

bool setBoolParameter	(	RRParameterHandle	handle,
		bool	value
	)

Set a boolean parameter.

Parameters

handle	to a Parameter instance
value	to assign to the parameter.

Returns

Returns true if sucessful, false otherwise

bool setDoubleParameter	(	RRParameterHandle	handle,
		double	value
	)

Set a double parameter.

Parameters

handle	to a Parameter instance
value	to assign to the parameter.

Returns

Returns true if sucessful, false otherwise

bool setIntParameter	(	RRParameterHandle	handle,
		int	value
	)

Set an int parameter.

Parameters

handle	to a Parameter instance
value	to assign to the parameter.

Returns

Returns true if sucessful, false otherwise

bool setListParameter	(	RRParameterHandle	handle,
		void *	value
	)

Set a listOfParameters (Parameters) parameter.

Parameters

handle	to a Parameter instance
value	to assign to the parameter.

Returns

Returns true if sucessful, false otherwise

bool setParameterByString	(	RRParameterHandle	handle,
		const char *	value
	)

Set a parameter by a string.

Parameters

handle	to a Parameter instance
value	Pointer to string holding the value to assign to the parameter, e.g. "0.01" to set a double to 0.01

Returns

Returns true if sucessful, false otherwise

bool setParameterDescription	(	RRParameterHandle	handle,
		const char *	value
	)

Set a parameters Description.

Parameters

handle	to a Parameter instance
value	The parameter description as a string

Returns

Returns true if sucessful, false otherwise

bool setParameterHint	(	RRParameterHandle	handle,
		const char *	value
	)

Set a parameters hint.

Parameters

handle	to a Parameter instance
value	The parameter hint as a string

Returns

Returns true if sucessful, false otherwise

bool setRoadRunnerDataParameter	(	RRParameterHandle	handle,
		void *	value
	)

Set a roadRunnerDataParameter parameter.

Parameters

handle	to a Parameter instance
value	to assign to the parameter.

Returns

Returns true if sucessful, false otherwise

bool setStringParameter	(	RRParameterHandle	handle,
		char *	value
	)

Set a string (char*) parameter.

Parameters

handle	to a Parameter instance
value	to assign to the parameter.

Returns

Returns true if sucessful, false otherwise