ola::plugin::ftdidmx::FtdiDmxPlugin Class Reference

Inheritance diagram for ola::plugin::ftdidmx::FtdiDmxPlugin:

Public Member Functions
	FtdiDmxPlugin (ola::PluginAdaptor *plugin_adaptor)
ola_plugin_id	Id () const
	Get the plugin ID of this plugin.
std::string	Name () const
	Get the plugin name.
std::string	PluginPrefix () const
	The prefix to use for storing configuration files.
bool	DefaultMode () const
void	ConflictsWith (std::set< ola_plugin_id > *conflict_set) const
std::string	Description () const
	Return a description for this plugin.
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.
bool	IsEnabled () const
	Is the plugin enabled?
void	SetEnabledState (bool enable)
	Set the plugin's enabled state.
virtual bool	Start ()
	Start the plugin.
virtual bool	Stop ()
	Stop the plugin.
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

ConflictsWith()

void ola::plugin::ftdidmx::FtdiDmxPlugin::ConflictsWith ( std::set< ola_plugin_id > * conflict_set ) const

inlinevirtual

Reimplemented from ola::Plugin.

DefaultMode()

bool ola::plugin::ftdidmx::FtdiDmxPlugin::DefaultMode ( ) const

inlinevirtual

Reimplemented from ola::Plugin.

Description()

string ola::plugin::ftdidmx::FtdiDmxPlugin::Description ( ) const

virtual

Return a description for this plugin.

Implements ola::AbstractPlugin.

Id()

ola_plugin_id ola::plugin::ftdidmx::FtdiDmxPlugin::Id ( ) const

inlinevirtual

Get the plugin ID of this plugin.

Returns

the ola_plugin_id of this plugin

Implements ola::Plugin.

Name()

std::string ola::plugin::ftdidmx::FtdiDmxPlugin::Name ( ) const

inlinevirtual

Get the plugin name.

Returns

the name of this plugin

Implements ola::AbstractPlugin.

PluginPrefix()

std::string ola::plugin::ftdidmx::FtdiDmxPlugin::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:

• plugins/ftdidmx/FtdiDmxPlugin.h
• plugins/ftdidmx/FtdiDmxPlugin.cpp