Open Lighting Architecture
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
15  *
16  * ShowNetPlugin.h
17  * Interface for the ShowNet plugin class
18  * Copyright (C) 2005-2009 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 using ola::Plugin;
33 using ola::PluginAdaptor;
34 using std::string;
35 
36 class ShowNetDevice;
37 
38 class ShowNetPlugin: public Plugin {
39  public:
40  explicit ShowNetPlugin(PluginAdaptor *plugin_adaptor):
41  Plugin(plugin_adaptor),
42  m_device(NULL) {}
43  ~ShowNetPlugin() {}
44 
45  string Name() const { return PLUGIN_NAME; }
46  ola_plugin_id Id() const { return OLA_PLUGIN_SHOWNET; }
47  string Description() const;
48  string PluginPrefix() const { return PLUGIN_PREFIX; }
49 
50  private:
51  bool StartHook();
52  bool StopHook();
53  bool SetDefaultPreferences();
54 
55  ShowNetDevice *m_device;
56  static const char SHOWNET_NODE_NAME[];
57  static const char PLUGIN_NAME[];
58  static const char PLUGIN_PREFIX[];
59  static const char SHOWNET_NAME_KEY[];
60 };
61 } // namespace shownet
62 } // namespace plugin
63 } // namespace ola
64 #endif // PLUGINS_SHOWNET_SHOWNETPLUGIN_H_