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

Detailed Description

The internal implementation of a Ja Rule Port Handle.

This class is responsible for translating high level intent, e.g. "send RDM command" to the binary messages that can then be passed to a JaRuleWidget.

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

Public Member Functions

 JaRulePortHandleImpl (class JaRuleWidgetPort *parent_port, const ola::rdm::UID &uid, uint8_t physical_port)
 Create a new JaRulePortHandleImpl.
 
void RunFullDiscovery (ola::rdm::RDMDiscoveryCallback *callback)
 Start a full discovery operation. More...
 
void RunIncrementalDiscovery (ola::rdm::RDMDiscoveryCallback *callback)
 Start an incremental discovery operation. More...
 
void SendRDMRequest (ola::rdm::RDMRequest *request, ola::rdm::RDMCallback *on_complete)
 Send a RDM command. More...
 
void MuteDevice (const ola::rdm::UID &target, MuteDeviceCallback *mute_complete)
 Mute a device. More...
 
void UnMuteAll (UnMuteDeviceCallback *unmute_complete)
 Unmute all devices. More...
 
void Branch (const ola::rdm::UID &lower, const ola::rdm::UID &upper, BranchCallback *branch_complete)
 Send a DUB command. More...
 
bool SendDMX (const DmxBuffer &buffer)
 Send DMX data from this widget. More...
 
bool SetPortMode (JaRulePortMode new_mode)
 Change the mode of this port.
 

Additional Inherited Members

- Public Types inherited from ola::rdm::DiscoveryTargetInterface
typedef ola::BaseCallback1
< void, bool > 
MuteDeviceCallback
 The callback run when a mute command completes. More...
 
typedef ola::BaseCallback0< void > UnMuteDeviceCallback
 The callback run when an unmute command completes.
 
typedef ola::BaseCallback2
< void, const uint8_t
*, unsigned int > 
BranchCallback
 The callback run when a DUB command completes. More...
 

Member Function Documentation

void ola::usb::JaRulePortHandleImpl::Branch ( const ola::rdm::UID lower,
const ola::rdm::UID upper,
BranchCallback callback 
)
virtual

Send a DUB command.

Parameters
lowerthe lower bound UID.
upperthe upper bound UID.
callbackthe callback to run when the DUB completes.

Any data received in response to the DUB command should be passed back when the callback is run.

Implements ola::rdm::DiscoveryTargetInterface.

void ola::usb::JaRulePortHandleImpl::MuteDevice ( const ola::rdm::UID target,
MuteDeviceCallback mute_complete 
)
virtual

Mute a device.

Parameters
targetthe device to mute
mute_completethe callback to run when the mute operations completes.

Implements ola::rdm::DiscoveryTargetInterface.

void ola::usb::JaRulePortHandleImpl::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::JaRulePortHandleImpl::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::JaRulePortHandleImpl::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::JaRulePortHandleImpl::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.

void ola::usb::JaRulePortHandleImpl::UnMuteAll ( UnMuteDeviceCallback unmute_complete)
virtual

Unmute all devices.

Parameters
unmute_completethe callback to run when the unmute operation completes.

Implements ola::rdm::DiscoveryTargetInterface.


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