Open Lighting Architecture: plugins/kinet/KiNetDevice.h Source File

| Open Lighting Architecture 0.10.9

Loading...
Searching...
No Matches
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
27#include "ola/network/IPV4Address.h"
28#include "olad/Device.h"
29
30namespace ola {
31namespace plugin {
32namespace kinet {
33
34 class KiNetDevice: public ola::Device {
35 public:
36 KiNetDevice(AbstractPlugin *owner,
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_
IPV4Address.h
Represents an IPv4 Address.
ola::AbstractPlugin
Definition Plugin.h:38
ola::Device
Definition Device.h:89
ola::PluginAdaptor
Definition PluginAdaptor.h:41
ola::plugin::kinet::KiNetDevice::StartHook
bool StartHook()
Called during Start().
Definition KiNetDevice.cpp:62
ola::plugin::kinet::KiNetDevice::PrePortStop
void PrePortStop()
Definition KiNetDevice.cpp:83
ola::plugin::kinet::KiNetDevice::DeviceId
std::string DeviceId() const
The device ID.
Definition KiNetDevice.h:41
ola::plugin::kinet
Code for the Kinet protocol.
ola::plugin
Code for supported devices and protocols.
ola
The namespace containing all OLA symbols.
Definition Credentials.cpp:44