Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
GenericDevice.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  * GenericDevice.h
17  * A Generic device that creates a single port.
18  * Copyright (C) 2014 Simon Newton
19  */
20 
21 #ifndef PLUGINS_USBDMX_GENERICDEVICE_H_
22 #define PLUGINS_USBDMX_GENERICDEVICE_H_
23 
24 #include <memory>
25 #include <string>
26 #include "ola/base/Macro.h"
27 #include "olad/Device.h"
28 
29 namespace ola {
30 namespace plugin {
31 namespace usbdmx {
32 
38 class GenericDevice: public Device {
39  public:
48  class WidgetInterface *widget,
49  const std::string &device_name,
50  const std::string &device_id);
51 
52  std::string DeviceId() const {
53  return m_device_id;
54  }
55 
56  protected:
57  bool StartHook();
58 
59  private:
60  const std::string m_device_id;
61  std::auto_ptr<class GenericOutputPort> m_port;
62 
63  DISALLOW_COPY_AND_ASSIGN(GenericDevice);
64 };
65 } // namespace usbdmx
66 } // namespace plugin
67 } // namespace ola
68 #endif // PLUGINS_USBDMX_GENERICDEVICE_H_
A Generic device.
Definition: GenericDevice.h:38
bool StartHook()
Called during Start().
Definition: GenericDevice.cpp:40
Definition: Device.h:95
GenericDevice(ola::AbstractPlugin *owner, class WidgetInterface *widget, const std::string &device_name, const std::string &device_id)
Create a new GenericDevice.
Definition: GenericDevice.cpp:31
std::string DeviceId() const
The device ID.
Definition: GenericDevice.h:52
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
Definition: Plugin.h:38