Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
KaratePort.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  * KaratePort.h
17  * The karate plugin for ola
18  * Copyright (C) 2005 Simon Newton
19  */
20 
21 #ifndef PLUGINS_KARATE_KARATEPORT_H_
22 #define PLUGINS_KARATE_KARATEPORT_H_
23 
24 #include <string>
25 #include "ola/DmxBuffer.h"
26 #include "olad/Port.h"
27 #include "plugins/karate/KarateDevice.h"
28 #include "plugins/karate/KarateThread.h"
29 
30 namespace ola {
31 namespace plugin {
32 namespace karate {
33 
35  public:
37  unsigned int id,
38  const std::string &path)
39  : BasicOutputPort(parent, id),
40  m_thread(path),
41  m_path(path) {
42  m_thread.Start();
43  }
44 
45  ~KarateOutputPort() {
46  m_thread.Stop();
47  }
48 
49  std::string Description() const { return "KarateLight at " + m_path; }
50 
51  bool WriteDMX(const ola::DmxBuffer &buffer, OLA_UNUSED uint8_t priority) {
52  return m_thread.WriteDmx(buffer);
53  }
54 
55  private:
56  KarateThread m_thread;
57  std::string m_path;
58 };
59 } // namespace karate
60 } // namespace plugin
61 } // namespace ola
62 #endif // PLUGINS_KARATE_KARATEPORT_H_
std::string Description() const
Fetch the string description for a Port.
Definition: KaratePort.h:49
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
Definition: KarateThread.h:32
bool WriteDMX(const ola::DmxBuffer &buffer, uint8_t priority)
Write DMX data to this port.
Definition: KaratePort.h:51
A class used to hold a single universe of DMX data.
#define OLA_UNUSED
Mark unused arguments & types.
Definition: Macro.h:62
bool Stop()
Stop the thread.
Definition: KarateThread.cpp:111
virtual bool Start()
Start the thread and wait for the thread to be running.
Definition: Thread.cpp:90
Definition: KaratePort.h:34
Definition: KarateDevice.h:31
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44
Definition: Port.h:282
bool WriteDmx(const DmxBuffer &buffer)
Store the data in the shared buffer.
Definition: KarateThread.cpp:124