Open Lighting Architecture: plugins/kinet/KiNetPlugin.h Source File

| Open Lighting Architecture 0.10.9

Loading...
Searching...
No Matches
KiNetPlugin.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 * KiNetPlugin.h
17 * The KiNET plugin for ola
18 * Copyright (C) 2013 Simon Newton
19 */
20
21#ifndef PLUGINS_KINET_KINETPLUGIN_H_
22#define PLUGINS_KINET_KINETPLUGIN_H_
23
24#include <memory>
25#include <string>
26#include "olad/Plugin.h"
27#include "ola/plugin_id.h"
28
29namespace ola {
30namespace plugin {
31namespace kinet {
32
33 class KiNetPlugin : public Plugin {
34 public:
35 explicit KiNetPlugin(PluginAdaptor *plugin_adaptor);
36 ~KiNetPlugin();
37
38 std::string Name() const { return PLUGIN_NAME; }
39 ola_plugin_id Id() const { return OLA_PLUGIN_KINET; }
40 std::string Description() const;
41 std::string PluginPrefix() const { return PLUGIN_PREFIX; }
42
43 private:
44 std::auto_ptr<class KiNetDevice> m_device; // only have one device
45
46 bool StartHook();
47 bool StopHook();
48 bool SetDefaultPreferences();
49
50 static const char PLUGIN_NAME[];
51 static const char PLUGIN_PREFIX[];
52 static const char POWER_SUPPLY_KEY[];
53};
54} // namespace kinet
55} // namespace plugin
56} // namespace ola
57#endif // PLUGINS_KINET_KINETPLUGIN_H_
ola::PluginAdaptor
Definition PluginAdaptor.h:41
ola::Plugin::SetDefaultPreferences
virtual bool SetDefaultPreferences()
Definition Plugin.h:159
ola::plugin::kinet::KiNetPlugin::PluginPrefix
std::string PluginPrefix() const
The prefix to use for storing configuration files.
Definition KiNetPlugin.h:41
ola::plugin::kinet::KiNetPlugin::Description
std::string Description() const
Definition KiNetPlugin.cpp:101
ola::plugin::kinet::KiNetPlugin::Name
std::string Name() const
Get the plugin name.
Definition KiNetPlugin.h:38
ola::plugin::kinet::KiNetPlugin::Id
ola_plugin_id Id() const
Get the plugin ID of this plugin.
Definition KiNetPlugin.h:39
ola::plugin::kinet
Code for the Kinet protocol.
ola::plugin
Code for supported devices and protocols.
ola
The namespace containing all OLA symbols.
Definition Credentials.cpp:44