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

Detailed Description

A thin wrapper around a Widget so that it can operate as a Port.

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

Public Member Functions

 GenericOutputPort (Device *parent, unsigned int id, class Widget *widget)
 Create a new GenericOutputPort.
bool WriteDMX (const DmxBuffer &buffer, uint8_t priority)
 Write DMX data to this port.
std::string Description () const
- Public Member Functions inherited from ola::BasicOutputPort
 BasicOutputPort (AbstractDevice *parent, unsigned int port_id, bool start_rdm_discovery_on_patch=false, bool supports_rdm=false)
 Create a new BasicOutputPort.
unsigned int PortId () const
AbstractDeviceGetDevice () const
bool SetUniverse (Universe *universe)
UniverseGetUniverse () const
std::string UniqueId () const
bool SetPriority (uint8_t priority)
uint8_t GetPriority () const
void SetPriorityMode (port_priority_mode mode)
port_priority_mode GetPriorityMode () const
virtual void UniverseNameChanged (const std::string &new_name)
 Called if the universe name changes.
port_priority_capability PriorityCapability () const
virtual void SendRDMRequest (ola::rdm::RDMRequest *request, ola::rdm::RDMCallback *callback)
 Handle an RDMRequest, subclasses can implement this to support RDM.
virtual void RunFullDiscovery (ola::rdm::RDMDiscoveryCallback *on_complete)
 This is a noop for ports that don't support RDM.
virtual void RunIncrementalDiscovery (ola::rdm::RDMDiscoveryCallback *on_complete)
 This is a noop for ports that don't support RDM.
virtual bool SupportsTimeCode () const
virtual bool SendTimeCode (const ola::timecode::TimeCode &)
 This is a noop for ports that don't support TimeCode.
virtual bool PreSetUniverse (Universe *, Universe *)
virtual void PostSetUniverse (Universe *, Universe *)
virtual bool SupportsRDM () const

Additional Inherited Members

- Protected Member Functions inherited from ola::BasicOutputPort
virtual bool SupportsPriorities () const
void UpdateUIDs (const ola::rdm::UIDSet &uids)
 Called when the discovery triggered by patching completes.

Constructor & Destructor Documentation

ola::plugin::usbdmx::GenericOutputPort::GenericOutputPort ( Device parent,
unsigned int  id,
class Widget widget 
)

Create a new GenericOutputPort.

Parameters
parentThe parent device for this port.
idThe port id.
widgetThe widget to use to send DMX frames.

Member Function Documentation

bool ola::plugin::usbdmx::GenericOutputPort::WriteDMX ( const DmxBuffer buffer,
uint8_t  priority 
)
virtual

Write DMX data to this port.

Parameters
bufferthe DmxBuffer to write
prioritythe priority of the DMX data
Returns
true on success, false on failure

Implements ola::OutputPort.


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