Open Lighting Architecture: plugins/usbdmx/GenericOutputPort.h Source File

| Open Lighting Architecture 0.10.9

Loading...
Searching...
No Matches
GenericOutputPort.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 * GenericOutputPort.h
17 * A Generic output port that uses a widget.
18 * Copyright (C) 2014 Simon Newton
19 */
20
21#ifndef PLUGINS_USBDMX_GENERICOUTPUTPORT_H_
22#define PLUGINS_USBDMX_GENERICOUTPUTPORT_H_
23
24#include <string>
25#include "ola/base/Macro.h"
26#include "olad/Port.h"
27
28namespace ola {
29
30class Device;
31
32namespace plugin {
33namespace usbdmx {
34
35class Widget;
36
40 class GenericOutputPort: public BasicOutputPort {
41 public:
48 GenericOutputPort(Device *parent,
49 unsigned int id,
50 class WidgetInterface *widget);
51
52 bool WriteDMX(const DmxBuffer &buffer, uint8_t priority);
53
54 std::string Description() const { return ""; }
55
56 private:
57 class WidgetInterface* const m_widget;
58
59 GenericOutputPort(const GenericOutputPort &) = delete;
60 const GenericOutputPort &operator=(const GenericOutputPort &) = delete;
61};
62} // namespace usbdmx
63} // namespace plugin
64} // namespace ola
65#endif // PLUGINS_USBDMX_GENERICOUTPUTPORT_H_
Macro.h
Helper macros.
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::Device
Definition Device.h:89
ola::DmxBuffer
Used to hold a single universe of DMX data.
Definition DmxBuffer.h:49
ola::plugin::usbdmx::GenericOutputPort
A thin wrapper around a Widget so that it can operate as a Port.
Definition GenericOutputPort.h:40
ola::plugin::usbdmx::GenericOutputPort::WriteDMX
bool WriteDMX(const DmxBuffer &buffer, uint8_t priority)
Write DMX data to this port.
Definition GenericOutputPort.cpp:38
ola::plugin::usbdmx::GenericOutputPort::Description
std::string Description() const
Fetch the string description for a Port.
Definition GenericOutputPort.h:54
ola::plugin::usbdmx::GenericOutputPort::GenericOutputPort
GenericOutputPort(Device *parent, unsigned int id, class WidgetInterface *widget)
Create a new GenericOutputPort.
Definition GenericOutputPort.cpp:31
ola::plugin::usbdmx::WidgetInterface
The interface for a simple widget that supports a single universe of DMX.
Definition Widget.h:36
ola::plugin::usbdmx
The plugin for hardware using libusb.
ola::plugin
Code for supported devices and protocols.
ola
The namespace containing all OLA symbols.
Definition Credentials.cpp:44