ola::plugin::usbdmx::GenericOutputPort Class Reference

Detailed Description

A thin wrapper around a Widget so that it can operate as a Port.

Inheritance diagram for ola::plugin::usbdmx::GenericOutputPort:

Collaboration diagram for ola::plugin::usbdmx::GenericOutputPort:

Public Member Functions
	GenericOutputPort (Device *parent, unsigned int id, class WidgetInterface *widget)
	Create a new GenericOutputPort. More...
bool	WriteDMX (const DmxBuffer &buffer, uint8_t priority)
	Write DMX data to this port. More...
std::string	Description () const
	Fetch the string description for a Port. More...
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
	Get the Port ID. This is the index within the device. More...
AbstractDevice *	GetDevice () const
	Get the device which owns this Port. More...
bool	SetUniverse (Universe *universe)
	Bind this port to a universe. More...
Universe *	GetUniverse () const
	Fetch the universe this Port is bound to. More...
std::string	UniqueId () const
	Return the globally unique id for a Port. More...
bool	SetPriority (uint8_t priority)
	Set the Priority for this Port. More...
uint8_t	GetPriority () const
	Get the numeric priority for this Port. More...
void	SetPriorityMode (port_priority_mode mode)
	Set the Priority Mode for this Port. More...
port_priority_mode	GetPriorityMode () const
	Get the Priority Mode for this Port. More...
virtual void	UniverseNameChanged (const std::string &new_name)
	Called if the universe name changes.
port_priority_capability	PriorityCapability () const
	Get the priority capabilities for this port. More...
virtual void	SendRDMRequest (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
	Check if this Port supports RDM or not. More...

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::usbdmx::GenericOutputPort::GenericOutputPort	(	Device *	parent,
		unsigned int	id,
		class WidgetInterface *	widget
	)

Create a new GenericOutputPort.

Parameters

parent	The parent device for this port.
id	The port id.
widget	The widget to use to send DMX frames.

Member Function Documentation

std::string ola::plugin::usbdmx::GenericOutputPort::Description ( ) const

inlinevirtual

Fetch the string description for a Port.

Returns

a short text description of this port.

Implements ola::Port.

bool ola::plugin::usbdmx::GenericOutputPort::WriteDMX ( const DmxBuffer &  buffer, uint8_t  priority  )

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

Implements ola::OutputPort.

---

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

• plugins/usbdmx/GenericOutputPort.h
• plugins/usbdmx/GenericOutputPort.cpp