Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
ShowNetDevice.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  * ShowNetDevice.h
17  * Interface for the ShowNet device
18  * Copyright (C) 2005 Simon Newton
19  */
20 
21 #ifndef PLUGINS_SHOWNET_SHOWNETDEVICE_H_
22 #define PLUGINS_SHOWNET_SHOWNETDEVICE_H_
23 
24 #include <string>
25 #include "olad/Device.h"
26 #include "olad/Plugin.h"
27 
28 namespace ola {
29 namespace plugin {
30 namespace shownet {
31 
32 
33 class ShowNetDevice: public ola::Device {
34  public:
35  ShowNetDevice(Plugin *owner,
36  class Preferences *preferences,
37  class PluginAdaptor *plugin_adaptor);
38  ~ShowNetDevice() {}
39 
40  bool AllowMultiPortPatching() const { return true; }
41  std::string DeviceId() const { return "1"; }
42 
43  static const char IP_KEY[];
44 
45  protected:
46  bool StartHook();
47  void PrePortStop();
48  void PostPortStop();
49 
50  private:
51  class Preferences *m_preferences;
52  class PluginAdaptor *m_plugin_adaptor;
53  class ShowNetNode *m_node;
54 
55  static const char SHOWNET_DEVICE_NAME[];
56 };
57 } // namespace shownet
58 } // namespace plugin
59 } // namespace ola
60 #endif // PLUGINS_SHOWNET_SHOWNETDEVICE_H_
Definition: ShowNetNode.h:38
Definition: Device.h:95
Definition: Plugin.h:118
Definition: PluginAdaptor.h:41
bool StartHook()
Called during Start().
Definition: ShowNetDevice.cpp:58
std::string DeviceId() const
The device ID.
Definition: ShowNetDevice.h:41
Definition: ShowNetDevice.h:33
Definition: Preferences.h:147
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44
bool AllowMultiPortPatching() const
Allow multiple ports of the same type to be patched to the same universe.
Definition: ShowNetDevice.h:40