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::plugin::usbpro::UsbSerialPlugin Class Reference
Inheritance diagram for ola::plugin::usbpro::UsbSerialPlugin:
ola::Plugin ola::plugin::usbpro::NewWidgetHandler ola::AbstractPlugin

Public Member Functions

 UsbSerialPlugin (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.
void DeviceRemoved (UsbSerialDevice *device)
std::string PluginPrefix () const
 The prefix to use for storing configuration files.
void NewWidget (ArduinoWidget *widget, const UsbProWidgetInformation &information)
void NewWidget (EnttecUsbProWidget *widget, const UsbProWidgetInformation &information)
void NewWidget (DmxTriWidget *widget, const UsbProWidgetInformation &information)
void NewWidget (DmxterWidget *widget, const UsbProWidgetInformation &information)
void NewWidget (RobeWidget *widget, const RobeWidgetInformation &information)
void NewWidget (UltraDMXProWidget *widget, const UsbProWidgetInformation &information)
- Public Member Functions inherited from ola::Plugin
 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

- Protected Member Functions inherited from ola::Plugin
virtual bool StartHook ()
virtual bool StopHook ()
virtual bool SetDefaultPreferences ()
- Protected Attributes inherited from ola::Plugin
PluginAdaptorm_plugin_adaptor
class Preferencesm_preferences
- Static Protected Attributes inherited from ola::Plugin
static const char ENABLED_KEY [] = "enabled"

Member Function Documentation

string ola::plugin::usbpro::UsbSerialPlugin::Description ( ) const
virtual

Return the description for this plugin.

Returns
a string description of the plugin

Implements ola::AbstractPlugin.

ola_plugin_id ola::plugin::usbpro::UsbSerialPlugin::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::usbpro::UsbSerialPlugin::Name ( ) const
inlinevirtual

Get the plugin name.

Returns
the name of this plugin

Implements ola::AbstractPlugin.

void ola::plugin::usbpro::UsbSerialPlugin::NewWidget ( ArduinoWidget widget,
const UsbProWidgetInformation information 
)
virtual
void ola::plugin::usbpro::UsbSerialPlugin::NewWidget ( EnttecUsbProWidget widget,
const UsbProWidgetInformation information 
)
virtual

Handle a new Enttec Usb Pro Widget.

Implements ola::plugin::usbpro::NewWidgetHandler.

void ola::plugin::usbpro::UsbSerialPlugin::NewWidget ( DmxTriWidget widget,
const UsbProWidgetInformation information 
)
virtual

Handle a new Dmx-Tri Widget.

Implements ola::plugin::usbpro::NewWidgetHandler.

void ola::plugin::usbpro::UsbSerialPlugin::NewWidget ( DmxterWidget widget,
const UsbProWidgetInformation information 
)
virtual

Handle a new Dmxter.

Implements ola::plugin::usbpro::NewWidgetHandler.

void ola::plugin::usbpro::UsbSerialPlugin::NewWidget ( RobeWidget widget,
const RobeWidgetInformation information 
)
virtual

New Robe Universal Interface.

Implements ola::plugin::usbpro::NewWidgetHandler.

void ola::plugin::usbpro::UsbSerialPlugin::NewWidget ( UltraDMXProWidget widget,
const UsbProWidgetInformation information 
)
virtual

A New Ultra DMX Pro Widget

Implements ola::plugin::usbpro::NewWidgetHandler.

std::string ola::plugin::usbpro::UsbSerialPlugin::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: