Open Lighting Architecture: plugins/pathport/PathportPlugin.h Source File

| Open Lighting Architecture 0.10.9

Loading...
Searching...
No Matches
PathportPlugin.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 * PathportPlugin.h
17 * Interface for the pathport plugin class
18 * Copyright (C) 2005 Simon Newton
19 */
20
21#ifndef PLUGINS_PATHPORT_PATHPORTPLUGIN_H_
22#define PLUGINS_PATHPORT_PATHPORTPLUGIN_H_
23
24#include <stdint.h>
25#include <string>
26#include "olad/Plugin.h"
27#include "ola/plugin_id.h"
28
29namespace ola {
30namespace plugin {
31namespace pathport {
32
33 class PathportPlugin: public ola::Plugin {
34 public:
35 explicit PathportPlugin(class 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_PATHPORT; }
42 std::string PluginPrefix() const { return PLUGIN_PREFIX; }
43
44 private:
45 bool StartHook();
46 bool StopHook();
47 bool SetDefaultPreferences();
48
49 class PathportDevice *m_device;
50
51 static const unsigned int DEFAULT_DSCP_VALUE;
52 static const char PLUGIN_NAME[];
53 static const char PLUGIN_PREFIX[];
54 // 0x28 is assigned to the OLA project
55 static const uint8_t OLA_MANUFACTURER_CODE = 0x28;
56};
57} // namespace pathport
58} // namespace plugin
59} // namespace ola
60#endif // PLUGINS_PATHPORT_PATHPORTPLUGIN_H_
ola::PluginAdaptor
Definition PluginAdaptor.h:41
ola::Plugin
Definition Plugin.h:118
ola::Plugin::SetDefaultPreferences
virtual bool SetDefaultPreferences()
Definition Plugin.h:159
ola::plugin::pathport::PathportDevice
Definition PathportDevice.h:33
ola::plugin::pathport::PathportPlugin::Name
std::string Name() const
Get the plugin name.
Definition PathportPlugin.h:39
ola::plugin::pathport::PathportPlugin::Description
std::string Description() const
Definition PathportPlugin.cpp:83
ola::plugin::pathport::PathportPlugin::Id
ola_plugin_id Id() const
Get the plugin ID of this plugin.
Definition PathportPlugin.h:41
ola::plugin::pathport::PathportPlugin::PluginPrefix
std::string PluginPrefix() const
The prefix to use for storing configuration files.
Definition PathportPlugin.h:42
ola::plugin::pathport
Code for the Pathport protocol.
ola::plugin
Code for supported devices and protocols.
ola
The namespace containing all OLA symbols.
Definition Credentials.cpp:44