OpenASIP  2.0
OSEdInformer.hh
Go to the documentation of this file.
1 /*
2  Copyright (c) 2002-2009 Tampere University.
3 
4  This file is part of TTA-Based Codesign Environment (TCE).
5 
6  Permission is hereby granted, free of charge, to any person obtaining a
7  copy of this software and associated documentation files (the "Software"),
8  to deal in the Software without restriction, including without limitation
9  the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  and/or sell copies of the Software, and to permit persons to whom the
11  Software is furnished to do so, subject to the following conditions:
12 
13  The above copyright notice and this permission notice shall be included in
14  all copies or substantial portions of the Software.
15 
16  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22  DEALINGS IN THE SOFTWARE.
23  */
24 /**
25  * @file OSEdInformer.hh
26  *
27  * Declaration of OSEdInformer class.
28  *
29  * @author Jussi Nykänen 2004 (nykanen-no.spam-cs.tut.fi)
30  * @note rating: red
31  */
32 
33 #ifndef TTA_OSED_INFORMER_HH
34 #define TTA_OSED_INFORMER_HH
35 
36 #include <wx/wx.h>
37 #include <map>
38 #include <vector>
39 
40 class OSEdListener;
41 
42 /**
43  * Notifies listeners that a certain event has occurred.
44  *
45  * Listeners are OSEdListener objects that are interested on events.
46  */
47 class OSEdInformer {
48 public:
49  /**
50  * All possible events.
51  */
52  enum EventId {
53  EVENT_REGISTER, ///< Event when register value might change.
54  EVENT_RESET, ///< Event when operation is reseted.
55  EVENT_MEMORY ///< Event when memory may be changed.
56  };
57 
58  OSEdInformer();
59  virtual ~OSEdInformer();
60 
61  void handleEvent(EventId event);
62  void registerListener(EventId event, OSEdListener* listener);
63  void unregisterListener(EventId event, OSEdListener* listener);
64 
65 private:
66  /// Container for mapping event ids to Listener objects.
67  typedef std::map<EventId, std::vector<OSEdListener*> > ListenerContainer;
68 
69  /// Copying not allowed.
70  OSEdInformer(const OSEdInformer&);
71  /// Assignment not allowed.
73 
74  /// All listeners.
76 };
77 
78 #endif
OSEdInformer::EventId
EventId
Definition: OSEdInformer.hh:52
OSEdInformer::handleEvent
void handleEvent(EventId event)
Definition: OSEdInformer.cc:58
OSEdInformer::EVENT_REGISTER
@ EVENT_REGISTER
Event when register value might change.
Definition: OSEdInformer.hh:53
OSEdInformer::listeners_
ListenerContainer listeners_
All listeners.
Definition: OSEdInformer.hh:75
OSEdInformer::EVENT_MEMORY
@ EVENT_MEMORY
Event when memory may be changed.
Definition: OSEdInformer.hh:55
OSEdInformer::registerListener
void registerListener(EventId event, OSEdListener *listener)
Definition: OSEdInformer.cc:74
OSEdInformer::operator=
OSEdInformer & operator=(const OSEdInformer &)
Assignment not allowed.
OSEdListener
Definition: OSEdListener.hh:42
OSEdInformer::OSEdInformer
OSEdInformer()
Definition: OSEdInformer.cc:41
OSEdInformer::EVENT_RESET
@ EVENT_RESET
Event when operation is reseted.
Definition: OSEdInformer.hh:54
OSEdInformer::ListenerContainer
std::map< EventId, std::vector< OSEdListener * > > ListenerContainer
Container for mapping event ids to Listener objects.
Definition: OSEdInformer.hh:67
OSEdInformer::unregisterListener
void unregisterListener(EventId event, OSEdListener *listener)
Definition: OSEdInformer.cc:92
OSEdInformer::~OSEdInformer
virtual ~OSEdInformer()
Definition: OSEdInformer.cc:47
OSEdInformer
Definition: OSEdInformer.hh:47