ola::plugin::osc::OSCInputPort Class Reference

Detailed Description

The Input Port class, for receiving DMX via OSC. Note that the description of the port may change as it's patched and unpatched from a universe (since the description can contain d). Therefore we store the description as a template, as well as the current value.

Inheritance diagram for ola::plugin::osc::OSCInputPort:

Public Member Functions
	OSCInputPort (OSCDevice *parent, unsigned int port_id, PluginAdaptor *plugin_adaptor, OSCNode *node, const std::string &address)
const DmxBuffer &	ReadDMX () const
bool	PreSetUniverse (Universe *old_universe, Universe *new_universe)
std::string	Description () const
Public Member Functions inherited from ola::BasicInputPort
	BasicInputPort (AbstractDevice *parent, unsigned int port_id, const PluginAdaptor *plugin_adaptor, bool supports_rdm=false)
unsigned int	PortId () const
AbstractDevice *	GetDevice () const
bool	SetUniverse (Universe *universe)
Universe *	GetUniverse () const
virtual std::string	UniqueId () const
bool	SetPriority (uint8_t priority)
uint8_t	GetPriority () const
void	SetPriorityMode (port_priority_mode mode)
port_priority_mode	GetPriorityMode () const
void	DmxChanged ()
const DmxSource &	SourceData () const
void	HandleRDMRequest (const ola::rdm::RDMRequest *request, ola::rdm::RDMCallback *callback)
void	TriggerRDMDiscovery (ola::rdm::RDMDiscoveryCallback *on_complete, bool full=true)
port_priority_capability	PriorityCapability () const
virtual uint8_t	InheritedPriority () const
virtual void	PostSetUniverse (Universe *, Universe *)
virtual bool	SupportsRDM () const

Additional Inherited Members
Protected Member Functions inherited from ola::BasicInputPort
virtual bool	SupportsPriorities () const

Constructor & Destructor Documentation

ola::plugin::osc::OSCInputPort::OSCInputPort	(	OSCDevice *	parent,
		unsigned int	port_id,
		PluginAdaptor *	plugin_adaptor,
		OSCNode *	node,
		const std::string &	address
	)

Create an OSCInputPort.

Parameters

parent	the parent device
port_id	the id for this port
plugin_adaptor	a PluginAdaptor object, used by the base class.
node	the OSCNode object to use
address	the OSC address string for this port

Member Function Documentation

std::string ola::plugin::osc::OSCInputPort::Description ( ) const

inlinevirtual

Return the actual description

Implements ola::Port.

bool ola::plugin::osc::OSCInputPort::PreSetUniverse ( Universe *  old_universe, Universe *  new_universe  )

virtual

Called during the patch process, just before the Universe of this port changes.

Reimplemented from ola::BasicInputPort.

const DmxBuffer& ola::plugin::osc::OSCInputPort::ReadDMX ( ) const

inlinevirtual

Just return our DmxBuffer.

Implements ola::BasicInputPort.

---

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

• plugins/osc/OSCPort.h
• plugins/osc/OSCPort.cpp