AbstractPicoScenesPlugin Class Reference

Abstract base class that defines the interface for all PicoScenes plugins. More...

#include <AbstractPicoScenesPlugin.hxx>

Public Member Functions
virtual std::string	getPluginName ()=0
	Get the name of the plugin.
virtual std::string	getPluginDescription ()=0
	Get a description of the plugin's functionality.
virtual std::string	pluginStatus ()=0
	Get the current status of the plugin.
virtual std::vector< PicoScenesDeviceType >	getSupportedDeviceTypes ()
	Get the list of device types supported by this plugin.
virtual void	initialization ()
	Initialize the plugin.
virtual std::shared_ptr< po::options_description >	pluginOptionsDescription ()
	Get the command-line options description for this plugin.
virtual void	parseAndExecuteCommands (const std::string &commandString)
	Parse and execute a command string.
virtual void	rxHandle (const ModularPicoScenesRxFrame &rxs)
	Handle a received frame.
virtual void	finalize ()
	Finalize the plugin.
virtual	~AbstractPicoScenesPlugin ()=default
	Virtual destructor.
void	setNIC (const std::shared_ptr< AbstractNIC > &nicV)
	Set the Network Interface Card (NIC) for this plugin.

Protected Attributes
std::shared_ptr< AbstractNIC >	nic
	The Network Interface Card used by this plugin.

Detailed Description

Abstract base class that defines the interface for all PicoScenes plugins.

This class provides the core functionality and interface that all PicoScenes plugins must implement. It defines methods for plugin identification, initialization, configuration, and frame handling.

Definition at line 24 of file AbstractPicoScenesPlugin.hxx.

Constructor & Destructor Documentation

~AbstractPicoScenesPlugin()

virtual AbstractPicoScenesPlugin::~AbstractPicoScenesPlugin ( )

virtualdefault

Virtual destructor.

Member Function Documentation

finalize()

virtual void AbstractPicoScenesPlugin::finalize ( )

inlinevirtual

Finalize the plugin.

This method is called when the plugin is being unloaded and should perform any necessary cleanup operations.

Definition at line 84 of file AbstractPicoScenesPlugin.hxx.

getPluginDescription()

virtual std::string AbstractPicoScenesPlugin::getPluginDescription ( )

pure virtual

Get a description of the plugin's functionality.

Returns

A string describing what the plugin does

getPluginName()

virtual std::string AbstractPicoScenesPlugin::getPluginName ( )

pure virtual

Get the name of the plugin.

Returns

The name of the plugin as a string

getSupportedDeviceTypes()

virtual std::vector< PicoScenesDeviceType > AbstractPicoScenesPlugin::getSupportedDeviceTypes ( )

inlinevirtual

Get the list of device types supported by this plugin.

Returns

A vector of PicoScenesDeviceType values that this plugin supports

Definition at line 48 of file AbstractPicoScenesPlugin.hxx.

initialization()

virtual void AbstractPicoScenesPlugin::initialization ( )

inlinevirtual

Initialize the plugin.

This method is called when the plugin is loaded and should perform any necessary setup operations.

Definition at line 58 of file AbstractPicoScenesPlugin.hxx.

parseAndExecuteCommands()

virtual void AbstractPicoScenesPlugin::parseAndExecuteCommands ( const std::string &  commandString )

inlinevirtual

Parse and execute a command string.

Parameters

commandString

The command string to parse and execute

Definition at line 70 of file AbstractPicoScenesPlugin.hxx.

pluginOptionsDescription()

virtual std::shared_ptr< po::options_description > AbstractPicoScenesPlugin::pluginOptionsDescription ( )

inlinevirtual

Get the command-line options description for this plugin.

Returns

A shared pointer to a boost::program_options::options_description object

Definition at line 64 of file AbstractPicoScenesPlugin.hxx.

pluginStatus()

virtual std::string AbstractPicoScenesPlugin::pluginStatus ( )

pure virtual

Get the current status of the plugin.

Returns

A string describing the current status of the plugin

rxHandle()

virtual void AbstractPicoScenesPlugin::rxHandle ( const ModularPicoScenesRxFrame &  rxs )

inlinevirtual

Handle a received frame.

Parameters

rxs	The received frame to process

Definition at line 76 of file AbstractPicoScenesPlugin.hxx.

setNIC()

void AbstractPicoScenesPlugin::setNIC ( const std::shared_ptr< AbstractNIC > &  nicV )

inline

Set the Network Interface Card (NIC) for this plugin.

Parameters

nicV	A shared pointer to the NIC to use

Definition at line 95 of file AbstractPicoScenesPlugin.hxx.

References nic.

Member Data Documentation

nic

std::shared_ptr<AbstractNIC> AbstractPicoScenesPlugin::nic

protected

The Network Interface Card used by this plugin.

Definition at line 107 of file AbstractPicoScenesPlugin.hxx.

Referenced by setNIC().

---

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

• headers/AbstractPicoScenesPlugin.hxx