Public Member Functions |
| SandNetPlugin (ola::PluginAdaptor *plugin_adaptor) |
std::string | Name () const |
| Get the plugin name.
|
std::string | Description () const |
ola_plugin_id | Id () const |
| Get the plugin ID of this plugin.
|
std::string | PluginPrefix () const |
| The prefix to use for storing configuration files.
|
| Plugin (PluginAdaptor *plugin_adaptor) |
bool | LoadPreferences () |
| Load the preferences for a plugin.
|
std::string | PreferenceSource () const |
| The location for preferences. This can be anything really but should indicate to the user how how the preferences were loaded.
|
bool | IsEnabled () const |
| Is the plugin enabled?
|
virtual bool | Start () |
virtual bool | Stop () |
virtual bool | DefaultMode () const |
virtual void | ConflictsWith (std::set< ola_plugin_id > *) |
bool | operator< (const AbstractPlugin &other) const |
Additional Inherited Members |
virtual bool | StartHook () |
virtual bool | StopHook () |
virtual bool | SetDefaultPreferences () |
PluginAdaptor * | m_plugin_adaptor |
class Preferences * | m_preferences |
static const char | ENABLED_KEY [] = "enabled" |
Member Function Documentation
string ola::plugin::sandnet::SandNetPlugin::Description |
( |
| ) |
const |
|
virtual |
Return the description for this plugin.
- Returns
- a string description of the plugin
Implements ola::AbstractPlugin.
ola_plugin_id ola::plugin::sandnet::SandNetPlugin::Id |
( |
| ) |
const |
|
inlinevirtual |
Get the plugin ID of this plugin.
- Returns
- the ola_plugin_id of this plugin
Implements ola::Plugin.
std::string ola::plugin::sandnet::SandNetPlugin::Name |
( |
| ) |
const |
|
inlinevirtual |
std::string ola::plugin::sandnet::SandNetPlugin::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: