Open Lighting Architecture
Latest Git
|
The base port class.
Ports represent a single universe of DMX512. They are either input (receive DMX) or output (send DMX) but not both.
Every port is part of a Device. Ports can be associated (patched) to a universe.
Public Member Functions | |
virtual unsigned int | PortId () const =0 |
Get the Port ID. This is the index within the device. More... | |
virtual AbstractDevice * | GetDevice () const =0 |
Get the device which owns this Port. More... | |
virtual std::string | Description () const =0 |
Fetch the string description for a Port. More... | |
virtual bool | SetUniverse (Universe *universe)=0 |
Bind this port to a universe. More... | |
virtual Universe * | GetUniverse () const =0 |
Fetch the universe this Port is bound to. More... | |
virtual std::string | UniqueId () const =0 |
Return the globally unique id for a Port. More... | |
virtual port_priority_capability | PriorityCapability () const =0 |
Get the priority capabilities for this port. More... | |
virtual bool | SetPriority (uint8_t priority)=0 |
Set the Priority for this Port. More... | |
virtual uint8_t | GetPriority () const =0 |
Get the numeric priority for this Port. More... | |
virtual void | SetPriorityMode (port_priority_mode mode)=0 |
Set the Priority Mode for this Port. More... | |
virtual port_priority_mode | GetPriorityMode () const =0 |
Get the Priority Mode for this Port. More... | |
virtual bool | SupportsRDM () const =0 |
Check if this Port supports RDM or not. More... | |
|
pure virtual |
Fetch the string description for a Port.
Implemented in ola::plugin::usbpro::UsbProOutputPort, ola::plugin::usbpro::UltraDMXProOutputPort, ola::plugin::usbpro::UsbProInputPort, ola::plugin::osc::OSCOutputPort, ola::plugin::usbpro::UltraDMXProInputPort, ola::plugin::artnet::ArtNetOutputPort, ola::plugin::usbpro::RobeOutputPort, ola::plugin::sandnet::SandNetOutputPort, ola::plugin::e131::E131OutputPort, ola::plugin::openpixelcontrol::OPCOutputPort, ola::plugin::dmx4linux::Dmx4LinuxInputPort, ola::plugin::usbpro::DmxterOutputPort, ola::plugin::pathport::PathportOutputPort, ola::plugin::dummy::DummyPort, ola::plugin::usbpro::RobeInputPort, ola::plugin::osc::OSCInputPort, ola::plugin::espnet::EspNetOutputPort, ola::plugin::usbpro::DmxTriOutputPort, ola::plugin::sandnet::SandNetInputPort, ola::plugin::usbdmx::JaRuleOutputPort, ola::plugin::usbpro::ArduinoRGBOutputPort, ola::plugin::spidmx::SPIDMXInputPort, ola::plugin::shownet::ShowNetOutputPort, ola::plugin::ftdidmx::FtdiDmxOutputPort, ola::plugin::gpio::GPIOOutputPort, ola::plugin::usbdmx::DMXCProjectsNodleU1InputPort, ola::plugin::e131::E131InputPort, ola::plugin::openpixelcontrol::OPCInputPort, ola::plugin::uartdmx::UartDmxOutputPort, ola::plugin::artnet::ArtNetInputPort, ola::plugin::usbdmx::GenericOutputPort, ola::plugin::stageprofi::StageProfiOutputPort, ola::plugin::pathport::PathportInputPort, ola::plugin::dmx4linux::Dmx4LinuxOutputPort, ola::plugin::espnet::EspNetInputPort, ola::plugin::karate::KarateOutputPort, ola::plugin::kinet::KiNetOutputPort, ola::plugin::nanoleaf::NanoleafOutputPort, ola::plugin::opendmx::OpenDmxOutputPort, ola::plugin::spi::SPIOutputPort, ola::plugin::shownet::ShowNetInputPort, ola::plugin::milinst::MilInstOutputPort, and ola::plugin::renard::RenardOutputPort.
|
pure virtual |
Get the device which owns this Port.
Implemented in ola::BasicOutputPort, and ola::BasicInputPort.
|
pure virtual |
Get the numeric priority for this Port.
Implemented in ola::BasicOutputPort, and ola::BasicInputPort.
|
pure virtual |
Get the Priority Mode for this Port.
Implemented in ola::BasicOutputPort, and ola::BasicInputPort.
|
pure virtual |
Fetch the universe this Port is bound to.
Implemented in ola::BasicOutputPort, and ola::BasicInputPort.
|
pure virtual |
Get the Port ID. This is the index within the device.
Implemented in ola::BasicOutputPort, and ola::BasicInputPort.
|
pure virtual |
Get the priority capabilities for this port.
Implemented in ola::BasicOutputPort, and ola::BasicInputPort.
|
pure virtual |
Set the Priority for this Port.
priority | the priority to use. |
Implemented in ola::BasicOutputPort, and ola::BasicInputPort.
|
pure virtual |
Set the Priority Mode for this Port.
mode | the Priority Mode to use. |
Implemented in ola::BasicOutputPort, and ola::BasicInputPort.
|
pure virtual |
Bind this port to a universe.
universe | the Universe to bind to. |
This shouldn't be called directly. Instead use PortManager::PatchPort() which takes care of everything for you.
Implemented in ola::BasicOutputPort, and ola::BasicInputPort.
|
pure virtual |
Check if this Port supports RDM or not.
Implemented in ola::BasicOutputPort, and ola::BasicInputPort.
|
pure virtual |
Return the globally unique id for a Port.
This is used to preserve port universe bindings. An empty string means we don't preserve settings.
Implemented in ola::BasicOutputPort, and ola::BasicInputPort.