Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
PathportPort.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  * PathportPort.h
17  * The Pathport plugin for ola
18  * Copyright (C) 2005 Simon Newton
19  */
20 
21 #ifndef PLUGINS_PATHPORT_PATHPORTPORT_H_
22 #define PLUGINS_PATHPORT_PATHPORTPORT_H_
23 
24 #include <string>
25 #include "ola/DmxBuffer.h"
26 #include "olad/Port.h"
27 #include "plugins/pathport/PathportDevice.h"
28 
29 namespace ola {
30 namespace plugin {
31 namespace pathport {
32 
34  public:
36  std::string Description(const Universe *universe) const;
37  bool PreSetUniverse(Universe *new_universe);
38 };
39 
40 
42  public:
44  unsigned int id,
45  class PluginAdaptor *plugin_adaptor,
46  PathportNode *node):
47  BasicInputPort(parent, id, plugin_adaptor),
48  m_node(node) {}
49  ~PathportInputPort() {}
50 
51  std::string Description() const {
52  return m_helper.Description(GetUniverse());
53  }
54  const DmxBuffer &ReadDMX() const { return m_buffer; }
55  bool PreSetUniverse(OLA_UNUSED Universe *old_universe,
56  Universe *new_universe) {
57  return m_helper.PreSetUniverse(new_universe);
58  }
59 
60  void PostSetUniverse(Universe *old_universe, Universe *new_universe);
61 
62  private:
63  PathportPortHelper m_helper;
64  PathportNode *m_node;
65  DmxBuffer m_buffer;
66 };
67 
68 
70  public:
72  unsigned int id,
73  PathportNode *node):
74  BasicOutputPort(parent, id),
75  m_node(node) {}
76  ~PathportOutputPort() {}
77 
78  std::string Description() const {
79  return m_helper.Description(GetUniverse());
80  }
81  bool WriteDMX(const DmxBuffer &buffer, uint8_t priority);
82  bool PreSetUniverse(OLA_UNUSED Universe *old_universe,
83  Universe *new_universe) {
84  return m_helper.PreSetUniverse(new_universe);
85  }
86 
87  private:
88  PathportPortHelper m_helper;
89  PathportNode *m_node;
90 };
91 } // namespace pathport
92 } // namespace plugin
93 } // namespace ola
94 #endif // PLUGINS_PATHPORT_PATHPORTPORT_H_
Definition: Universe.h:46
Definition: PathportPort.h:33
BasicInputPort(AbstractDevice *parent, unsigned int port_id, const PluginAdaptor *plugin_adaptor, bool supports_rdm=false)
Create a new basic input port.
Definition: Port.cpp:38
Definition: PathportPort.h:69
Definition: Port.h:199
Definition: PathportPort.h:41
Definition: PathportNode.h:37
Used to hold a single universe of DMX data.
Definition: DmxBuffer.h:49
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
A class used to hold a single universe of DMX data.
bool WriteDMX(const DmxBuffer &buffer, uint8_t priority)
Write DMX data to this port.
Definition: PathportPort.cpp:73
#define OLA_UNUSED
Mark unused arguments & types.
Definition: Macro.h:62
std::string Description() const
Fetch the string description for a Port.
Definition: PathportPort.h:51
Definition: PluginAdaptor.h:41
std::string Description() const
Fetch the string description for a Port.
Definition: PathportPort.h:78
Definition: PathportDevice.h:33
Universe * GetUniverse() const
Fetch the universe this Port is bound to.
Definition: Port.h:295
Universe * GetUniverse() const
Fetch the universe this Port is bound to.
Definition: Port.h:212
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44
Definition: Port.h:282