Inheritance diagram for ola::plugin::pathport::PathportPlugin:

Collaboration diagram for ola::plugin::pathport::PathportPlugin:

[legend]

Public Member Functions
	PathportPlugin (class ola::PluginAdaptor *plugin_adaptor)

std::string	Name () const
	Get the plugin name. More...

std::string	Description () const

ola_plugin_id	Id () const
	Get the plugin ID of this plugin. More...

std::string	PluginPrefix () const
	The prefix to use for storing configuration files. More...

Public Member Functions inherited from ola::Plugin
	Plugin (PluginAdaptor *plugin_adaptor)

bool	LoadPreferences ()
	Load the preferences for a plugin and set defaults.

std::string	PreferenceConfigLocation () const
	The location for preferences. More...

bool	IsEnabled () const
	Is the plugin enabled? More...

void	SetEnabledState (bool enable)
	Set the plugin's enabled state. More...

virtual bool	Start ()
	Start the plugin. More...

virtual bool	Stop ()
	Stop the plugin. More...

virtual bool	DefaultMode () const

virtual void	ConflictsWith (std::set< ola_plugin_id > *) const

bool	operator< (const AbstractPlugin &other) const

Additional Inherited Members
Protected Attributes inherited from ola::Plugin
PluginAdaptor *	m_plugin_adaptor

class Preferences *	m_preferences

Static Protected Attributes inherited from ola::Plugin
static const char	ENABLED_KEY [] = "enabled"

Member Function Documentation

◆ Description()

string ola::plugin::pathport::PathportPlugin::Description ( ) const

virtual

Return the description for this plugin.

ola_plugin_id ola::plugin::pathport::PathportPlugin::Id ( ) const

inlinevirtual

Get the plugin ID of this plugin.

Implements ola::Plugin.

std::string ola::plugin::pathport::PathportPlugin::Name ( ) const

inlinevirtual

Get the plugin name.

std::string ola::plugin::pathport::PathportPlugin::PluginPrefix ( ) const

inlinevirtual

The prefix to use for storing configuration files.

Returns: A unique prefix used to identify the configuration file for this plugin.

Implements ola::Plugin.

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