Open Lighting Architecture  0.9.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | List of all members
ola::BasicOutputPort Class Reference

Detailed Description

An implementation of an OutputPort.

Inheritance diagram for ola::BasicOutputPort:
ola::OutputPort ola::Port ola::rdm::DiscoverableRDMControllerInterface ola::plugin::artnet::ArtNetOutputPort ola::plugin::dmx4linux::Dmx4LinuxOutputPort ola::plugin::dummy::DummyPort ola::plugin::e131::E131OutputPort ola::plugin::espnet::EspNetOutputPort ola::plugin::ftdidmx::FtdiDmxOutputPort ola::plugin::karate::KarateOutputPort ola::plugin::kinet::KiNetOutputPort ola::plugin::milinst::MilInstOutputPort ola::plugin::opendmx::OpenDmxOutputPort ola::plugin::osc::OSCOutputPort ola::plugin::pathport::PathportOutputPort ola::plugin::renard::RenardOutputPort ola::plugin::sandnet::SandNetOutputPort ola::plugin::shownet::ShowNetOutputPort ola::plugin::spi::SPIOutputPort ola::plugin::stageprofi::StageProfiOutputPort ola::plugin::uartdmx::UartDmxOutputPort ola::plugin::usbdmx::AnymaOutputPort ola::plugin::usbdmx::EuroliteProOutputPort ola::plugin::usbdmx::SunliteOutputPort ola::plugin::usbdmx::VellemanOutputPort ola::plugin::usbpro::ArduinoRGBOutputPort ola::plugin::usbpro::DmxterOutputPort ola::plugin::usbpro::DmxTriOutputPort ola::plugin::usbpro::RobeOutputPort ola::plugin::usbpro::UltraDMXProOutputPort ola::plugin::usbpro::UsbProOutputPort

Public Member Functions

 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 void SendRDMRequest (const ola::rdm::RDMRequest *request, ola::rdm::RDMCallback *callback)
 Handle an RDMRequest, subclasses can implement this to support RDM.
virtual void RunFullDiscovery (ola::rdm::RDMDiscoveryCallback *on_complete)
 This is a noop for ports that don't support RDM.
virtual void RunIncrementalDiscovery (ola::rdm::RDMDiscoveryCallback *on_complete)
 This is a noop for ports that don't support RDM.
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
- Public Member Functions inherited from ola::OutputPort
virtual bool WriteDMX (const DmxBuffer &buffer, uint8_t priority)=0
 Write DMX data to this port.
- Public Member Functions inherited from ola::Port
virtual unsigned int PortId () const =0
 Get the Port ID. This is the index within the device.
virtual AbstractDeviceGetDevice () const =0
 Get the device which owns this Port.
virtual std::string Description () const =0
 Fetch the string description for a Port.
virtual bool SetUniverse (Universe *universe)=0
 Bind this port to a universe.
virtual UniverseGetUniverse () const =0
 Fetch the universe this Port is bound to.
virtual std::string UniqueId () const =0
 Return the globally unique id for a Port.
virtual port_priority_capability PriorityCapability () const =0
 Get the priority capabilities for this port.
virtual bool SetPriority (uint8_t priority)=0
 Set the Priority for this Port.
virtual uint8_t GetPriority () const =0
 Get the numeric priority for this Port.
virtual void SetPriorityMode (port_priority_mode mode)=0
 Set the Priority Mode for this Port.
virtual port_priority_mode GetPriorityMode () const =0
 Get the Priority Mode for this Port.
virtual bool SupportsRDM () const =0
 Check if this Port supports RDM or not.

Protected Member Functions

virtual bool SupportsPriorities () const
void UpdateUIDs (const ola::rdm::UIDSet &uids)
 Called when the discovery triggered by patching completes.

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