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

Detailed Description

A thin wrapper around a JaRulePortHandle so that it can operate as an OLA Port.

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

Public Member Functions

 JaRuleOutputPort (Device *parent, unsigned int index, ola::usb::JaRuleWidget *widget)
 Create a new JaRuleOutputPort. More...
 ~JaRuleOutputPort ()
bool Init ()
 Initialize the port. More...
bool WriteDMX (const DmxBuffer &buffer, uint8_t priority)
 Write DMX data to this port. More...
std::string Description () const
 Fetch the string description for a Port. More...
void SendRDMRequest (ola::rdm::RDMRequest *request, ola::rdm::RDMCallback *callback)
 Handle an RDMRequest, subclasses can implement this to support RDM.
void RunFullDiscovery (ola::rdm::RDMDiscoveryCallback *callback)
 This is a noop for ports that don't support RDM.
void RunIncrementalDiscovery (ola::rdm::RDMDiscoveryCallback *callback)
 This is a noop for ports that don't support RDM.
bool PreSetUniverse (Universe *old_universe, Universe *new_universe)
void PostSetUniverse (Universe *old_universe, Universe *new_universe)
- 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
 Get the Port ID. This is the index within the device. More...
AbstractDeviceGetDevice () const
 Get the device which owns this Port. More...
bool SetUniverse (Universe *universe)
 Bind this port to a universe. More...
UniverseGetUniverse () const
 Fetch the universe this Port is bound to. More...
std::string UniqueId () const
 Return the globally unique id for a Port. More...
bool SetPriority (uint8_t priority)
 Set the Priority for this Port. More...
uint8_t GetPriority () const
 Get the numeric priority for this Port. More...
void SetPriorityMode (port_priority_mode mode)
 Set the Priority Mode for this Port. More...
port_priority_mode GetPriorityMode () const
 Get the Priority Mode for this Port. More...
virtual void UniverseNameChanged (const std::string &new_name)
 Called if the universe name changes.
port_priority_capability PriorityCapability () const
 Get the priority capabilities for this port. More...
virtual bool SupportsTimeCode () const
virtual bool SendTimeCode (const ola::timecode::TimeCode &)
 This is a noop for ports that don't support TimeCode.
virtual bool SupportsRDM () const
 Check if this Port supports RDM or not. More...

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::JaRuleOutputPort::JaRuleOutputPort ( Device parent,
unsigned int  index,
ola::usb::JaRuleWidget widget 

Create a new JaRuleOutputPort.

parentThe parent device for this port.
indexThe port index, starting from 0
widgetThe widget to use.

Member Function Documentation

std::string ola::plugin::usbdmx::JaRuleOutputPort::Description ( ) const

Fetch the string description for a Port.

a short text description of this port.

Implements ola::Port.

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

Initialize the port.

true if ok, false if initialization failed.
bool ola::plugin::usbdmx::JaRuleOutputPort::WriteDMX ( const DmxBuffer buffer,
uint8_t  priority 

Write DMX data to this port.

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

Implements ola::OutputPort.

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