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::AbstractPlugin Class Referenceabstract

Detailed Description

The interface for a plugin

Inheritance diagram for ola::AbstractPlugin:
Inheritance graph
[legend]

Public Member Functions

virtual bool LoadPreferences ()=0
 Load the preferences for a plugin and set defaults.
 
virtual std::string PreferenceConfigLocation () const =0
 The location for preferences. More...
 
virtual bool IsEnabled () const =0
 Is the plugin enabled? More...
 
virtual void SetEnabledState (bool enable)=0
 Set the plugin's enabled state. More...
 
virtual bool Start ()=0
 Start the plugin. More...
 
virtual bool Stop ()=0
 Stop the plugin. More...
 
virtual ola_plugin_id Id () const =0
 Get the plugin ID of this plugin. More...
 
virtual std::string Name () const =0
 Get the plugin name. More...
 
virtual std::string Description () const =0
 
virtual void ConflictsWith (std::set< ola_plugin_id > *conflict_set) const =0
 
virtual bool operator< (const AbstractPlugin &other) const =0
 

Member Function Documentation

virtual std::string ola::AbstractPlugin::Description ( ) const
pure virtual
virtual ola_plugin_id ola::AbstractPlugin::Id ( ) const
pure virtual
virtual bool ola::AbstractPlugin::IsEnabled ( ) const
pure virtual

Is the plugin enabled?

Returns
true if this plugin is enabled

Implemented in ola::Plugin.

virtual std::string ola::AbstractPlugin::Name ( ) const
pure virtual
virtual std::string ola::AbstractPlugin::PreferenceConfigLocation ( ) const
pure virtual

The location for preferences.

This can be anything really but should indicate to the user how the preferences were loaded.

Implemented in ola::Plugin.

virtual void ola::AbstractPlugin::SetEnabledState ( bool  enable)
pure virtual

Set the plugin's enabled state.

Parameters
enableThe new enabled state
Returns
true if this plugin is enabled

Implemented in ola::Plugin.

virtual bool ola::AbstractPlugin::Start ( )
pure virtual

Start the plugin.

Calls StartHook() which can be overridden by the derived classes.

Returns
true if we started ok, false otherwise

Implemented in ola::Plugin.

virtual bool ola::AbstractPlugin::Stop ( )
pure virtual

Stop the plugin.

Calls StopHook() which can be overridden by the derived classes.

Returns
true on success, false on failure

Implemented in ola::Plugin.


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