Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PedVOInitializer.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 __PEDVO_INITIALIZER_H__
44 #define __PEDVO_INITIALIZER_H__
45 
46 #include "AgentInitializer.h"
47 
48 namespace PedVO {
53  public:
60 
67  AgentInitializer( const AgentInitializer & init );
68 
72  virtual ~AgentInitializer();
73 
87  virtual bool setProperties( Menge::Agents::BaseAgent * agent );
88 
96  virtual void setDefaults();
97 
105  virtual Menge::Agents::AgentInitializer * copy() const { return new AgentInitializer( *this ); }
106 
107  protected:
108 
124  virtual bool isRelevant( const ::std::string & tagName );
125 
140  virtual Menge::Agents::AgentInitializer::ParseResult setFromXMLAttribute( const ::std::string & paramName, const ::std::string & value );
141 
158  virtual Menge::Agents::AgentInitializer::ParseResult processProperty( ::std::string propName, TiXmlElement * node );
159 
164 
169 
174 
179 
184 
189  };
190 } // namespace PedVO
191 
192 
193 #endif // __PEDVO_INITIALIZER_H__
virtual bool setProperties(Menge::Agents::BaseAgent *agent)
Sets the properties of the given agent based on the initializer's values.
Definition: PedVOInitializer.cpp:92
virtual bool isRelevant(const ::std::string &tagName)
Reports if this AgentInitializer cares about the given AgentSet property XML tag. ...
Definition: PedVOInitializer.cpp:108
virtual Menge::Agents::AgentInitializer * copy() const
Creates a copy of this AgentInitializer instance.
Definition: PedVOInitializer.h:105
Generic abstract class which generates a scalar float value.
Definition: RandGenerator.h:99
virtual Menge::Agents::AgentInitializer::ParseResult processProperty(::std::string propName, TiXmlElement *node)
Process the given tag.
Definition: PedVOInitializer.cpp:141
FloatGenerator * _timeHorizonObst
The time horizon for predicting obstacle collisions.
Definition: PedVOInitializer.h:183
bool _denseAware
Controls if the agent respondes to density (true) or not (false).
Definition: PedVOInitializer.h:163
FloatGenerator * _strideBuffer
The stride factor of the agent.
Definition: PedVOInitializer.h:173
AgentInitializer()
Constructor.
Definition: PedVOInitializer.cpp:60
Contains the specification of the pedestrian model based on Pedestrian Velocity Obstacles.
Definition: PedVOAgent.cpp:46
Class which determines the agent properties for each new agent.
Definition: AgentInitializer.h:75
FloatGenerator * _strideFactor
The stride factor of the agent.
Definition: PedVOInitializer.h:168
ParseResult
Return type for parsing efforts. Helps the various derived classes coordinate their work...
Definition: AgentInitializer.h:81
FloatGenerator * _timeHorizon
The time horizon for predicting agent collisions.
Definition: PedVOInitializer.h:178
Class which determines the agent properties for each new PedVO agent.
Definition: PedVOInitializer.h:52
Defines the basic agent properties and functionality that all simulation agents share.
Definition: BaseAgent.h:123
The infrastructure for initializing agent properties from the scene specification file...
FloatGenerator * _turningBias
The turning bias.
Definition: PedVOInitializer.h:188
virtual void setDefaults()
Sets all generators to default values.
Definition: PedVOInitializer.cpp:166
virtual ~AgentInitializer()
Destructor.
Definition: PedVOInitializer.cpp:82
virtual Menge::Agents::AgentInitializer::ParseResult setFromXMLAttribute(const ::std::string &paramName, const ::std::string &value)
Defines a constant value for an agent property as specified by the attribute of an agent property tag...
Definition: PedVOInitializer.cpp:114