ola::plugin::usbdmx::BaseWidgetFactory< WidgetType > Class Template Reference

Detailed Description

template<typename WidgetType>
class ola::plugin::usbdmx::BaseWidgetFactory< WidgetType >

A partial implementation of WidgetFactory.

This handles the mapping of libusb_devices to widgets and notifying the observer when widgets are added or removed.

Inheritance diagram for ola::plugin::usbdmx::BaseWidgetFactory< WidgetType >:

Collaboration diagram for ola::plugin::usbdmx::BaseWidgetFactory< WidgetType >:

Public Member Functions
void	DeviceRemoved (WidgetObserver *observer, libusb_device *device)
	Called when a USB device is removed.
Public Member Functions inherited from ola::plugin::usbdmx::WidgetFactory
virtual bool	DeviceAdded (WidgetObserver *observer, libusb_device *usb_device, const struct libusb_device_descriptor &descriptor)=0
	Called when a new USB device is added.

Protected Member Functions
bool	HasDevice (libusb_device *usb_device)
	Check if this factory is already using this device.
unsigned int	DeviceCount () const
	Return the number of active widgets.
bool	AddWidget (WidgetObserver *observer, libusb_device *usb_device, WidgetType *widget)
	Initialize a widget and notify the observer.

Member Function Documentation

template<typename WidgetType>

bool ola::plugin::usbdmx::BaseWidgetFactory< WidgetType >::AddWidget ( WidgetObserver *  observer, libusb_device *  usb_device, WidgetType *  widget  )

protected

Initialize a widget and notify the observer.

Parameters

observer	The WidgetObserver to notify of the new widget.
usb_device	the libusb_device associated with the widget.
widget	the new Widget, ownership is transferred.

Returns

True if the widget was added, false otherwise.

template<typename WidgetType>

unsigned int ola::plugin::usbdmx::BaseWidgetFactory< WidgetType >::DeviceCount ( ) const

inlineprotected

Return the number of active widgets.

Returns

The number of active widgets.

template<typename WidgetType >

void ola::plugin::usbdmx::BaseWidgetFactory< WidgetType >::DeviceRemoved ( WidgetObserver *  observer, libusb_device *  usb_device  )

virtual

Called when a USB device is removed.

Parameters

observer	The WidgetObserver to notify if this action results in a widget removal.
usb_device	the libusb_device that was removed.

Implements ola::plugin::usbdmx::WidgetFactory.

Reimplemented in ola::plugin::usbdmx::SunliteFactory.

template<typename WidgetType>

bool ola::plugin::usbdmx::BaseWidgetFactory< WidgetType >::HasDevice ( libusb_device *  usb_device )

inlineprotected

Check if this factory is already using this device.

Parameters

usb_device

The libusb_device to check for.

Returns

true if we already have a widget registered for this device, false otherwise.

---

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

• plugins/usbdmx/WidgetFactory.h