Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
StateEvtTrigger.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 __STATE_EVT_TRIGGER_H__
45 #define __STATE_EVT_TRIGGER_H__
46 
47 #include "Events/EventTrigger.h"
49 
50 namespace Menge {
51 
52  // forward declaration
53  class StateEvtTriggerFactory;
54 
55  namespace BFSM {
56  class State;
57  }
58 
60 
64  class MENGE_API StateEvtTrigger : public EventTrigger {
65  public:
70 
75  virtual void finalize();
76 
77  friend class StateEvtTriggerFactory;
78 
79  protected:
83  std::string _stateName;
84 
89  };
90 
92 
96  class MENGE_API StateEvtTriggerFactory : public EventTriggerFactory {
97  public:
102 
103  protected:
122  virtual bool setFromXML( EventTrigger * trigger, TiXmlElement * node, const std::string & specFldr ) const;
123 
127  size_t _stateID;
128 
129  };
130 
132 
136  class MENGE_API StatePopIncreaseTrigger : public StateEvtTrigger {
137  public:
142 
149  virtual void finalize();
150 
151  protected:
152 
160  virtual bool testCondition();
161 
165  size_t _lastPop;
166  };
167 
169 
174  public:
183  virtual const char * name() const { return "state_pop_increase"; }
184 
192  virtual const char * description() const {
193  return "Event trigger which fires when a state's population increases.";
194  };
195 
196  protected:
207  EventTrigger * instance() const { return new StatePopIncreaseTrigger(); }
208  };
209 
210 } // namespace Menge
211 #endif // __STATE_EVT_TRIGGER_H__
The basic state of the behavior finite state machine.
Definition: State.h:123
A trigger that fires off when a state's population increases.
Definition: StateEvtTrigger.h:136
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
The base class event triggers which depend on state properties.
Definition: StateEvtTrigger.h:64
The factory for state event triggers.
Definition: StateEvtTrigger.h:96
virtual const char * description() const
A description of the event trigger.
Definition: StateEvtTrigger.h:192
std::string _stateName
The name of the state.
Definition: StateEvtTrigger.h:83
The definition of the basic event trigger mechanism.
virtual const char * name() const
The name of the trigger type.
Definition: StateEvtTrigger.h:183
EventTrigger * instance() const
Create an instance of this class's event trigger implementation.
Definition: StateEvtTrigger.h:207
size_t _lastPop
The population last time the state was examined.
Definition: StateEvtTrigger.h:165
The definition of the basic event trigger factory.
The base class for generating event triggers.
Definition: EventTriggerFactory.h:56
The factory for StatePopIncreaseTrigger event triggers.
Definition: StateEvtTrigger.h:173
The namespace contains the Behavior Finite State Machine (BFSM) definition.
The base class for event triggers.
Definition: EventTrigger.h:57
BFSM::State * _state
The state to operate on.
Definition: StateEvtTrigger.h:88
size_t _stateID
The identifier for the "state" string attribute.
Definition: StateEvtTrigger.h:127