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::usb::JaRulePortHandle Class Reference

Detailed Description

Represents a DMX/RDM port on a Ja Rule device.

Inheritance diagram for ola::usb::JaRulePortHandle:
Inheritance graph
[legend]
Collaboration diagram for ola::usb::JaRulePortHandle:
Collaboration graph
[legend]

Public Member Functions

 JaRulePortHandle (class JaRuleWidgetPort *parent_port, const ola::rdm::UID &uid, uint8_t physical_port)
 Create a new Ja Rule Port Handle.
 
void SendRDMRequest (ola::rdm::RDMRequest *request, ola::rdm::RDMCallback *on_complete)
 Send a RDM command. More...
 
void RunFullDiscovery (ola::rdm::RDMDiscoveryCallback *callback)
 Start a full discovery operation. More...
 
void RunIncrementalDiscovery (ola::rdm::RDMDiscoveryCallback *callback)
 Start an incremental discovery operation. More...
 
bool SendDMX (const DmxBuffer &buffer)
 Send DMX data from this widget. More...
 
bool SetPortMode (JaRulePortMode new_mode)
 Change the mode of the port. More...
 

Member Function Documentation

void ola::usb::JaRulePortHandle::RunFullDiscovery ( ola::rdm::RDMDiscoveryCallback callback)
virtual

Start a full discovery operation.

Parameters
callbackThe callback run when discovery completes. This may run immediately in some implementations.

Implements ola::rdm::DiscoverableRDMControllerInterface.

void ola::usb::JaRulePortHandle::RunIncrementalDiscovery ( ola::rdm::RDMDiscoveryCallback callback)
virtual

Start an incremental discovery operation.

Parameters
callbackThe callback run when discovery completes. This may run immediately in some implementations.

Implements ola::rdm::DiscoverableRDMControllerInterface.

bool ola::usb::JaRulePortHandle::SendDMX ( const DmxBuffer buffer)

Send DMX data from this widget.

Parameters
bufferThe DmxBuffer containing the data to send.
Returns
true if the data was sent, false otherwise.
void ola::usb::JaRulePortHandle::SendRDMRequest ( ola::rdm::RDMRequest request,
ola::rdm::RDMCallback on_complete 
)
virtual

Send a RDM command.

Parameters
requestthe RDMRequest, ownership is transferred.
on_completeThe callback to run when the request completes.

Implementors much ensure that the callback is always run at some point. In other words, there must be no way that a request can be dropped in such a way that the callback is never run. Doing so will either block all subsequent requests, or leak memory depending on the implementation.

Also the implementor of this class may want to re-write the transaction #, and possibly the UID (changing src UIDs isn't addressed by the RDM spec).

The RDMRequest may be a DISCOVERY_COMMAND, if the implementation does not support DISCOVERY_COMMANDs then the callback should be run with ola::rdm::RDM_PLUGIN_DISCOVERY_NOT_SUPPORTED.

Implements ola::rdm::RDMControllerInterface.

bool ola::usb::JaRulePortHandle::SetPortMode ( JaRulePortMode  new_mode)

Change the mode of the port.

Todo:
I need to think about how to return errors from this since it's async.

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