Open Lighting Architecture  0.9.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
ola::AbstractPlugin Class Reference

Detailed Description

The interface for a plugin

Inheritance diagram for ola::AbstractPlugin:
ola::Plugin ola::plugin::artnet::ArtNetPlugin ola::plugin::dmx4linux::Dmx4LinuxPlugin ola::plugin::dummy::DummyPlugin ola::plugin::e131::E131Plugin ola::plugin::espnet::EspNetPlugin ola::plugin::ftdidmx::FtdiDmxPlugin ola::plugin::karate::KaratePlugin ola::plugin::kinet::KiNetPlugin ola::plugin::milinst::MilInstPlugin ola::plugin::opendmx::OpenDmxPlugin ola::plugin::osc::OSCPlugin ola::plugin::pathport::PathportPlugin ola::plugin::renard::RenardPlugin ola::plugin::sandnet::SandNetPlugin ola::plugin::shownet::ShowNetPlugin ola::plugin::spi::SPIPlugin ola::plugin::stageprofi::StageProfiPlugin ola::plugin::uartdmx::UartDmxPlugin ola::plugin::usbdmx::UsbDmxPlugin ola::plugin::usbpro::UsbSerialPlugin

Public Member Functions

virtual bool LoadPreferences ()=0
 Load the preferences for a plugin.
virtual std::string PreferenceSource () const =0
 The location for preferences. This can be anything really but should indicate to the user how how the preferences were loaded.
virtual bool IsEnabled () const =0
 Is the plugin enabled?
virtual bool Start ()=0
virtual bool Stop ()=0
virtual ola_plugin_id Id () const =0
 Get the plugin ID of this plugin.
virtual std::string Name () const =0
 Get the plugin name.
virtual std::string Description () const =0
virtual void ConflictsWith (std::set< ola_plugin_id > *conflict_set)=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 bool ola::AbstractPlugin::Start ( )
pure virtual

Start the plugin

Returns
true if we started ok, false otherwise

Implemented in ola::Plugin.

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

Stop the plugin

Returns
true on success, false on failure

Implemented in ola::Plugin.


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