telplugins_c_api.h

Go to the documentation of this file.

#ifndef telplugins_c_apiH
#define telplugins_c_apiH
#include "telplugins_exporter.h"
#include "telplugins_types.h"
#include "telplugins_utilities.h"
#include "teljobs_api.h"
#include "telplugins_properties_api.h"
#include "telplugins_telluriumdata_api.h"
#include "telplugins_logging_api.h"
//---------------------------------------------------------------------------


#if defined(__cplusplus)
using tlpc::PluginEvent;
extern "C" {
#endif

TLP_C_DS TELHandle tlp_cc tpCreatePluginManager(const char* pluginDir);

TLP_C_DS bool tlp_cc tpFreePluginManager(TELHandle handle);

TLP_C_DS bool tlp_cc tpLoadPlugins(TELHandle handle);

TLP_C_DS char* tlp_cc tpGetPluginLoadErrors(TELHandle handle);

TLP_C_DS bool tlp_cc tpUnLoadPlugins(TELHandle handle);

TLP_C_DS TELHandle tlp_cc tpLoadPlugin(TELHandle handle, const char* pluginName);

TLP_C_DS bool tlp_cc tpUnLoadPlugin(TELHandle handle, TELHandle plugin);

TLP_C_DS int tlp_cc tpGetNumberOfPlugins(TELHandle handle);

TLP_C_DS char* tlp_cc tpGetPluginNames(TELHandle handle);

TLP_C_DS char* tlp_cc tpGetPluginLibraryNames(TELHandle handle);

TLP_C_DS TELHandle tlp_cc tpGetFirstPlugin(TELHandle handle);

TLP_C_DS TELHandle tlp_cc tpGetNextPlugin(TELHandle handle);

TLP_C_DS TELHandle tlp_cc tpGetPreviousPlugin(TELHandle handle);

TLP_C_DS TELHandle tlp_cc tpGetCurrentPlugin(TELHandle handle);

TLP_C_DS TELHandle tlp_cc tpGetPlugin(TELHandle handle, const char* pluginName);

TLP_C_DS long tlp_cc tpGetPluginSharedLibHandle(TELHandle handle, TELHandle pluginHandle);


//==========================  PLUGIN HANDLE functions
TLP_C_DS char* tlp_cc tpGetPluginName(TELHandle handle);

TLP_C_DS char* tlp_cc tpGetPluginCategory(TELHandle handle);

TLP_C_DS char* tlp_cc tpGetPluginDescription(TELHandle handle);

TLP_C_DS char* tlp_cc tpGetPluginHint(TELHandle handle);

TLP_C_DS char* tlp_cc tpGetPluginInfo(TELHandle handle);

TLP_C_DS char* tlp_cc tpGetPluginAuthor(TELHandle handle);

TLP_C_DS char* tlp_cc tpGetPluginCopyright(TELHandle handle);

TLP_C_DS char* tlp_cc tpGetPluginVersion(TELHandle handle);

TLP_C_DS unsigned char* tlp_cc tpGetPluginManualAsPDF(TELHandle handle);

TLP_C_DS unsigned int tlp_cc tpGetPluginManualNrOfBytes(TELHandle handle);

TLP_C_DS bool tlp_cc tpAssignRoadRunnerInstance(TELHandle pHandle, TELHandle rrHandle);

TLP_C_DS bool tlp_cc tpExecutePlugin(TELHandle handle);

TLP_C_DS bool tlp_cc tpExecutePluginEx(TELHandle handle, bool inAThread);

TLP_C_DS char* tlp_cc tpGetPluginStatus(TELHandle handle);

TLP_C_DS char* tlp_cc tpGetPluginResult(TELHandle handle);

TLP_C_DS bool tlp_cc tpResetPlugin(TELHandle handle);

TLP_C_DS bool tlp_cc tpIsPluginWorking(TELHandle handle);

TLP_C_DS void tlp_cc tpTerminateWork(TELHandle handle);

TLP_C_DS bool tlp_cc tpIsBeingTerminated(TELHandle handle);

TLP_C_DS bool tlp_cc tpWasTerminated(TELHandle handle);

TLP_C_DS bool tlp_cc tpAssignOnStartedEvent(TELHandle handle, PluginEvent cb, void* userData1, void* userData2);

TLP_C_DS bool tlp_cc tpAssignOnProgressEvent(TELHandle handle, PluginEvent cb, void* userData1, void* userData2);

TLP_C_DS bool tlp_cc tpAssignOnFinishedEvent(TELHandle handle, PluginEvent cb, void* userData1, void* userData2);

TLP_C_DS TELHandle tlp_cc tpGetRoadRunnerHandleFromPlugin(TELHandle handle);

TLP_C_DS char* tlp_cc tpGetPluginPropertiesAsXML(TELHandle handle);

TLP_C_DS TELHandle tlp_cc tpGetPluginProperties(TELHandle handle);

TLP_C_DS char* tlp_cc tpGetListOfPluginPropertyNames(TELHandle handle);

TLP_C_DS TELHandle tlp_cc tpGetPluginProperty(TELHandle handle, const char* propertyName);

TLP_C_DS TELHandle tlp_cc tpGetPluginPropertyValueHandle(TELHandle handle, const char* propertyName);

TLP_C_DS char* tlp_cc tpGetPluginPropertyValueAsString(TELHandle handle, const char* propertyName);

TLP_C_DS bool tlp_cc tpSetPluginProperty(TELHandle handle, const char* propertyName, const char* value);

TLP_C_DS char* tlp_cc tpGetLastError();

TLP_C_DS bool tlp_cc tpFreeText(char* text);

TLP_C_DS char* tlp_cc tpGetVersion();

TLP_C_DS char* tlp_cc tpGetCopyright();

TLP_C_DS TELHandle tlp_cc tpRegisterHandle(TELHandle handle, char* name);

TLP_C_DS bool tlp_cc tpUnRegisterHandle(TELHandle handle);

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

#endif