Open Lighting Architecture  0.9.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Member Functions | List of all members
ola::plugin::dummy::DummyPort Class Reference
Inheritance diagram for ola::plugin::dummy::DummyPort:
ola::BasicOutputPort ola::OutputPort ola::Port ola::rdm::DiscoverableRDMControllerInterface

Classes

struct  broadcast_request_tracker
struct  Options

Public Member Functions

 DummyPort (class DummyDevice *parent, const Options &options, unsigned int id)
bool WriteDMX (const DmxBuffer &buffer, uint8_t priority)
 Write DMX data to this port.
std::string Description () const
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.
void SendRDMRequest (const ola::rdm::RDMRequest *request, ola::rdm::RDMCallback *callback)
 Handle an RDMRequest, subclasses can implement this to support RDM.
- 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 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::dummy::DummyPort::DummyPort ( class DummyDevice parent,
const Options options,
unsigned int  id 
)

Create a new DummyPort

Parameters
parentthe parent device for this port
optionsthe config for the DummyPort such as the number of fake RDM devices to create
idthe ID of this port

Member Function Documentation

bool ola::plugin::dummy::DummyPort::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: