OpenZWave Library  1.6.0
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 
40  class Event: public Wait
41  {
42  friend class SerialControllerImpl;
43  friend class Wait;
44 
45  public:
50  Event();
51 
56  void Set();
57 
62  void Reset();
63 
64  protected:
68  virtual bool IsSignalled();
69 
74  bool Wait( int32 _timeout );
75 
80  ~Event();
81 
82  private:
83  Event( Event const& ); // prevent copy
84  Event& operator = ( Event const& ); // prevent assignment
85 
86  EventImpl* m_pImpl; // Pointer to an object that encapsulates the platform-specific implementation of a event.
87  };
88 
89 } // namespace OpenZWave
90 
91 #endif //_Event_H
92 
OpenZWave::Event::IsSignalled
virtual bool IsSignalled()
Definition: Event.cpp:91
OpenZWave::Event::Wait
friend class Wait
Definition: Event.h:43
int32
signed int int32
Definition: Defs.h:94
OpenZWave::Event::~Event
~Event()
Definition: Event.cpp:57
OpenZWave::Event::SerialControllerImpl
friend class SerialControllerImpl
Definition: Event.h:42
Wait.h
OpenZWave::Wait
Platform-independent definition of Wait objects.
Definition: Wait.h:43
OpenZWave::Event::Event
Event()
Definition: Event.cpp:46
OpenZWave::Event::Reset
void Reset()
Definition: Event.cpp:80
OpenZWave::Event
Platform-independent definition of event objects.
Definition: Event.h:41
OpenZWave::Event::Set
void Set()
Definition: Event.cpp:68
OpenZWave
Definition: Bitfield.h:35