Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Protected Member Functions | List of all members
ola::plugin::gpio::GPIODevice Class Reference

Detailed Description

The GPIO Device.

Inheritance diagram for ola::plugin::gpio::GPIODevice:
Inheritance graph
Collaboration diagram for ola::plugin::gpio::GPIODevice:
Collaboration graph

Public Member Functions

 GPIODevice (class GPIOPlugin *owner, const GPIODriver::Options &options)
 Create a new GPIODevice. More...
std::string DeviceId () const
 The device ID. More...
- Public Member Functions inherited from ola::Device
 Device (AbstractPlugin *owner, const std::string &name)
const std::string Name () const
 The name of this Device.
void SetName (const std::string &name)
 Sets the name of this Device.
AbstractPluginOwner () const
 The Plugin that owns this Device.
std::string UniqueId () const
 The unique id of this Device. More...
bool IsEnabled () const
bool Start ()
 Start the Device.
bool Stop ()
 Stop the Device.
bool AllowLooping () const
 Allow input and output ports to be patched to the same universe.
bool AllowMultiPortPatching () const
 Allow multiple ports of the same type to be patched to the same universe.
bool AddPort (InputPort *port)
bool AddPort (OutputPort *port)
void InputPorts (std::vector< InputPort * > *ports) const
 Fetch a list of all ports in this Device.
void OutputPorts (std::vector< OutputPort * > *ports) const
InputPortGetInputPort (unsigned int port_id) const
 Lookup a particular InputPort in this Device.
OutputPortGetOutputPort (unsigned int port_id) const
 Lookup a particular OutputPort in this Device.
void DeleteAllPorts ()
 Free all ports.
virtual void Configure (ola::rpc::RpcController *controller, const std::string &request, std::string *response, ConfigureCallback *done)
 Configure this Device.

Protected Member Functions

bool StartHook ()
 Called during Start(). More...
- 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::gpio::GPIODevice::GPIODevice ( class GPIOPlugin owner,
const GPIODriver::Options options 

Create a new GPIODevice.

ownerThe Plugin that owns this device.
optionsthe options to use for the new device.

Member Function Documentation

std::string ola::plugin::gpio::GPIODevice::DeviceId ( ) const

The device ID.

an id which is unique within the plugin,

Implements ola::Device.

bool ola::plugin::gpio::GPIODevice::StartHook ( )

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: