Detailed Description

The asynchronous libusb implementation.

Inheritance diagram for ola::plugin::usbdmx::AsyncPluginImpl:

Collaboration diagram for ola::plugin::usbdmx::AsyncPluginImpl:

Public Member Functions
	AsyncPluginImpl (PluginAdaptor plugin_adaptor, Plugin plugin, unsigned int debug_level)
	Create a new AsyncPluginImpl.
bool	Start ()
	Start the implementation.
bool	Stop ()
	Stop the implementation.
bool	NewWidget (class AnymauDMX *widget)
	Called when a new AnymauDMX is added.
bool	NewWidget (class EurolitePro *widget)
	Called when a new EurolitePro is added.
bool	NewWidget (class JaRuleWidget *widget)
	Called when a new Ja Rule widget is added.
bool	NewWidget (class ScanlimeFadecandy *widget)
	Called when a new ScanlimeFadecandy is added.
bool	NewWidget (class Sunlite *widget)
	Called when a new Sunlite is added.
bool	NewWidget (class VellemanK8062 *widget)
	Called when a new VellemanK8062 is added.
void	WidgetRemoved (class AnymauDMX *widget)
	Called when an AnymauDMX is removed.
void	WidgetRemoved (class EurolitePro *widget)
	Called when a EurolitePro is removed.
void	WidgetRemoved (class JaRuleWidget *widget)
	Called when a Ja Rule widget is removed.
void	WidgetRemoved (class ScanlimeFadecandy *widget)
	Called when a ScanlimeFadecandy is removed.
void	WidgetRemoved (class Sunlite *widget)
	Called when a Sunlite is removed.
void	WidgetRemoved (class VellemanK8062 *widget)
	Called when a VellemanK8062 is removed.

Constructor & Destructor Documentation

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

Create a new AsyncPluginImpl.

Parameters

plugin_adaptor	The PluginAdaptor to use, ownership is not transferred.
plugin	The parent Plugin object which is used when creating devices.
debug_level	the debug level to use for libusb.

Member Function Documentation

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

virtual

Called when a new AnymauDMX is added.

Parameters

widget the 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.

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

virtual

Called when a new EurolitePro is added.

Parameters

widget the 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.

bool ola::plugin::usbdmx::AsyncPluginImpl::NewWidget ( class JaRuleWidget * widget )

virtual

Called when a new Ja Rule widget is added.

Parameters

widget the 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.

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

virtual

Called when a new ScanlimeFadecandy is added.

Parameters

widget the 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.

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

virtual

Called when a new Sunlite is added.

Parameters

widget the 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.

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

virtual

Called when a new VellemanK8062 is added.

Parameters

widget the 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.

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

virtual

Start the implementation.

Returns: true if successful, false otherwise.

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

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

virtual

Stop the implementation.

Returns: true if successful, false otherwise.

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

void ola::plugin::usbdmx::AsyncPluginImpl::WidgetRemoved ( class AnymauDMX * widget )

virtual

Called when an AnymauDMX is removed.

Parameters

widget the Widget that has been removed.

It is an error to use the widget once this call completes.

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

void ola::plugin::usbdmx::AsyncPluginImpl::WidgetRemoved ( class EurolitePro * widget )

virtual

Called when a EurolitePro is removed.

Parameters

widget the Widget that has been removed.

It is an error to use the widget once this call completes.

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

void ola::plugin::usbdmx::AsyncPluginImpl::WidgetRemoved ( class JaRuleWidget * widget )

virtual

Called when a Ja Rule widget is removed.

Parameters

widget the Widget that has been removed.

It is an error to use the widget once this call completes.

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

void ola::plugin::usbdmx::AsyncPluginImpl::WidgetRemoved ( class ScanlimeFadecandy * widget )

virtual

Called when a ScanlimeFadecandy is removed.

Parameters

widget the Widget that has been removed.

It is an error to use the widget once this call completes.

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

void ola::plugin::usbdmx::AsyncPluginImpl::WidgetRemoved ( class Sunlite * widget )

virtual

Called when a Sunlite is removed.

Parameters

widget the Widget that has been removed.

It is an error to use the widget once this call completes.

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

void ola::plugin::usbdmx::AsyncPluginImpl::WidgetRemoved ( class VellemanK8062 * widget )

virtual

Called when a VellemanK8062 is removed.

Parameters

widget the Widget that has been removed.

It is an error to use the widget once this call completes.

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

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

plugins/usbdmx/AsyncPluginImpl.h
plugins/usbdmx/AsyncPluginImpl.cpp

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation