Open Lighting Architecture: plugins/artnet/ArtNetPlugin.h Source File

| Open Lighting Architecture 0.10.9

Loading...
Searching...
No Matches
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
15 *
16 * ArtNetPlugin.h
17 * Interface for the ArtNet plugin class
18 * Copyright (C) 2005 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
28namespace ola {
29namespace plugin {
30namespace artnet {
31
32class ArtNetDevice;
33
34 class ArtNetPlugin : public Plugin {
35 public:
36 explicit ArtNetPlugin(PluginAdaptor *plugin_adaptor):
37 Plugin(plugin_adaptor),
38 m_device(NULL) {}
39
40 ~ArtNetPlugin() {}
41
42 std::string Name() const { return PLUGIN_NAME; }
43 ola_plugin_id Id() const { return OLA_PLUGIN_ARTNET; }
44 std::string Description() const;
45 std::string PluginPrefix() const { return PLUGIN_PREFIX; }
46
47 private:
53 bool StartHook();
54 bool StopHook();
55 bool SetDefaultPreferences();
56
57 ArtNetDevice *m_device; // only have one device
58
59 static const char ARTNET_NET[];
60 static const char ARTNET_SUBNET[];
61 static const char ARTNET_LONG_NAME[];
62 static const char ARTNET_SHORT_NAME[];
63 static const char PLUGIN_NAME[];
64 static const char PLUGIN_PREFIX[];
65};
66} // namespace artnet
67} // namespace plugin
68} // namespace ola
69#endif // PLUGINS_ARTNET_ARTNETPLUGIN_H_
ola::PluginAdaptor
Definition PluginAdaptor.h:41
ola::Plugin::SetDefaultPreferences
virtual bool SetDefaultPreferences()
Definition Plugin.h:159
ola::plugin::artnet::ArtNetDevice
Definition ArtNetDevice.h:47
ola::plugin::artnet::ArtNetPlugin::PluginPrefix
std::string PluginPrefix() const
The prefix to use for storing configuration files.
Definition ArtNetPlugin.h:45
ola::plugin::artnet::ArtNetPlugin::Id
ola_plugin_id Id() const
Get the plugin ID of this plugin.
Definition ArtNetPlugin.h:43
ola::plugin::artnet::ArtNetPlugin::Name
std::string Name() const
Get the plugin name.
Definition ArtNetPlugin.h:42
ola::plugin::artnet::ArtNetPlugin::Description
std::string Description() const
Definition ArtNetPlugin.cpp:73
ola::plugin::artnet
The ArtNet plugin.
ola::plugin
Code for supported devices and protocols.
ola
The namespace containing all OLA symbols.
Definition Credentials.cpp:44