Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
WidgetDetectorInterface.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  * WidgetDetectorInterface.h
17  * The interface for WidgetDetectors.
18  * Copyright (C) 2011 Simon Newton
19  */
20 
21 #ifndef PLUGINS_USBPRO_WIDGETDETECTORINTERFACE_H_
22 #define PLUGINS_USBPRO_WIDGETDETECTORINTERFACE_H_
23 
24 
25 namespace ola {
26 namespace io {
27 class ConnectedDescriptor;
28 }
29 
30 namespace plugin {
31 namespace usbpro {
32 
33 
34 /*
35  * A WidgetDetector takes a ConnectedDescriptor and performs a discovery
36  * routine on it. Individual WidgetDetector specify the behaviour when the
37  * discovery routine passes or fails.
38  */
40  public:
42  virtual ~WidgetDetectorInterface() {}
43 
44  virtual bool Discover(ola::io::ConnectedDescriptor *descriptor) = 0;
45 };
46 } // namespace usbpro
47 } // namespace plugin
48 } // namespace ola
49 #endif // PLUGINS_USBPRO_WIDGETDETECTORINTERFACE_H_
A BidirectionalFileDescriptor that also generates notifications when closed.
Definition: Descriptor.h:282
Definition: WidgetDetectorInterface.h:39
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44