Open Lighting Architecture  Latest Git
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 
28 namespace ola {
29 
30 class Device;
31 
32 namespace plugin {
33 namespace usbdmx {
34 
35 class Widget;
36 
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 
60 };
61 } // namespace usbdmx
62 } // namespace plugin
63 } // namespace ola
64 #endif // PLUGINS_USBDMX_GENERICOUTPUTPORT_H_
#define DISALLOW_COPY_AND_ASSIGN(TypeName)
Creates dummy copy constructor and assignment operator declarations.
Definition: Macro.h:44
Definition: Device.h:95
Used to hold a single universe of DMX data.
Definition: DmxBuffer.h:49
GenericOutputPort(Device *parent, unsigned int id, class WidgetInterface *widget)
Create a new GenericOutputPort.
Definition: GenericOutputPort.cpp:31
std::string Description() const
Fetch the string description for a Port.
Definition: GenericOutputPort.h:54
The interface for a simple widget that supports a single universe of DMX.
Definition: Widget.h:36
Helper macros.
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44
bool WriteDMX(const DmxBuffer &buffer, uint8_t priority)
Write DMX data to this port.
Definition: GenericOutputPort.cpp:38
A thin wrapper around a Widget so that it can operate as a Port.
Definition: GenericOutputPort.h:40
Definition: Port.h:282