Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
ola::plugin::usbdmx::SynchronousDMXCreator512Basic Class Reference

Detailed Description

An DMXCreator512Basic widget that uses synchronous libusb operations.

Internally this spawns a new thread to avoid blocking SendDMX() calls.

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

Public Member Functions

 SynchronousDMXCreator512Basic (ola::usb::LibUsbAdaptor *adaptor, libusb_device *usb_device, const std::string &serial)
 Create a new SynchronousDMXCreator512Basic. More...
 
bool Init ()
 Initialize the widget. More...
 
bool SendDMX (const DmxBuffer &buffer)
 Send DMX data from this widget. More...
 
- Public Member Functions inherited from ola::plugin::usbdmx::DMXCreator512Basic
 DMXCreator512Basic (ola::usb::LibUsbAdaptor *adaptor, libusb_device *usb_device, const std::string &serial)
 Create a new DMXCreator512Basic. More...
 
std::string SerialNumber () const
 Get the serial number of this widget. More...
 
- Public Member Functions inherited from ola::plugin::usbdmx::SimpleWidget
 SimpleWidget (ola::usb::LibUsbAdaptor *adaptor, libusb_device *usb_device)
 Create a new SimpleWidget. More...
 
ola::usb::USBDeviceID GetDeviceId () const
 The device ID of this widget. More...
 

Additional Inherited Members

- Protected Attributes inherited from ola::plugin::usbdmx::SimpleWidget
ola::usb::LibUsbAdaptor *const m_adaptor
 
libusb_device *const m_usb_device
 

Constructor & Destructor Documentation

ola::plugin::usbdmx::SynchronousDMXCreator512Basic::SynchronousDMXCreator512Basic ( ola::usb::LibUsbAdaptor adaptor,
libusb_device *  usb_device,
const std::string &  serial 
)

Create a new SynchronousDMXCreator512Basic.

Parameters
adaptorthe LibUsbAdaptor to use.
usb_devicethe libusb_device to use for the widget.
serialthe serial number of the widget.

Member Function Documentation

bool ola::plugin::usbdmx::SynchronousDMXCreator512Basic::Init ( )
virtual

Initialize the widget.

Returns
true if this widget was initialized correctly, false otherwise.

Implements ola::plugin::usbdmx::WidgetInterface.

bool ola::plugin::usbdmx::SynchronousDMXCreator512Basic::SendDMX ( const DmxBuffer buffer)
virtual

Send DMX data from this widget.

Parameters
bufferThe DmxBuffer containing the data to send.
Returns
true if the data was sent, false otherwise.

Implements ola::plugin::usbdmx::WidgetInterface.


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