OpenZWave Library  1.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Event.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // Event.h
4 //
5 // Cross-platform manual-reset event
6 //
7 // Copyright (c) 2010 Mal Lansell <mal@lansell.org>
8 // All rights reserved.
9 //
10 // SOFTWARE NOTICE AND LICENSE
11 //
12 // This file is part of OpenZWave.
13 //
14 // OpenZWave is free software: you can redistribute it and/or modify
15 // it under the terms of the GNU Lesser General Public License as published
16 // by the Free Software Foundation, either version 3 of the License,
17 // or (at your option) any later version.
18 //
19 // OpenZWave is distributed in the hope that it will be useful,
20 // but WITHOUT ANY WARRANTY; without even the implied warranty of
21 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 // GNU Lesser General Public License for more details.
23 //
24 // You should have received a copy of the GNU Lesser General Public License
25 // along with OpenZWave. If not, see <http://www.gnu.org/licenses/>.
26 //
27 //-----------------------------------------------------------------------------
28 #ifndef _Event_H
29 #define _Event_H
30 
31 #include "platform/Wait.h"
32 
33 namespace OpenZWave
34 {
35  class EventImpl;
36 
39  class Event: public Wait
40  {
41  friend class SerialControllerImpl;
42  friend class Wait;
43 
44  public:
49  Event();
50 
55  void Set();
56 
61  void Reset();
62 
63  protected:
67  virtual bool IsSignalled();
68 
73  bool Wait( int32 _timeout );
74 
79  ~Event();
80 
81  private:
82  Event( Event const& ); // prevent copy
83  Event& operator = ( Event const& ); // prevent assignment
84 
85  EventImpl* m_pImpl; // Pointer to an object that encapsulates the platform-specific implementation of a event.
86  };
87 
88 } // namespace OpenZWave
89 
90 #endif //_Event_H
91 
Definition: Bitfield.h:34
Platform-independent definition of event objects.
Definition: Event.h:39
virtual bool IsSignalled()
Definition: Event.cpp:89
void Set()
Definition: Event.cpp:66
void Reset()
Definition: Event.cpp:78
~Event()
Definition: Event.cpp:55
Event()
Definition: Event.cpp:44
Windows-specific implementation of the Event class.
Definition: EventImpl.h:38
Definition: SerialControllerImpl.h:38
signed int int32
Definition: Defs.h:68
Platform-independent definition of Wait objects.
Definition: Wait.h:41
Wait()
Definition: Wait.cpp:49