ola::OutputPort Class Reference

Detailed Description

A port that sends DMX512 data.

Inheritance diagram for ola::OutputPort:

Collaboration diagram for ola::OutputPort:

Public Member Functions
virtual bool	WriteDMX (const DmxBuffer &buffer, uint8_t priority)=0
	Write DMX data to this port.
virtual void	UniverseNameChanged (const std::string &new_name)=0
	Called if the universe name changes.
virtual void	SendRDMRequest (ola::rdm::RDMRequest *request, ola::rdm::RDMCallback *callback)=0
virtual void	RunFullDiscovery (ola::rdm::RDMDiscoveryCallback *on_complete)=0
virtual void	RunIncrementalDiscovery (ola::rdm::RDMDiscoveryCallback *on_complete)=0
virtual bool	SupportsTimeCode () const =0
virtual bool	SendTimeCode (const ola::timecode::TimeCode &timecode)=0
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 AbstractDevice *	GetDevice () 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 Universe *	GetUniverse () 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.

Additional Inherited Members
Private Member Functions inherited from ola::rdm::DiscoverableRDMControllerInterface
virtual void	RunFullDiscovery (RDMDiscoveryCallback *callback)=0
	Start a full discovery operation.
virtual void	RunIncrementalDiscovery (RDMDiscoveryCallback *callback)=0
	Start an incremental discovery operation.

Member Function Documentation

virtual bool ola::OutputPort::WriteDMX ( const DmxBuffer &  buffer, uint8_t  priority  )

pure virtual

Write DMX data to this port.

Parameters

buffer	the DmxBuffer to write
priority	the priority of the DMX data

Returns

true on success, false on failure

Implemented in ola::plugin::usbpro::UsbProOutputPort, ola::plugin::usbpro::UltraDMXProOutputPort, ola::plugin::osc::OSCOutputPort, ola::plugin::sandnet::SandNetOutputPort, ola::plugin::usbpro::RobeOutputPort, ola::plugin::e131::E131OutputPort, ola::plugin::openpixelcontrol::OPCOutputPort, ola::plugin::pathport::PathportOutputPort, ola::plugin::artnet::ArtNetOutputPort, ola::plugin::dummy::DummyPort, ola::plugin::espnet::EspNetOutputPort, ola::plugin::usbpro::ArduinoRGBOutputPort, ola::plugin::usbpro::DmxTriOutputPort, ola::plugin::shownet::ShowNetOutputPort, ola::plugin::usbpro::DmxterOutputPort, ola::plugin::gpio::GPIOOutputPort, ola::plugin::ftdidmx::FtdiDmxOutputPort, ola::plugin::uartdmx::UartDmxOutputPort, ola::plugin::usbdmx::GenericOutputPort, ola::plugin::karate::KarateOutputPort, ola::plugin::opendmx::OpenDmxOutputPort, ola::plugin::stageprofi::StageProfiOutputPort, ola::plugin::usbdmx::JaRuleOutputPort, ola::plugin::dmx4linux::Dmx4LinuxOutputPort, ola::plugin::spi::SPIOutputPort, ola::plugin::kinet::KiNetOutputPort, ola::plugin::milinst::MilInstOutputPort, and ola::plugin::renard::RenardOutputPort.

---

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

• include/olad/Port.h