Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
KiNetDevice.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  * KiNetDevice.h
17  * Interface for the KiNet device
18  * Copyright (C) 2013 Simon Newton
19  */
20 
21 #ifndef PLUGINS_KINET_KINETDEVICE_H_
22 #define PLUGINS_KINET_KINETDEVICE_H_
23 
24 #include <string>
25 #include <vector>
26 
28 #include "olad/Device.h"
29 
30 namespace ola {
31 namespace plugin {
32 namespace kinet {
33 
34 class KiNetDevice: public ola::Device {
35  public:
37  const std::vector<ola::network::IPV4Address> &power_supplies,
38  class PluginAdaptor *plugin_adaptor);
39 
40  // Only one KiNet device
41  std::string DeviceId() const { return "1"; }
42 
43  // We can stream the same universe to multiple IPs
44  // TODO(Peter): Remove this when we have a device per IP
45  bool AllowMultiPortPatching() const { return true; }
46 
47  protected:
48  bool StartHook();
49  void PrePortStop();
50  void PostPortStop();
51 
52  private:
53  const std::vector<ola::network::IPV4Address> m_power_supplies;
54  class KiNetNode *m_node;
55  class PluginAdaptor *m_plugin_adaptor;
56 };
57 } // namespace kinet
58 } // namespace plugin
59 } // namespace ola
60 #endif // PLUGINS_KINET_KINETDEVICE_H_
bool StartHook()
Called during Start().
Definition: KiNetDevice.cpp:62
void PrePortStop()
Definition: KiNetDevice.cpp:83
Definition: KiNetDevice.h:34
std::string DeviceId() const
The device ID.
Definition: KiNetDevice.h:41
bool AllowMultiPortPatching() const
Allow multiple ports of the same type to be patched to the same universe.
Definition: KiNetDevice.h:45
Definition: Device.h:95
Definition: PluginAdaptor.h:41
Represents an IPv4 Address.
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44
Definition: KiNetNode.h:39
Definition: Plugin.h:38