Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
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:
Inheritance graph
[legend]
Collaboration diagram for ola::plugin::osc::OSCInputPort:
Collaboration graph
[legend]

Public Member Functions

 OSCInputPort (OSCDevice *parent, unsigned int port_id, PluginAdaptor *plugin_adaptor, OSCNode *node, const std::string &address)
 
const DmxBufferReadDMX () 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)
 Create a new basic input port.
 
unsigned int PortId () const
 Get the Port ID. This is the index within the device. More...
 
AbstractDeviceGetDevice () const
 Get the device which owns this Port. More...
 
bool SetUniverse (Universe *universe)
 Bind this port to a universe. More...
 
UniverseGetUniverse () const
 Fetch the universe this Port is bound to. More...
 
virtual 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...
 
void DmxChanged ()
 Called when there is new data for this port.
 
const DmxSourceSourceData () const
 Get the current DMX data.
 
void HandleRDMRequest (ola::rdm::RDMRequest *request, ola::rdm::RDMCallback *callback)
 Handle an RDM Request on this port. More...
 
void TriggerRDMDiscovery (ola::rdm::RDMDiscoveryCallback *on_complete, bool full=true)
 Trigger the RDM Discovery procedure for this universe.
 
port_priority_capability PriorityCapability () const
 Get the priority capabilities for this port. More...
 
virtual uint8_t InheritedPriority () const
 
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::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
parentthe parent device
port_idthe id for this port
plugin_adaptora PluginAdaptor object, used by the base class.
nodethe OSCNode object to use
addressthe 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: