Open Lighting Architecture 0.10.9
Loading...
Searching...
No Matches
ola::plugin::usbdmx::DMXCProjectsNodleU1InputPort Class Reference

Detailed Description

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

Inheritance diagram for ola::plugin::usbdmx::DMXCProjectsNodleU1InputPort:
ola::BasicInputPort ola::InputPort ola::Port

Public Member Functions

 DMXCProjectsNodleU1InputPort (Device *parent, unsigned int id, PluginAdaptor *plugin_adaptor, class DMXCProjectsNodleU1 *widget)
 Create a new DMXCProjectsNodleU1InputPort.
 
const DmxBufferReadDMX () const
 
std::string Description () const
 Fetch the string description for a Port.
 
- Public Member Functions inherited from ola::BasicInputPort
 BasicInputPort (AbstractDevice *parent, unsigned int port_id, const PluginAdaptor *plugin_adaptor, bool supports_rdm=false)
 Create a new basic input port.
 
unsigned int PortId () const
 Get the Port ID. This is the index within the device.
 
AbstractDeviceGetDevice () const
 Get the device which owns this Port.
 
bool SetUniverse (Universe *universe)
 Bind this port to a universe.
 
UniverseGetUniverse () const
 Fetch the universe this Port is bound to.
 
virtual std::string UniqueId () const
 Return the globally unique id for a Port.
 
bool SetPriority (uint8_t priority)
 Set the Priority for this Port.
 
uint8_t GetPriority () const
 Get the numeric priority for this Port.
 
void SetPriorityMode (port_priority_mode mode)
 Set the Priority Mode for this Port.
 
port_priority_mode GetPriorityMode () const
 Get the Priority Mode for this Port.
 
void DmxChanged ()
 Called when there is new data for this port.
 
const DmxSourceSourceData () const
 Get the current DMX data.
 
void HandleRDMRequest (ola::rdm::RDMRequest *request, ola::rdm::RDMCallback *callback)
 Handle an RDM Request on this port.
 
void TriggerRDMDiscovery (ola::rdm::RDMDiscoveryCallback *on_complete, bool full=true)
 Trigger the RDM Discovery procedure for this universe.
 
port_priority_capability PriorityCapability () const
 Get the priority capabilities for this port.
 
virtual uint8_t InheritedPriority () const
 
virtual bool PreSetUniverse (Universe *, Universe *)
 
virtual void PostSetUniverse (Universe *, Universe *)
 
virtual bool SupportsRDM () const
 Check if this Port supports RDM or not.
 
- Public Member Functions inherited from ola::InputPort
- Public Member Functions inherited from ola::Port

Additional Inherited Members

- Protected Member Functions inherited from ola::BasicInputPort
virtual bool SupportsPriorities () const
 

Constructor & Destructor Documentation

◆ DMXCProjectsNodleU1InputPort()

ola::plugin::usbdmx::DMXCProjectsNodleU1InputPort::DMXCProjectsNodleU1InputPort ( Device * parent,
unsigned int id,
PluginAdaptor * plugin_adaptor,
class DMXCProjectsNodleU1 * widget )

Create a new DMXCProjectsNodleU1InputPort.

Parameters
parentThe parent device for this port.
idThe port id.
plugin_adaptora PluginAdaptor object, used by the base class.
widgetThe widget to use to receive DMX frames.

Member Function Documentation

◆ Description()

std::string ola::plugin::usbdmx::DMXCProjectsNodleU1InputPort::Description ( ) const
inlinevirtual

Fetch the string description for a Port.

Returns
a short text description of this port.

Implements ola::Port.

◆ ReadDMX()

const DmxBuffer & ola::plugin::usbdmx::DMXCProjectsNodleU1InputPort::ReadDMX ( ) const
inlinevirtual

Implements ola::BasicInputPort.


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