ola::plugin::openpixelcontrol::OPCOutputPort Class Reference

Detailed Description

An OutputPort for the OPC plugin.

Inheritance diagram for ola::plugin::openpixelcontrol::OPCOutputPort:

Public Member Functions
	OPCOutputPort (OPCClientDevice *parent, uint8_t channel, class OPCClient *client)
	Create a new OPC Output Port.
bool	WriteDMX (const DmxBuffer &buffer, uint8_t priority)
	Write DMX data to this port.
std::string	Description () const
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
AbstractDevice *	GetDevice () const
bool	SetUniverse (Universe *universe)
Universe *	GetUniverse () 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

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::openpixelcontrol::OPCOutputPort::OPCOutputPort	(	OPCClientDevice *	parent,
		uint8_t	channel,
		class OPCClient *	client
	)

Create a new OPC Output Port.

Parameters

parent	the OPCDevice this port belongs to
channel	the OPC channel for the port.
client	the OPCClient to use for this port, ownership is not transferred.

Member Function Documentation

bool ola::plugin::openpixelcontrol::OPCOutputPort::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/openpixelcontrol/OPCPort.h
• plugins/openpixelcontrol/OPCPort.cpp