Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
CondTimer.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 __COND_TIMER_H__
45 #define __COND_TIMER_H__
46 
47 #include "CoreConfig.h"
48 #include "Transitions/Condition.h"
50 #include "fsmCommon.h"
51 #include "ReadersWriterLock.h"
52 #include <map> //TODO: Replace this with a hash_map
53 
54 namespace Menge {
55 
56  namespace BFSM {
57 
58  // forward declarations
59  class TimerCondFactory;
61 
71  class MENGE_API TimerCondition : public Condition {
72  public:
77 
83  TimerCondition( const TimerCondition & cond );
84 
93  virtual Condition * copy();
94 
95  protected:
99  ~TimerCondition();
100 
101  public:
111  virtual void onEnter( Agents::BaseAgent * agent );
112 
118  virtual void onLeave( Agents::BaseAgent * agent );
119 
127  virtual bool conditionMet( Agents::BaseAgent * agent, const Goal * goal );
128 
129  friend class TimerCondFactory;
130  protected:
134  std::map< size_t, float > _triggerTimes;
135 
140 
145  };
146 
148 
152  class MENGE_API TimerCondFactory : public ConditionFactory {
153  public:
158 
167  virtual const char * name() const { return "timer"; }
168 
176  virtual const char * description() const {
177  return "The timer condition. It becomes active when the agent has "\
178  "remained in the state at least a user-specified length of time.";
179  }
180 
181  protected:
192  virtual Condition * instance() const { return new TimerCondition(); }
193 
212  virtual bool setFromXML( Condition * condition, TiXmlElement * node, const std::string & behaveFldr ) const;
213 
217  size_t _perAgentID;
218 
222  size_t _durGenID;
223  };
224 
225  } // namespace BFSM
226 } // namespace Menge
227 #endif // __COND_TIMER_H__
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
virtual const char * description() const
A description of the action.
Definition: CondTimer.h:176
Generic abstract class which generates a scalar float value.
Definition: RandGenerator.h:99
The class for parsing the xml description of a Condition and instantiating particular instances...
Definition: ConditionFactory.h:61
Sets up the proper compiler directives for platform and dll export/import.
The factory for parsing xml data for transition conditions and instantiating the appropriate class...
The base, abstract class defining goals.
Definition: Goal.h:110
The definition of a readers-writer lock.
Definition: ReadersWriterLock.h:62
size_t _perAgentID
The identifier for the "per_agent" boolean attribute.
Definition: CondTimer.h:217
virtual Condition * instance() const
Create an instance of this class's condition.
Definition: CondTimer.h:192
FloatGenerator * _durGen
The generator for determining the per-agent duration.
Definition: CondTimer.h:139
The definition of a readers-writer lock.
The namespace contains the Behavior Finite State Machine (BFSM) definition.
Collection of convenient pre-compiler information for fsm definitions.
std::map< size_t, float > _triggerTimes
The trigger time for agents currently effected by this transition.
Definition: CondTimer.h:134
virtual const char * name() const
The name of the action.
Definition: CondTimer.h:167
The base class for transition conditions.
Definition: Condition.h:68
Defines the basic agent properties and functionality that all simulation agents share.
Definition: BaseAgent.h:123
The definition of the timer condition.
Definition: CondTimer.h:71
The factory for creating the TimerCondition.
Definition: CondTimer.h:152
The basis for determining the conditions under which transitions become "active" (and are taken)...
size_t _durGenID
The identifier for the duration float distribution attribute.
Definition: CondTimer.h:222
ReadersWriterLock _lock
Lock to protect _triggerTimes;.
Definition: CondTimer.h:144