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::dmx4linux::Dmx4LinuxInputPort Class Reference
Inheritance diagram for ola::plugin::dmx4linux::Dmx4LinuxInputPort:
Inheritance graph
[legend]
Collaboration diagram for ola::plugin::dmx4linux::Dmx4LinuxInputPort:
Collaboration graph
[legend]

Public Member Functions

 Dmx4LinuxInputPort (Dmx4LinuxDevice *parent, class PluginAdaptor *plugin_adaptor)
 
const DmxBufferReadDMX () const
 
bool UpdateData (const uint8_t *in_buffer, unsigned int length)
 
string Description () const
 Fetch the string description for a Port. More...
 
- 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 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::BasicInputPort
virtual bool SupportsPriorities () const
 

Member Function Documentation

string ola::plugin::dmx4linux::Dmx4LinuxInputPort::Description ( ) const
inlinevirtual

Fetch the string description for a Port.

Returns
a short text description of this port.

Implements ola::Port.

const DmxBuffer & ola::plugin::dmx4linux::Dmx4LinuxInputPort::ReadDMX ( ) const
virtual

Read operation

Returns
a DmxBufer with the data

Implements ola::BasicInputPort.

bool ola::plugin::dmx4linux::Dmx4LinuxInputPort::UpdateData ( const uint8_t *  in_buffer,
unsigned int  length 
)

Process new Data


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