Open Lighting Architecture
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ArtNetPlugin.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  * ArtNetPlugin.h
17  * Interface for the ArtNet plugin class
18  * Copyright (C) 2005-2009 Simon Newton
19  */
20 
21 #ifndef PLUGINS_ARTNET_ARTNETPLUGIN_H_
22 #define PLUGINS_ARTNET_ARTNETPLUGIN_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 artnet {
31 
32 using ola::Plugin;
33 using ola::PluginAdaptor;
34 using std::string;
35 
36 class ArtNetDevice;
37 
38 class ArtNetPlugin : public Plugin {
39  public:
40  explicit ArtNetPlugin(PluginAdaptor *plugin_adaptor):
41  Plugin(plugin_adaptor),
42  m_device(NULL) {}
43 
44  ~ArtNetPlugin() {}
45 
46  string Name() const { return PLUGIN_NAME; }
47  ola_plugin_id Id() const { return OLA_PLUGIN_ARTNET; }
48  string Description() const;
49  string PluginPrefix() const { return PLUGIN_PREFIX; }
50 
51  private:
52  bool StartHook();
53  bool StopHook();
54  bool SetDefaultPreferences();
55 
56  ArtNetDevice *m_device; // only have one device
57 
58  static const char ARTNET_NET[];
59  static const char ARTNET_SUBNET[];
60  static const char ARTNET_LONG_NAME[];
61  static const char ARTNET_SHORT_NAME[];
62  static const char PLUGIN_NAME[];
63  static const char PLUGIN_PREFIX[];
64 };
65 } // namespace artnet
66 } // namespace plugin
67 } // namespace ola
68 #endif // PLUGINS_ARTNET_ARTNETPLUGIN_H_