Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
SandNetPlugin.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  * SandNetPlugin.h
17  * Interface for the sandnet plugin class
18  * Copyright (C) 2005 Simon Newton
19  */
20 
21 #ifndef PLUGINS_SANDNET_SANDNETPLUGIN_H_
22 #define PLUGINS_SANDNET_SANDNETPLUGIN_H_
23 
24 #include <string>
25 #include "ola/plugin_id.h"
26 #include "olad/Plugin.h"
27 #include "olad/PluginAdaptor.h"
28 
29 namespace ola {
30 namespace plugin {
31 namespace sandnet {
32 
33 class SandNetPlugin: public ola::Plugin {
34  public:
35  explicit SandNetPlugin(ola::PluginAdaptor *plugin_adaptor)
36  : Plugin(plugin_adaptor),
37  m_device(NULL) {}
38 
39  std::string Name() const { return PLUGIN_NAME; }
40  std::string Description() const;
41  ola_plugin_id Id() const { return OLA_PLUGIN_SANDNET; }
42  std::string PluginPrefix() const { return PLUGIN_PREFIX; }
43 
44  private:
45  class SandNetDevice *m_device; // only have one device
46 
47  bool StartHook();
48  bool StopHook();
49  bool SetDefaultPreferences();
50 
51  static const char SANDNET_NODE_NAME[];
52  static const char PLUGIN_NAME[];
53  static const char PLUGIN_PREFIX[];
54 };
55 } // namespace sandnet
56 } // namespace plugin
57 } // namespace ola
58 #endif // PLUGINS_SANDNET_SANDNETPLUGIN_H_
Provides a wrapper for the DeviceManager and SelectServer objects so that the plugins can register de...
std::string PluginPrefix() const
The prefix to use for storing configuration files.
Definition: SandNetPlugin.h:42
Definition: SandNetDevice.h:35
Definition: Plugin.h:118
ola_plugin_id Id() const
Get the plugin ID of this plugin.
Definition: SandNetPlugin.h:41
Definition: PluginAdaptor.h:41
std::string Name() const
Get the plugin name.
Definition: SandNetPlugin.h:39
std::string Description() const
Definition: SandNetPlugin.cpp:78
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44
Definition: SandNetPlugin.h:33