Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Condition.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 __CONDITION_H__
45 #define __CONDITION_H__
46 
47 #include "CoreConfig.h"
48 #include "fsmCommon.h"
49 #include "Element.h"
50 
51 namespace Menge {
52 
53  // forward declarations
54  namespace Agents {
55  class BaseAgent;
56  }
57 
58  namespace BFSM {
59  // forward declaration
60  class Goal;
61 
68  class MENGE_API Condition : public Element {
69  public:
73  Condition() : Element() {}
74 
80  Condition( const Condition & cond ){}
81 
82  protected:
86  virtual ~Condition() {}
87 
88  public:
98  virtual void onEnter( Agents::BaseAgent * agent ){}
99 
105  virtual void onLeave( Agents::BaseAgent * agent ){}
106 
119  virtual bool conditionMet( Agents::BaseAgent * agent, const Goal * goal ) = 0;
120 
129  virtual Condition * copy() = 0;
130  };
131 
132  } // namespace BFSM
133 } // namespace Menge
134 #endif // __CONDITION_H__
virtual void onLeave(Agents::BaseAgent *agent)
Called when an agent exits the state with this transition.
Definition: Condition.h:105
Condition(const Condition &cond)
Copy Constructor.
Definition: Condition.h:80
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
virtual ~Condition()
Protected destructor.
Definition: Condition.h:86
virtual void onEnter(Agents::BaseAgent *agent)
Called when an agent enters a state with this exiting transition.
Definition: Condition.h:98
Sets up the proper compiler directives for platform and dll export/import.
The base, abstract class defining goals.
Definition: Goal.h:110
Base class for all Menge elements.
The basic interface of extendible Menge Elements.
Definition: Element.h:67
Condition()
Constructor.
Definition: Condition.h:73
The namespace contains the Behavior Finite State Machine (BFSM) definition.
Collection of convenient pre-compiler information for fsm definitions.
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 namespace that contains the basic simulation mechanisms.