Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
EventSystem.h
Go to the documentation of this file.
1 /*
2 
3 License
4 
5 Menge
6 Copyright and trademark 2012-14 University of North Carolina at Chapel Hill.
7 All rights reserved.
8 
9 Permission to use, copy, modify, and distribute this software and its documentation
10 for educational, research, and non-profit purposes, without fee, and without a
11 written agreement is hereby granted, provided that the above copyright notice,
12 this paragraph, and the following four paragraphs appear in all copies.
13 
14 This software program and documentation are copyrighted by the University of North
15 Carolina at Chapel Hill. The software program and documentation are supplied "as is,"
16 without any accompanying services from the University of North Carolina at Chapel
17 Hill or the authors. The University of North Carolina at Chapel Hill and the
18 authors do not warrant that the operation of the program will be uninterrupted
19 or error-free. The end-user understands that the program was developed for research
20 purposes and is advised not to rely exclusively on the program for any reason.
21 
22 IN NO EVENT SHALL THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE AUTHORS
23 BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
24 DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS
25 DOCUMENTATION, EVEN IF THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE
26 AUTHORS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 
28 THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS SPECIFICALLY
29 DISCLAIM ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
30 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AND ANY STATUTORY WARRANTY
31 OF NON-INFRINGEMENT. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND
32 THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS HAVE NO OBLIGATIONS
33 TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
34 
35 Any questions or comments should be sent to the authors {menge,geom}@cs.unc.edu
36 
37 */
38 
44 #ifndef __EVENT_SYSTEM_H__
45 #define __EVENT_SYSTEM_H__
46 
47 #include <vector>
48 #include "mengeCommon.h"
49 
50 // forward declaration
51 class TiXmlElement;
52 
53 namespace Menge {
54  // forward declaration
55 
56  class Event;
57  class EventResponse;
58  class EventEffect;
59  class EventTarget;
60  Event * parseEvent( TiXmlElement * node, const std::string & specFldr );
61 
66  class EventSystem {
67  public:
71  EventSystem();
72 
76  ~EventSystem();
77 
86  void addEvent( Event * evt ) { _events.push_back( evt ); }
87 
91  void evaluateEvents();
92 
96  void finalize();
97 
106  bool parseEvents( TiXmlElement * node, const std::string & behaveFldr );
107 
118  static void finalizeException( const std::string msg );
119 
127  static bool CONSERVATIVE_SETUP;
128 
129  friend class Event;
130  friend class EventEffect;
131  friend class EventTarget;
132  friend class EventResponse;
133  friend Event * parseEvent( TiXmlElement * node, const std::string & specFldr );
134 
135  protected:
139  std::vector< Event * > _events;
140 
144  HASH_MAP< std::string, EventTarget * > _targets;
145 
149  HASH_MAP< std::string, EventEffect * > _effects;
150  };
151 }
152 
153 #endif // __EVENT_SYSTEM_H__
static void finalizeException(const std::string msg)
Causes an event exception to be thrown based on the the system's tolerance for event configuration er...
Definition: EventSystem.cpp:131
~EventSystem()
Destructor.
Definition: EventSystem.cpp:60
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
HASH_MAP< std::string, EventTarget * > _targets
A mapping from target names to targets.
Definition: EventSystem.h:144
A response to an event trigger. It combines an effect with a target.
Definition: EventResponse.h:59
void finalize()
Finalize the event system.
Definition: EventSystem.cpp:85
friend Event * parseEvent(TiXmlElement *node, const std::string &specFldr)
Parses the xml specification of an event and returns a parsed event.
Definition: Event.cpp:134
The definition of a Menge event.
Definition: Event.h:87
The base class for all event targets.
Definition: EventTarget.h:66
HASH_MAP< std::string, EventEffect * > _effects
A mapping from effect names to effects.
Definition: EventSystem.h:149
The definition of a response to an event.
Definition: EventEffect.h:65
Event * parseEvent(TiXmlElement *node, const std::string &specFldr)
Parses the xml specification of an event and returns a parsed event.
Definition: Event.cpp:134
The main event engine – causes event triggers to be evaluated and effects to be applied.
Definition: EventSystem.h:66
static bool CONSERVATIVE_SETUP
Global variable to indicate how event configuration errors should be handled.
Definition: EventSystem.h:127
void evaluateEvents()
Evaluates the registered events.
Definition: EventSystem.cpp:77
std::vector< Event * > _events
The events to process.
Definition: EventSystem.h:139
bool parseEvents(TiXmlElement *node, const std::string &behaveFldr)
Parses events from an "Events" tag.
Definition: EventSystem.cpp:143
void addEvent(Event *evt)
Adds an event to the system.
Definition: EventSystem.h:86
EventSystem()
Constructor.
Definition: EventSystem.cpp:55