rrp_parameter_api.h

Go to the documentation of this file.

#ifndef rrp_parameter_apiH
#define rrp_parameter_apiH
#include "rrp_exporter.h"
#include "rrp_types.h"
//---------------------------------------------------------------------------

#if defined(__cplusplus)
namespace rrp { extern "C" {
#endif

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

RRP_DECLSPEC bool rrp_cc freeParameter(RRParameterHandle para);


RRP_DECLSPEC bool rrp_cc addParameterToList(RRParametersHandle handle, RRParameterHandle para);

RRP_DECLSPEC bool rrp_cc setParameterByString(RRParameterHandle handle, const char* value);

RRP_DECLSPEC bool rrp_cc getBoolParameter(RRParameterHandle handle, bool* value);

RRP_DECLSPEC bool rrp_cc setBoolParameter(RRParameterHandle handle, bool value);

RRP_DECLSPEC bool rrp_cc setIntParameter(RRParameterHandle handle, int value);

RRP_DECLSPEC bool rrp_cc getIntParameter(RRParameterHandle handle, int *value);

RRP_DECLSPEC bool rrp_cc setDoubleParameter(RRParameterHandle handle, double value);

RRP_DECLSPEC bool rrp_cc getDoubleParameter(RRParameterHandle handle, double *value);

RRP_DECLSPEC bool rrp_cc setStringParameter(RRParameterHandle handle, char* value);

RRP_DECLSPEC bool rrp_cc getStringParameter(RRParameterHandle handle, const char* (*value));

RRP_DECLSPEC bool rrp_cc setListParameter(RRParameterHandle handle, void* (value));

RRP_DECLSPEC bool rrp_cc getListParameter(RRParameterHandle handle, void* (value));


RRP_DECLSPEC bool rrp_cc setRoadRunnerDataParameter(RRParameterHandle handle, void* value);

RRP_DECLSPEC bool rrp_cc getRoadRunnerDataParameter(RRParameterHandle handle, void* value);

RRP_DECLSPEC char* rrp_cc getParameterInfo(RRParameterHandle handle);

RRP_DECLSPEC char* rrp_cc getParameterValueAsString(RRParameterHandle handle);

RRP_DECLSPEC void* rrp_cc getParameterValueHandle(RRParameterHandle handle);

RRP_DECLSPEC char* rrp_cc getParameterName(RRParameterHandle handle);

RRP_DECLSPEC char* rrp_cc getParameterHint(RRParameterHandle handle);

RRP_DECLSPEC bool rrp_cc setParameterHint(RRParameterHandle handle, const char* value);

RRP_DECLSPEC char* rrp_cc getParameterDescription(RRParameterHandle handle);

RRP_DECLSPEC bool rrp_cc setParameterDescription(RRParameterHandle handle, const char* value);

RRP_DECLSPEC char* rrp_cc getParameterType(RRParameterHandle handle);


RRP_DECLSPEC RRParameterHandle rrp_cc getFirstParameter(RRParametersHandle handle);
RRP_DECLSPEC RRParameterHandle rrp_cc getNextParameter(RRParametersHandle handle);
RRP_DECLSPEC RRParameterHandle rrp_cc getPreviousParameter(RRParametersHandle handle);
RRP_DECLSPEC RRParameterHandle rrp_cc getCurrentParameter(RRParametersHandle handle);

RRP_DECLSPEC char* rrp_cc getNamesFromParameterList(RRParametersHandle handle);

RRP_DECLSPEC bool rrp_cc clearParameterList(RRParametersHandle handle);

#if defined(__cplusplus)
}}    //rrc namespace
#endif
  

#endif