Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
ola::plugin::renard::RenardPlugin Class Reference
Inheritance diagram for ola::plugin::renard::RenardPlugin:
Inheritance graph
Collaboration diagram for ola::plugin::renard::RenardPlugin:
Collaboration graph

Public Member Functions

 RenardPlugin (PluginAdaptor *plugin_adaptor)
std::string Name () const
 Get the plugin name. More...
ola_plugin_id Id () const
 Get the plugin ID of this plugin. More...
std::string Description () const
int SocketClosed (ola::io::ConnectedDescriptor *socket)
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
class Preferencesm_preferences
- Static Protected Attributes inherited from ola::Plugin
static const char ENABLED_KEY [] = "enabled"

Member Function Documentation

string ola::plugin::renard::RenardPlugin::Description ( ) const

Return the description for this plugin.

a string description of the plugin

Implements ola::AbstractPlugin.

ola_plugin_id ola::plugin::renard::RenardPlugin::Id ( ) const

Get the plugin ID of this plugin.

the ola_plugin_id of this plugin

Implements ola::Plugin.

std::string ola::plugin::renard::RenardPlugin::Name ( ) const

Get the plugin name.

the name of this plugin

Implements ola::AbstractPlugin.

std::string ola::plugin::renard::RenardPlugin::PluginPrefix ( ) const

The prefix to use for storing configuration files.

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: