Open Lighting Architecture: plugins/gpio/GPIODevice.h Source File

| Open Lighting Architecture 0.10.9

Loading...
Searching...
No Matches
GPIODevice.h
1/*
2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License, or
5 * (at your option) any later version.
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU Library General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
15 *
16 * GPIODevice.h
17 * The GPIO Device.
18 * Copyright (C) 2014 Simon Newton
19 */
20
21#ifndef PLUGINS_GPIO_GPIODEVICE_H_
22#define PLUGINS_GPIO_GPIODEVICE_H_
23
24#include <memory>
25#include <string>
26#include <vector>
27
28#include "olad/Device.h"
29#include "plugins/gpio/GPIODriver.h"
30
31namespace ola {
32namespace plugin {
33namespace gpio {
34
38 class GPIODevice: public ola::Device {
39 public:
45 GPIODevice(class GPIOPlugin *owner,
46 const GPIODriver::Options &options);
47
48 std::string DeviceId() const { return "1"; }
49
50 protected:
51 bool StartHook();
52
53 private:
54 const GPIODriver::Options m_options;
55
56 GPIODevice(const GPIODevice &) = delete;
57 const GPIODevice &operator=(const GPIODevice &) = delete;
58};
59} // namespace gpio
60} // namespace plugin
61} // namespace ola
62#endif // PLUGINS_GPIO_GPIODEVICE_H_
ola::Device
Definition Device.h:89
ola::plugin::gpio::GPIODevice
The GPIO Device.
Definition GPIODevice.h:38
ola::plugin::gpio::GPIODevice::GPIODevice
GPIODevice(class GPIOPlugin *owner, const GPIODriver::Options &options)
Create a new GPIODevice.
Definition GPIODevice.cpp:33
ola::plugin::gpio::GPIODevice::DeviceId
std::string DeviceId() const
The device ID.
Definition GPIODevice.h:48
ola::plugin::gpio::GPIODevice::StartHook
bool StartHook()
Called during Start().
Definition GPIODevice.cpp:39
ola::plugin::gpio::GPIOPlugin
A plugin that drives general purpose digital I/O lines.
Definition GPIOPlugin.h:35
ola::plugin::gpio
The General Purpose digital I/O Plugin.
ola::plugin
Code for supported devices and protocols.
ola
The namespace containing all OLA symbols.
Definition Credentials.cpp:44
ola::plugin::gpio::GPIODriver::Options
The Options.
Definition GPIODriver.h:43