ola::plugin::usbdmx::SyncPluginImpl Class Reference

Detailed Description

The legacy implementation.

This implementation spawns a thread for each dongle, and then uses synchronous calls to libusb.

This does not support hotplug.

Inheritance diagram for ola::plugin::usbdmx::SyncPluginImpl:

Public Member Functions
	SyncPluginImpl (PluginAdaptor *plugin_adaptor, Plugin *plugin, unsigned int debug_level)
	Create a new SyncPluginImpl.
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 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 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::SyncPluginImpl::SyncPluginImpl	(	PluginAdaptor *	plugin_adaptor,
		Plugin *	plugin,
		unsigned int	debug_level
	)

Create a new SyncPluginImpl.

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::SyncPluginImpl::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::SyncPluginImpl::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::SyncPluginImpl::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::SyncPluginImpl::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::SyncPluginImpl::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::SyncPluginImpl::Start ( )

virtual

Start the implementation.

Returns

true if successful, false otherwise.

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

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

virtual

Stop the implementation.

Returns

true if successful, false otherwise.

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

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

inlinevirtual

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::SyncPluginImpl::WidgetRemoved ( class EurolitePro *  widget )

inlinevirtual

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::SyncPluginImpl::WidgetRemoved ( class ScanlimeFadecandy *  widget )

inlinevirtual

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::SyncPluginImpl::WidgetRemoved ( class Sunlite *  widget )

inlinevirtual

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::SyncPluginImpl::WidgetRemoved ( class VellemanK8062 *  widget )

inlinevirtual

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/SyncPluginImpl.h
• plugins/usbdmx/SyncPluginImpl.cpp