Open Lighting Architecture  0.9.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | List of all members
ola::plugin::usbdmx::GenericDevice Class Reference

Detailed Description

A Generic device.

This simple generic device creates a single output port around a Widget.

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

Public Member Functions

 GenericDevice (ola::AbstractPlugin *owner, class Widget *widget, const std::string &device_name, const std::string &device_id)
 Create a new GenericDevice.
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)

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

ola::plugin::usbdmx::GenericDevice::GenericDevice ( ola::AbstractPlugin owner,
class Widget widget,
const std::string &  device_name,
const std::string &  device_id 
)

Create a new GenericDevice.

Parameters
ownerThe plugin this device belongs to
widgetThe widget to use for this device.
device_nameThe name of the device.
device_idThe id of the device.

Member Function Documentation

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

The device ID.

Returns
an id which is unique within the plugin,

Implements ola::Device.

bool ola::plugin::usbdmx::GenericDevice::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: