Open Lighting Architecture 0.10.9
Loading...
Searching...
No Matches
ola::plugin::usbdmx::JaRuleDevice Class Reference

Detailed Description

A JaRule device, that represents one widget.

A widget may have multiple input / output ports.

Inheritance diagram for ola::plugin::usbdmx::JaRuleDevice:
ola::Device ola::AbstractDevice

Public Member Functions

 JaRuleDevice (ola::AbstractPlugin *owner, ola::usb::JaRuleWidget *widget, const std::string &device_name)
 Create a new JaRuleDevice.
 
std::string DeviceId () const
 The device ID.
 
- Public Member Functions inherited from ola::Device
 Device (AbstractPlugin *owner, const std::string &name)
 
const std::string Name () const
 
void SetName (const std::string &name)
 
AbstractPluginOwner () const
 
std::string UniqueId () const
 
bool IsEnabled () const
 
bool Start ()
 
bool Stop ()
 
bool AllowLooping () const
 
bool AllowMultiPortPatching () const
 
bool AddPort (InputPort *port)
 
bool AddPort (OutputPort *port)
 
void InputPorts (std::vector< InputPort * > *ports) const
 
void OutputPorts (std::vector< OutputPort * > *ports) const
 
InputPortGetInputPort (unsigned int port_id) const
 
OutputPortGetOutputPort (unsigned int port_id) const
 
void DeleteAllPorts ()
 
virtual void Configure (ola::rpc::RpcController *controller, const std::string &request, std::string *response, ConfigureCallback *done)
 
- Public Member Functions inherited from ola::AbstractDevice

Protected Member Functions

bool StartHook ()
 Called during Start().
 
- Protected Member Functions inherited from ola::Device
virtual void PrePortStop ()
 
virtual void PostPortStop ()
 

Additional Inherited Members

- Public Types inherited from ola::AbstractDevice
typedef BaseCallback0< void > ConfigureCallback
 

Constructor & Destructor Documentation

◆ JaRuleDevice()

ola::plugin::usbdmx::JaRuleDevice::JaRuleDevice ( ola::AbstractPlugin * owner,
ola::usb::JaRuleWidget * widget,
const std::string & device_name )

Create a new JaRuleDevice.

Parameters
ownerThe plugin this device belongs to.
widgetAn initialized JaRuleWidget.
device_nameThe name of the device.

Member Function Documentation

◆ DeviceId()

std::string ola::plugin::usbdmx::JaRuleDevice::DeviceId ( ) const
inlinevirtual

The device ID.

Returns
an id which is unique within the plugin,

Implements ola::Device.

◆ StartHook()

bool ola::plugin::usbdmx::JaRuleDevice::StartHook ( )
protectedvirtual

Called during Start().

This allows the subclass to perform device initialization.

Reimplemented from ola::Device.


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