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

| Open Lighting Architecture 0.10.9

Loading...
Searching...
No Matches
KiNetPort.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 * KiNetPort.h
17 * The KiNet plugin for ola
18 * Copyright (C) 2013 Simon Newton
19 */
20
21#ifndef PLUGINS_KINET_KINETPORT_H_
22#define PLUGINS_KINET_KINETPORT_H_
23
24#include <string>
25#include "ola/network/IPV4Address.h"
26#include "olad/Port.h"
27#include "plugins/kinet/KiNetDevice.h"
28#include "plugins/kinet/KiNetNode.h"
29
30namespace ola {
31namespace plugin {
32namespace kinet {
33
34 class KiNetOutputPort: public BasicOutputPort {
35 public:
36 KiNetOutputPort(KiNetDevice *device,
37 const ola::network::IPV4Address &target,
38 KiNetNode *node,
39 unsigned int port_id)
40 : BasicOutputPort(device, port_id),
41 m_node(node),
42 m_target(target) {
43 }
44
45 bool WriteDMX(const DmxBuffer &buffer, OLA_UNUSED uint8_t priority) {
46 return m_node->SendDMX(m_target, buffer);
47 }
48
49 std::string Description() const {
50 return "Power Supply: " + m_target.ToString();
51 }
52
53 private:
54 KiNetNode *m_node;
55 const ola::network::IPV4Address m_target;
56};
57} // namespace kinet
58} // namespace plugin
59} // namespace ola
60#endif // PLUGINS_KINET_KINETPORT_H_
IPV4Address.h
Represents an IPv4 Address.
OLA_UNUSED
#define OLA_UNUSED
Mark unused arguments & types.
Definition Macro.h:63
ola::BasicOutputPort::BasicOutputPort
BasicOutputPort(AbstractDevice *parent, unsigned int port_id, bool start_rdm_discovery_on_patch=false, bool supports_rdm=false)
Create a new BasicOutputPort.
Definition Port.cpp:120
ola::DmxBuffer
Used to hold a single universe of DMX data.
Definition DmxBuffer.h:49
ola::network::IPV4Address
Represents a IPv4 Address.
Definition IPV4Address.h:55
ola::plugin::kinet::KiNetDevice
Definition KiNetDevice.h:34
ola::plugin::kinet::KiNetNode
Definition KiNetNode.h:37
ola::plugin::kinet::KiNetOutputPort::WriteDMX
bool WriteDMX(const DmxBuffer &buffer, uint8_t priority)
Write DMX data to this port.
Definition KiNetPort.h:45
ola::plugin::kinet::KiNetOutputPort::Description
std::string Description() const
Fetch the string description for a Port.
Definition KiNetPort.h:49
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