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::SynchronousDMXCProjectsNodleU1 Class Reference

Detailed Description

An Nodle widget that uses synchronous libusb operations.

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

Inheritance diagram for ola::plugin::usbdmx::SynchronousDMXCProjectsNodleU1:
Inheritance graph
Collaboration diagram for ola::plugin::usbdmx::SynchronousDMXCProjectsNodleU1:
Collaboration graph

Public Member Functions

 SynchronousDMXCProjectsNodleU1 (ola::usb::LibUsbAdaptor *adaptor, libusb_device *usb_device, PluginAdaptor *plugin_adaptor, const std::string &serial, unsigned int mode)
 Create a new SynchronousDMXCProjectsNodleU1. More...
bool Init ()
 Initialize the widget. More...
bool SendDMX (const DmxBuffer &buffer)
 Send DMX data from this widget. More...
void SetDmxCallback (Callback0< void > *callback)
const DmxBufferGetDmxInBuffer ()
- Public Member Functions inherited from ola::plugin::usbdmx::DMXCProjectsNodleU1
 DMXCProjectsNodleU1 (ola::usb::LibUsbAdaptor *adaptor, libusb_device *usb_device, PluginAdaptor *plugin_adaptor, const std::string &serial, unsigned int mode)
std::string SerialNumber () const
 Get the serial number of this widget. More...
unsigned int Mode () const
 Get the current mode 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

- Static Public Attributes inherited from ola::plugin::usbdmx::DMXCProjectsNodleU1
static int NODLE_DEFAULT_MODE = 6
static int NODLE_MIN_MODE = 0
static int NODLE_MAX_MODE = 7
static int OUTPUT_ENABLE_MASK = 2
static int INPUT_ENABLE_MASK = 4
- Protected Attributes inherited from ola::plugin::usbdmx::DMXCProjectsNodleU1
unsigned int m_mode
- 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::SynchronousDMXCProjectsNodleU1::SynchronousDMXCProjectsNodleU1 ( ola::usb::LibUsbAdaptor adaptor,
libusb_device *  usb_device,
PluginAdaptor plugin_adaptor,
const std::string &  serial,
unsigned int  mode 

Create a new SynchronousDMXCProjectsNodleU1.

adaptorthe LibUsbAdaptor to use.
usb_devicethe libusb_device to use for the widget.
plugin_adaptorthe PluginAdaptor used to execute callbacks
serialthe serial number of this widget
modethe send/receive mode to be used by the widget.

Member Function Documentation

bool ola::plugin::usbdmx::SynchronousDMXCProjectsNodleU1::Init ( )

Initialize the widget.

true if this widget was initialized correctly, false otherwise.

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

bool ola::plugin::usbdmx::SynchronousDMXCProjectsNodleU1::SendDMX ( const DmxBuffer buffer)

Send DMX data from this widget.

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

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

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