ola::plugin::usbdmx::SyncronizedWidgetObserver Class Reference

Detailed Description

Transfers widget add/remove events to another thread.

The SyncronizedWidgetObserver ensures that all widget add/removed events are handled in the thread that created the SyncronizedWidgetObserver object.

Inheritance diagram for ola::plugin::usbdmx::SyncronizedWidgetObserver:

Public Member Functions
	SyncronizedWidgetObserver (WidgetObserver *observer, ola::io::SelectServerInterface *ss)
	Create a new SyncronizedWidgetObserver.
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::SyncronizedWidgetObserver::SyncronizedWidgetObserver	(	WidgetObserver *	observer,
		ola::io::SelectServerInterface *	ss
	)

Create a new SyncronizedWidgetObserver.

Parameters

observer	the observer to notify on add/remove events.
ss	The ss to use the schedule events on.

Member Function Documentation

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

inlinevirtual

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::SyncronizedWidgetObserver::NewWidget ( class EurolitePro *  widget )

inlinevirtual

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::SyncronizedWidgetObserver::NewWidget ( class ScanlimeFadecandy *  widget )

inlinevirtual

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::SyncronizedWidgetObserver::NewWidget ( class Sunlite *  widget )

inlinevirtual

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::SyncronizedWidgetObserver::NewWidget ( class VellemanK8062 *  widget )

inlinevirtual

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.

void ola::plugin::usbdmx::SyncronizedWidgetObserver::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::SyncronizedWidgetObserver::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::SyncronizedWidgetObserver::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::SyncronizedWidgetObserver::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::SyncronizedWidgetObserver::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/SyncronizedWidgetObserver.h
• plugins/usbdmx/SyncronizedWidgetObserver.cpp