Open Lighting Architecture  Latest Git
OpenDmxDevice.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  * OpenDmxDevice.h
17  * Interface for the Open DMX device
18  * Copyright (C) 2005 Simon Newton
19  */
20 
21 #ifndef PLUGINS_OPENDMX_OPENDMXDEVICE_H_
22 #define PLUGINS_OPENDMX_OPENDMXDEVICE_H_
23 
24 #include <string>
25 #include "olad/Device.h"
26 
27 namespace ola {
28 namespace plugin {
29 namespace opendmx {
30 
31 class OpenDmxDevice: public ola::Device {
32  public:
34  const std::string &name,
35  const std::string &path,
36  unsigned int device_id);
37 
38  // we only support one widget for now
39  std::string DeviceId() const { return m_device_id; }
40 
41  protected:
42  bool StartHook();
43 
44  private:
45  std::string m_path;
46  std::string m_device_id;
47 };
48 } // namespace opendmx
49 } // namespace plugin
50 } // namespace ola
51 #endif // PLUGINS_OPENDMX_OPENDMXDEVICE_H_
std::string DeviceId() const
The device ID.
Definition: OpenDmxDevice.h:39
Definition: Device.h:95
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44
Definition: OpenDmxDevice.h:31
Definition: Plugin.h:38
bool StartHook()
Called during Start().
Definition: OpenDmxDevice.cpp:60