Open Lighting Architecture  0.10.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
ShowNetPlugin.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  * ShowNetPlugin.h
17  * Interface for the ShowNet plugin class
18  * Copyright (C) 2005 Simon Newton
19  */
20 
21 #ifndef PLUGINS_SHOWNET_SHOWNETPLUGIN_H_
22 #define PLUGINS_SHOWNET_SHOWNETPLUGIN_H_
23 
24 #include <string>
25 #include "olad/Plugin.h"
26 #include "ola/plugin_id.h"
27 
28 namespace ola {
29 namespace plugin {
30 namespace shownet {
31 
32 class ShowNetDevice;
33 
34 class ShowNetPlugin: public Plugin {
35  public:
36  explicit ShowNetPlugin(PluginAdaptor *plugin_adaptor):
37  Plugin(plugin_adaptor),
38  m_device(NULL) {}
39  ~ShowNetPlugin() {}
40 
41  std::string Name() const { return PLUGIN_NAME; }
42  ola_plugin_id Id() const { return OLA_PLUGIN_SHOWNET; }
43  std::string Description() const;
44  std::string PluginPrefix() const { return PLUGIN_PREFIX; }
45 
46  private:
47  bool StartHook();
48  bool StopHook();
49  bool SetDefaultPreferences();
50 
51  ShowNetDevice *m_device;
52  static const char SHOWNET_NODE_NAME[];
53  static const char PLUGIN_NAME[];
54  static const char PLUGIN_PREFIX[];
55  static const char SHOWNET_NAME_KEY[];
56 };
57 } // namespace shownet
58 } // namespace plugin
59 } // namespace ola
60 #endif // PLUGINS_SHOWNET_SHOWNETPLUGIN_H_
Definition: ShowNetPlugin.h:34
std::string Name() const
Get the plugin name.
Definition: ShowNetPlugin.h:41
Definition: Plugin.h:118
Definition: PluginAdaptor.h:41
ola_plugin_id Id() const
Get the plugin ID of this plugin.
Definition: ShowNetPlugin.h:42
Definition: ShowNetDevice.h:33
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44
std::string Description() const
Definition: ShowNetPlugin.cpp:74
std::string PluginPrefix() const
The prefix to use for storing configuration files.
Definition: ShowNetPlugin.h:44