Open Lighting Architecture  Latest Git
Public Member Functions | List of all members
ola::plugin::usbdmx::AsyncPluginImpl Class Reference

Detailed Description

The asynchronous libusb implementation.

Inheritance diagram for ola::plugin::usbdmx::AsyncPluginImpl:
Inheritance graph
[legend]
Collaboration diagram for ola::plugin::usbdmx::AsyncPluginImpl:
Collaboration graph
[legend]

Public Member Functions

 AsyncPluginImpl (PluginAdaptor *plugin_adaptor, Plugin *plugin, unsigned int debug_level, Preferences *preferences)
 Create a new AsyncPluginImpl. More...
 
bool Start ()
 Start the implementation. More...
 
bool Stop ()
 Stop the implementation. More...
 
bool NewWidget (class AnymauDMX *widget)
 Called when a new AnymauDMX is added. More...
 
bool NewWidget (class AVLdiyD512 *widget)
 Called when a new AVLdiyD512 is added. More...
 
bool NewWidget (class DMXCProjectsNodleU1 *widget)
 Called when a new DMXCProjects Nodle U1 widget is added. More...
 
bool NewWidget (class DMXCreator512Basic *widget)
 Called when a new DMXCreator512Basic is added. More...
 
bool NewWidget (class EurolitePro *widget)
 Called when a new EurolitePro is added. More...
 
bool NewWidget (ola::usb::JaRuleWidget *widget)
 Called when a new Ja Rule widget is added. More...
 
bool NewWidget (class ScanlimeFadecandy *widget)
 Called when a new ScanlimeFadecandy is added. More...
 
bool NewWidget (class ShowJockeyDMXU1 *widget)
 Called when a new ShowJockeyDMXU1 is added. More...
 
bool NewWidget (class Sunlite *widget)
 Called when a new Sunlite is added. More...
 
bool NewWidget (class VellemanK8062 *widget)
 Called when a new VellemanK8062 is added. More...
 

Constructor & Destructor Documentation

◆ AsyncPluginImpl()

ola::plugin::usbdmx::AsyncPluginImpl::AsyncPluginImpl ( PluginAdaptor plugin_adaptor,
Plugin plugin,
unsigned int  debug_level,
Preferences preferences 
)

Create a new AsyncPluginImpl.

Parameters
plugin_adaptorThe PluginAdaptor to use, ownership is not transferred.
pluginThe parent Plugin object which is used when creating devices.
debug_levelthe debug level to use for libusb.
preferencesThe Preferences container used by the plugin

Member Function Documentation

◆ NewWidget() [1/10]

bool ola::plugin::usbdmx::AsyncPluginImpl::NewWidget ( class AnymauDMX widget)
virtual

Called when a new AnymauDMX is added.

Parameters
widgetthe new Widget, ownership is not transferred but the object may be used until the corresponding WidgetRemoved() call is made.
Returns
true if the widget has been claimed, false if the widget was ignored.

Implements ola::plugin::usbdmx::WidgetObserver.

◆ NewWidget() [2/10]

bool ola::plugin::usbdmx::AsyncPluginImpl::NewWidget ( class AVLdiyD512 widget)
virtual

Called when a new AVLdiyD512 is added.

Parameters
widgetthe new Widget, ownership is not transferred but the object may be used until the corresponding WidgetRemoved() call is made.
Returns
true if the widget has been claimed, false if the widget was ignored.

Implements ola::plugin::usbdmx::WidgetObserver.

◆ NewWidget() [3/10]

bool ola::plugin::usbdmx::AsyncPluginImpl::NewWidget ( class DMXCProjectsNodleU1 widget)
virtual

Called when a new DMXCProjects Nodle U1 widget is added.

Parameters
widgetthe new Widget, ownership is not transferred but the object may be used until the corresponding WidgetRemoved() call is made.
Returns
true if the widget has been claimed, false if the widget was ignored.

Implements ola::plugin::usbdmx::WidgetObserver.

◆ NewWidget() [4/10]

bool ola::plugin::usbdmx::AsyncPluginImpl::NewWidget ( class DMXCreator512Basic widget)
virtual

Called when a new DMXCreator512Basic is added.

Parameters
widgetthe new Widget, ownership is not transferred but the object may be used until the corresponding WidgetRemoved() call is made.
Returns
true if the widget has been claimed, false if the widget was ignored.

Implements ola::plugin::usbdmx::WidgetObserver.

◆ NewWidget() [5/10]

bool ola::plugin::usbdmx::AsyncPluginImpl::NewWidget ( class EurolitePro widget)
virtual

Called when a new EurolitePro is added.

Parameters
widgetthe new Widget, ownership is not transferred but the object may be used until the corresponding WidgetRemoved() call is made.
Returns
true if the widget has been claimed, false if the widget was ignored.

Implements ola::plugin::usbdmx::WidgetObserver.

◆ NewWidget() [6/10]

bool ola::plugin::usbdmx::AsyncPluginImpl::NewWidget ( ola::usb::JaRuleWidget widget)
virtual

Called when a new Ja Rule widget is added.

Parameters
widgetthe new Widget, ownership is not transferred but the object may be used until the corresponding WidgetRemoved() call is made.
Returns
true if the widget has been claimed, false if the widget was ignored.

Implements ola::plugin::usbdmx::WidgetObserver.

◆ NewWidget() [7/10]

bool ola::plugin::usbdmx::AsyncPluginImpl::NewWidget ( class ScanlimeFadecandy widget)
virtual

Called when a new ScanlimeFadecandy is added.

Parameters
widgetthe new Widget, ownership is not transferred but the object may be used until the corresponding WidgetRemoved() call is made.
Returns
true if the widget has been claimed, false if the widget was ignored.

Implements ola::plugin::usbdmx::WidgetObserver.

◆ NewWidget() [8/10]

bool ola::plugin::usbdmx::AsyncPluginImpl::NewWidget ( class ShowJockeyDMXU1 widget)
virtual

Called when a new ShowJockeyDMXU1 is added.

Parameters
widgetthe new Widget, ownership is not transferred but the object may be used until the corresponding WidgetRemoved() call is made.
Returns
true if the widget has been claimed, false if the widget was ignored.

Implements ola::plugin::usbdmx::WidgetObserver.

◆ NewWidget() [9/10]

bool ola::plugin::usbdmx::AsyncPluginImpl::NewWidget ( class Sunlite widget)
virtual

Called when a new Sunlite is added.

Parameters
widgetthe new Widget, ownership is not transferred but the object may be used until the corresponding WidgetRemoved() call is made.
Returns
true if the widget has been claimed, false if the widget was ignored.

Implements ola::plugin::usbdmx::WidgetObserver.

◆ NewWidget() [10/10]

bool ola::plugin::usbdmx::AsyncPluginImpl::NewWidget ( class VellemanK8062 widget)
virtual

Called when a new VellemanK8062 is added.

Parameters
widgetthe new Widget, ownership is not transferred but the object may be used until the corresponding WidgetRemoved() call is made.
Returns
true if the widget has been claimed, false if the widget was ignored.

Implements ola::plugin::usbdmx::WidgetObserver.

◆ Start()

bool ola::plugin::usbdmx::AsyncPluginImpl::Start ( )
virtual

Start the implementation.

Returns
true if successful, false otherwise.

Implements ola::plugin::usbdmx::PluginImplInterface.

◆ Stop()

bool ola::plugin::usbdmx::AsyncPluginImpl::Stop ( )
virtual

Stop the implementation.

Returns
true if successful, false otherwise.

Implements ola::plugin::usbdmx::PluginImplInterface.


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