rrp_api.h

Go to the documentation of this file.

#ifndef rrp_apiH
#define rrp_apiH
#include "rrp_exporter.h"
#include "rrp_types.h"
#include "rrp_parameter_api.h"
//---------------------------------------------------------------------------

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

RRP_DECLSPEC RRPluginManagerHandle rrp_cc createPluginManager(const char* pluginDir);

// \brief Create a new instance of a plugin manager.
// \brief A PluginManager manages a collection of plugins, loaded and unloaded by
//  the load and unload API functions respectively.
// \param pluginDir Full path to folder containing plugins.
// \return On success, a handle to a Plugin manager, on failure, NULL.
//
// \ingroup plugin_manager
// */
//RRP_DECLSPEC RRPluginManagerHandle rrp_cc createPluginManagerEx(const char* pluginDir);

RRP_DECLSPEC bool rrp_cc freePluginManager(RRPluginManagerHandle handle);

RRP_DECLSPEC bool rrp_cc loadPlugins(RRPluginManagerHandle handle);

RRP_DECLSPEC bool rrp_cc unLoadPlugins(RRPluginManagerHandle handle);

RRP_DECLSPEC RRPluginHandle rrp_cc loadPlugin(RRPluginManagerHandle handle, const char* pluginName);

RRP_DECLSPEC bool rrp_cc unLoadPlugin(RRPluginManagerHandle handle, RRPluginHandle plugin);

RRP_DECLSPEC int rrp_cc getNumberOfPlugins(RRPluginManagerHandle handle);

RRP_DECLSPEC char* rrp_cc getPluginNames(RRPluginManagerHandle handle);

RRP_DECLSPEC char* rrp_cc getPluginLibraryNames(RRPluginManagerHandle handle);

RRP_DECLSPEC RRPluginHandle rrp_cc getFirstPlugin(RRPluginManagerHandle handle);

RRP_DECLSPEC RRPluginHandle rrp_cc getNextPlugin(RRPluginManagerHandle handle);

RRP_DECLSPEC RRPluginHandle rrp_cc getPreviousPlugin(RRPluginManagerHandle handle);

RRP_DECLSPEC RRPluginHandle rrp_cc getCurrentPlugin(RRPluginManagerHandle handle);

RRP_DECLSPEC RRPluginHandle rrp_cc getPlugin(RRPluginManagerHandle handle, const char* pluginName);

RRP_DECLSPEC long rrp_cc getPluginSharedLibHandle(RRPluginManagerHandle handle, RRPluginHandle pluginHandle);


//==========================  PLUGIN HANDLE functions
RRP_DECLSPEC char* rrp_cc getPluginName(RRPluginHandle handle);

RRP_DECLSPEC char* rrp_cc getPluginInfo(RRPluginHandle handle);

RRP_DECLSPEC unsigned char* rrp_cc getPluginManualAsPDF(RRPluginHandle handle);

RRP_DECLSPEC unsigned int rrp_cc getPluginManualNrOfBytes(RRPluginHandle handle);

RRP_DECLSPEC bool rrp_cc assignRoadRunnerInstance(RRPluginHandle pHandle, RRHandle rrHandle);

RRP_DECLSPEC bool rrp_cc executePlugin(RRPluginHandle handle);

RRP_DECLSPEC bool rrp_cc executePluginEx(RRPluginHandle handle, bool inAThread);

RRP_DECLSPEC char* rrp_cc getPluginStatus(RRPluginHandle handle);

RRP_DECLSPEC char* rrp_cc getPluginResult(RRPluginHandle handle);

RRP_DECLSPEC bool rrp_cc resetPlugin(RRPluginHandle handle);

RRP_DECLSPEC bool rrp_cc isPluginWorking(RRPluginHandle handle);

RRP_DECLSPEC void rrp_cc terminateWork(RRPluginHandle handle);

RRP_DECLSPEC bool rrp_cc isBeingTerminated(RRPluginHandle handle);

RRP_DECLSPEC bool rrp_cc wasTerminated(RRPluginHandle handle);

RRP_DECLSPEC bool rrp_cc assignOnStartedEvent(RRPluginHandle handle, PluginEvent cb, void* userData1, void* userData2);

RRP_DECLSPEC bool rrp_cc assignOnProgressEvent(RRPluginHandle handle, PluginEvent cb, void* userData1, void* userData2);

RRP_DECLSPEC bool rrp_cc assignOnFinishedEvent(RRPluginHandle handle, PluginEvent cb, void* userData1, void* userData2);

RRP_DECLSPEC bool rrp_cc assignPluginInput(RRPluginHandle handle, void* userData);

RRP_DECLSPEC RRHandle rrp_cc getRRHandleFromPlugin(RRPluginHandle handle);

RRP_DECLSPEC char* rrp_cc getPluginPropertiesAsXML(RRPluginHandle handle);

RRP_DECLSPEC RRParametersHandle rrp_cc getPluginParameters(RRPluginHandle handle);

RRP_DECLSPEC char* rrp_cc getListOfPluginParameterNames(RRPluginHandle handle);

RRP_DECLSPEC RRParameterHandle rrp_cc getPluginParameter(RRPluginHandle handle, const char* parameterName);

RRP_DECLSPEC bool rrp_cc setPluginParameter(RRPluginHandle handle, const char* parameterName, const char* value);

RRP_DECLSPEC RRDataHandle rrp_cc getRoadRunnerDataHandle(RRHandle handle);

RRP_DECLSPEC RRCDataPtr rrp_cc createRRCData(RRDataHandle rrDataHandle);

RRP_DECLSPEC int rrp_cc getRRCDataNumRows (RRCDataPtr rrData);

RRP_DECLSPEC int rrp_cc getRRCDataNumCols (RRCDataPtr rrData);

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


RRP_DECLSPEC bool           rrp_cc getRoadRunnerDataElement(RRDataHandle rrData, int r, int c, double *value);
RRP_DECLSPEC char*          rrp_cc getRoadRunnerDataColumnHeader(RRDataHandle _data);
RRP_DECLSPEC int            rrp_cc getRoadRunnerDataNumRows(RRDataHandle rrData);
RRP_DECLSPEC int            rrp_cc getRoadRunnerDataNumCols(RRDataHandle rrData);
RRP_DECLSPEC RRDataHandle   rrp_cc createRoadRunnerData(int rows, int cols, char* colNames);
RRP_DECLSPEC bool           rrp_cc freeRoadRunnerData(RRDataHandle handle);
RRP_DECLSPEC char* rrp_cc stringArrayToStringFWD(const RRStringArrayPtr list);

RRP_DECLSPEC bool rrp_cc writeRoadRunnerDataToFile(RRDataHandle rrData, char* fName);
RRP_DECLSPEC bool rrp_cc readRoadRunnerDataFromFile(RRDataHandle rrData, char* fName);



RRP_DECLSPEC char* rrp_cc getLastPluginError();

RRP_DECLSPEC bool rrp_cc freeText(char* text);


#if defined(__cplusplus)
} }    //rrp namespace and extern "C"
#endif

#endif