Open Lighting Architecture: plugins/dummy/DummyPlugin.h Source File

| Open Lighting Architecture 0.10.9

Loading...
Searching...
No Matches
DummyPlugin.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 * DummyPlugin.h
17 * Interface for the dummyplugin class
18 * Copyright (C) 2005 Simon Newton
19 */
20
21#ifndef PLUGINS_DUMMY_DUMMYPLUGIN_H_
22#define PLUGINS_DUMMY_DUMMYPLUGIN_H_
23
24#include <stdint.h>
25#include <string>
26#include "olad/Plugin.h"
27#include "ola/plugin_id.h"
28
29namespace ola {
30namespace plugin {
31namespace dummy {
32
33class DummyDevice;
34
35 class DummyPlugin: public Plugin {
36 public:
37 explicit DummyPlugin(PluginAdaptor *plugin_adaptor):
38 Plugin(plugin_adaptor),
39 m_device(NULL) {}
40
41 std::string Name() const { return PLUGIN_NAME; }
42 std::string Description() const;
43 ola_plugin_id Id() const { return OLA_PLUGIN_DUMMY; }
44 std::string PluginPrefix() const { return PLUGIN_PREFIX; }
45
46 private:
47 bool StartHook();
48 bool StopHook();
49 bool SetDefaultPreferences();
50
51 DummyDevice *m_device; // the dummy device
52 static const char ACK_TIMER_COUNT_KEY[];
53 static const char ADVANCED_DIMMER_KEY[];
54 static const uint8_t DEFAULT_DEVICE_COUNT;
55 static const uint8_t DEFAULT_ACK_TIMER_DEVICE_COUNT;
56 static const uint16_t DEFAULT_SUBDEVICE_COUNT;
57 static const char DEVICE_NAME[];
58 static const char DIMMER_COUNT_KEY[];
59 static const char DIMMER_SUBDEVICE_COUNT_KEY[];
60 static const char DUMMY_DEVICE_COUNT_KEY[];
61 static const char MOVING_LIGHT_COUNT_KEY[];
62 static const char NETWORK_COUNT_KEY[];
63 static const char PLUGIN_NAME[];
64 static const char PLUGIN_PREFIX[];
65 static const char SENSOR_COUNT_KEY[];
66 static const char SUBDEVICE_COUNT_KEY[];
67};
68} // namespace dummy
69} // namespace plugin
70} // namespace ola
71#endif // PLUGINS_DUMMY_DUMMYPLUGIN_H_
ola::PluginAdaptor
Definition PluginAdaptor.h:41
ola::Plugin::SetDefaultPreferences
virtual bool SetDefaultPreferences()
Definition Plugin.h:159
ola::plugin::dummy::DummyDevice
Definition DummyDevice.h:35
ola::plugin::dummy::DummyPlugin::PluginPrefix
std::string PluginPrefix() const
The prefix to use for storing configuration files.
Definition DummyPlugin.h:44
ola::plugin::dummy::DummyPlugin::Id
ola_plugin_id Id() const
Get the plugin ID of this plugin.
Definition DummyPlugin.h:43
ola::plugin::dummy::DummyPlugin::Name
std::string Name() const
Get the plugin name.
Definition DummyPlugin.h:41
ola::plugin::dummy::DummyPlugin::Description
std::string Description() const
Definition DummyPlugin.cpp:128
ola::plugin::dummy
The Dummy plugin.
ola::plugin
Code for supported devices and protocols.
ola
The namespace containing all OLA symbols.
Definition Credentials.cpp:44