Open Lighting Architecture  0.9.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
ola::plugin::e131::E131InputPort Class Reference
Inheritance diagram for ola::plugin::e131::E131InputPort:
ola::BasicInputPort ola::InputPort ola::Port

Public Member Functions

 E131InputPort (E131Device *parent, int id, E131Node *node, class PluginAdaptor *plugin_adaptor)
bool PreSetUniverse (Universe *old_universe, Universe *new_universe)
void PostSetUniverse (Universe *old_universe, Universe *new_universe)
std::string Description () const
 Fetch the string description for a Port.
const ola::DmxBuffer & ReadDMX () const
bool SupportsPriorities () const
uint8_t InheritedPriority () 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.
AbstractDevice * GetDevice () const
 Get the device which owns this Port.
bool SetUniverse (Universe *universe)
 Bind this port to a universe.
Universe * GetUniverse () const
 Fetch the universe this Port is bound to.
virtual std::string UniqueId () const
 Return the globally unique id for a Port.
bool SetPriority (uint8_t priority)
 Set the Priority for this Port.
uint8_t GetPriority () const
 Get the numeric priority for this Port.
void SetPriorityMode (port_priority_mode mode)
 Set the Priority Mode for this Port.
port_priority_mode GetPriorityMode () const
 Get the Priority Mode for this Port.
void DmxChanged ()
 Called when there is new data for this port.
const DmxSource & SourceData () const
 Get the current DMX data.
void HandleRDMRequest (const ola::rdm::RDMRequest *request, ola::rdm::RDMCallback *callback)
 Handle an RDM Request on this port.
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.
virtual bool SupportsRDM () const
 Check if this Port supports RDM or not.

Member Function Documentation

std::string ola::plugin::e131::E131InputPort::Description ( ) const
inlinevirtual

Fetch the string description for a Port.

Returns
a short text description of this port.

Implements ola::Port.


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