Fledge
An open source edge computing platform for industrial users
SouthPlugin Class Reference

Class that represents a south plugin. More...

#include <south_plugin.h>

Inheritance diagram for SouthPlugin:
Collaboration diagram for SouthPlugin:

Public Member Functions

 SouthPlugin (PLUGIN_HANDLE handle, const ConfigCategory &category)
 Constructor for the class that wraps the south plugin. More...
 
 ~SouthPlugin ()
 South plugin destructor.
 
Reading poll ()
 Call the poll method in the plugin.
 
ReadingSetpollV2 ()
 Call the poll method in the plugin supporting interface ver 2.x.
 
void start ()
 Call the start method in the plugin.
 
void reconfigure (const std::string &)
 Call the reconfigure method in the plugin.
 
void shutdown ()
 Call the shutdown method in the plugin.
 
void registerIngest (INGEST_CB, void *)
 
void registerIngestV2 (INGEST_CB2, void *)
 
bool isAsync ()
 
bool hasControl ()
 
bool persistData ()
 
void startData (const std::string &pluginData)
 Call the start method in the plugin.
 
std::string shutdownSaveData ()
 Call the shutdown method in the plugin.
 
bool write (const std::string &name, const std::string &value)
 Call the write entry point of the plugin. More...
 
bool operation (const std::string &name, std::vector< PLUGIN_PARAMETER *> &)
 Call the plugin operation entry point with the operation to execute. More...
 
- Public Member Functions inherited from Plugin
 Plugin (PLUGIN_HANDLE handle)
 
const PLUGIN_INFORMATIONgetInfo ()
 
PLUGIN_HANDLE getHandle ()
 

Additional Inherited Members

- Protected Attributes inherited from Plugin
PLUGIN_HANDLE handle
 
PluginManagermanager
 
PLUGIN_INFORMATIONinfo
 

Detailed Description

Class that represents a south plugin.

The purpose of this class is to hide the use of the pointers into the dynamically loaded plugin and wrap the interface into a class that can be used directly in the south subsystem.

This is achieved by having a set of private member variables which are the pointers to the functions in the plugin, and a set of public methods that will call these functions via the function pointers.

Constructor & Destructor Documentation

◆ SouthPlugin()

SouthPlugin::SouthPlugin ( PLUGIN_HANDLE  handle,
const ConfigCategory category 
)

Constructor for the class that wraps the south plugin.

Create a set of function points that resolve to the loaded plugin and enclose in the class.

Member Function Documentation

◆ operation()

bool SouthPlugin::operation ( const std::string &  name,
std::vector< PLUGIN_PARAMETER *> &   
)

Call the plugin operation entry point with the operation to execute.

Parameters
nameThe name of the operation
parametersThe paramters for the operation.
Returns
bool Status of the operation

◆ write()

bool SouthPlugin::write ( const std::string &  name,
const std::string &  value 
)

Call the write entry point of the plugin.

Parameters
nameThe name of the parameter to change
valueThe value to set the parameter

The documentation for this class was generated from the following files: