Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
VelComponent.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 
43 #ifndef __VEL_COMPONENT_H__
44 #define __VEL_COMPONENT_H__
45 
46 #include "fsmCommon.h"
47 #include "Element.h"
48 #include "PrefVelocity.h"
49 #include "MengeException.h"
50 
51 // STL
52 #include <vector> // stl vector
53 
54 namespace Menge {
55 
56  // forward declaration
57  template < class Element >
59 
60  namespace BFSM {
61 
62  // FORWARD DECLARATIONS
63  class VelCompContext;
64  class Goal;
65 
69  class MENGE_API VelCompException : public virtual MengeException {
70  public:
75 
81  VelCompException( const std::string & s ): MengeException(s) {}
82 
83  };
84 
90  public:
95 
102  };
103 
112  class MENGE_API VelComponent : public Element {
113  public:
118 
119  protected:
123  virtual ~VelComponent(){}
124 
125  public:
133  virtual void onEnter( Agents::BaseAgent * agent ) {}
134 
142  virtual void onExit( Agents::BaseAgent * agent ) {}
143 
158  virtual void setPrefVelocity( const Agents::BaseAgent * agent, const Goal * goal, Agents::PrefVelocity & pVel ) = 0;
159 
167  virtual VelCompContext * getContext();
168 
169  friend class ElementFactory< VelComponent >;
170 
171  };
172 
182  VelComponent * parseVelComponent( TiXmlElement * node, const std::string & behaveFldr );
183 
184 
185  } // namespace BFSM
186 } // namespace Menge
187 #endif // __VEL_COMPONENT_H__
virtual void onExit(Agents::BaseAgent *agent)
Called when the agent leaves the state which possesses this velocity component.
Definition: VelComponent.h:142
Exception thrown when the velocity component has an error which cannot be recovered from...
Definition: VelComponent.h:89
virtual void onEnter(Agents::BaseAgent *agent)
Called when the agent enters the state which possesses this velocity component.
Definition: VelComponent.h:133
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
VelCompException()
Default constructor.
Definition: VelComponent.h:74
VelCompFatalException()
Default constructor.
Definition: VelComponent.h:94
The base, abstract class defining goals.
Definition: Goal.h:110
The definition of a preferred velocity.
The base class for computing an agent's preferred velocity.
Definition: VelComponent.h:112
The base definition for exceptions in Menge.
Base class for all Menge elements.
The basic interface of extendible Menge Elements.
Definition: Element.h:67
The templated base class for a plugin element.
Definition: VelComponent.h:58
Base exception class for menge operations.
Definition: MengeException.h:58
VelComponent()
Default constructor.
Definition: VelComponent.h:117
VelCompFatalException(const std::string &s)
Constructor with message.
Definition: VelComponent.h:101
Base exception class for preferred velocity computation.
Definition: VelComponent.h:69
Base class for fatal exceptions.
Definition: MengeException.h:99
The namespace contains the Behavior Finite State Machine (BFSM) definition.
Collection of convenient pre-compiler information for fsm definitions.
The definition of a preferred velocity.
Definition: PrefVelocity.h:68
Defines the basic agent properties and functionality that all simulation agents share.
Definition: BaseAgent.h:123
VelCompException(const std::string &s)
Constructor with message.
Definition: VelComponent.h:81
virtual ~VelComponent()
Virtual destructor.
Definition: VelComponent.h:123
Base context for finite state machine velocity components.
Definition: VelCompContext.h:70