Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
CondGoal.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_GOAL_H__
45 #define __COND_GOAL_H__
46 
47 #include "CoreConfig.h"
48 #include "Condition.h"
49 #include "ConditionFactory.h"
50 
51 namespace Menge {
52 
53  namespace BFSM {
54 
56 
60  class MENGE_API GoalCondition : public Condition {
61  public:
65  GoalCondition();
66 
72  GoalCondition( const GoalCondition & cond );
73 
82  virtual bool conditionMet( Agents::BaseAgent * agent, const Goal * goal );
83 
92  virtual Condition * copy();
93 
99  void setMinDistance( float dist ) { _distSq = dist * dist; }
100 
101  protected:
105  float _distSq;
106  };
107 
111  class MENGE_API GoalCondFactory : public ConditionFactory {
112  public:
116  GoalCondFactory();
117 
126  virtual const char * name() const { return "goal_reached"; }
127 
135  virtual const char * description() const {
136  return "The goal condition. It becomes active when an agent reaches "\
137  "a user-specified distance to the goal.";
138  }
139  protected:
150  virtual Condition * instance() const { return new GoalCondition(); }
151 
170  virtual bool setFromXML( Condition * condition, TiXmlElement * node, const std::string & behaveFldr ) const;
171 
175  size_t _distanceID;
176  };
177 
178  } // namespace BFSM
179 } // namespace Menge
180 #endif // __COND_GOAL_H__
void setMinDistance(float dist)
Set the minimum distance of approach.
Definition: CondGoal.h:99
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
A spatial transition based on individual goal positions.
Definition: CondGoal.h:60
The factory for creating the GoalCondition.
Definition: CondGoal.h:111
virtual const char * name() const
The name of the condition.
Definition: CondGoal.h:126
virtual const char * description() const
A description of the action.
Definition: CondGoal.h:135
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...
float _distSq
Minimum distance of approach (squared for efficiency).
Definition: CondGoal.h:105
size_t _distanceID
The identifier for the "distance" float attribute.
Definition: CondGoal.h:175
The base, abstract class defining goals.
Definition: Goal.h:110
virtual Condition * instance() const
Create an instance of this class's condition.
Definition: CondGoal.h:150
The namespace contains the Behavior Finite State Machine (BFSM) definition.
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 basis for determining the conditions under which transitions become "active" (and are taken)...