Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | List of all members
ola::AbstractDevice Class Referenceabstract

Detailed Description

The interface for a Device.

Inheritance diagram for ola::AbstractDevice:
Inheritance graph

Public Types

typedef BaseCallback0< void > ConfigureCallback

Public Member Functions

virtual const std::string Name () const =0
 The name of this Device.
virtual AbstractPluginOwner () const =0
 The Plugin that owns this Device.
virtual std::string UniqueId () const =0
 The unique id of this Device. More...
virtual bool Stop ()=0
 Stop the Device.
virtual bool AllowLooping () const =0
 Allow input and output ports to be patched to the same universe.
virtual bool AllowMultiPortPatching () const =0
 Allow multiple ports of the same type to be patched to the same universe.
virtual void InputPorts (std::vector< InputPort * > *ports) const =0
 Fetch a list of all ports in this Device.
virtual void OutputPorts (std::vector< OutputPort * > *ports) const =0
virtual InputPortGetInputPort (unsigned int port_id) const =0
 Lookup a particular InputPort in this Device.
virtual OutputPortGetOutputPort (unsigned int port_id) const =0
 Lookup a particular OutputPort in this Device.
virtual void Configure (ola::rpc::RpcController *controller, const std::string &request, std::string *response, ConfigureCallback *done)=0
 Configure this Device.

Member Function Documentation

virtual std::string ola::AbstractDevice::UniqueId ( ) const
pure virtual

The unique id of this Device.

This is guaranteed to be unique and persist across restarts.

Implemented in ola::Device.

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