Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
VelCompRoadMap.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 
47 #ifndef __VEL_COMP_ROAD_MAP_H__
48 #define __VEL_COMP_ROAD_MAP_H__
49 
50 #include "CoreConfig.h"
54 #include <map>
55 #include "Graph.h"
56 #include "RoadMapPath.h"
57 #include "ReadersWriterLock.h"
58 
59 namespace Menge {
60 
61  // forward declaration
62  template < class R >
63  class ResourcePtr;
64 
70 
71  namespace BFSM {
72  // forward declaration
73  class RoadMapVCContext;
74 
82  class MENGE_API RoadMapVelComponent : public VelComponent {
83  public:
88 
96  RoadMapVelComponent( const GraphPtr & graph );
97 
102 
108  void setRoadMap( const GraphPtr & graph ) { _roadmap = graph; }
109 
117  virtual void onExit( Agents::BaseAgent * agent );
118 
133  virtual void setPrefVelocity( const Agents::BaseAgent * agent, const Goal * goal, Agents::PrefVelocity & pVel );
134 
142  virtual VelCompContext * getContext();
143 
144  friend class RoadMapVCContext;
145 
146  protected:
150  GraphPtr _roadmap;
151 
155  PathMap _paths;
156 
161  };
162 
164 
168  class MENGE_API RoadMapVCContext : public VelCompContext {
169  public:
177 
187  virtual std::string getUIText( const std::string & indent="" ) const;
188 
197  virtual void draw3DGL( const Agents::BaseAgent * agt, const Goal * goal );
198 
199  protected:
204  };
205 
207 
211  class MENGE_API RoadMapVCFactory : public VelCompFactory {
212  public:
217 
226  virtual const char * name() const { return "road_map"; }
227 
235  virtual const char * description() const {
236  return "Provides a preferred velocity which is derived from a path along a "\
237  "graph discretization of the free space (a.k.a. a road map).";
238  };
239 
240  protected:
251  VelComponent * instance() const { return new RoadMapVelComponent(); }
252 
271  virtual bool setFromXML( VelComponent * vc, TiXmlElement * node, const std::string & behaveFldr ) const;
272 
276  size_t _fileNameID;
277  };
278  } // namespace BFSM
279 } // namespace Menge
280 #endif // __VEL_COMP_ROAD_MAP_H__
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
ReadersWriterLock _lock
Lock to protect _paths;.
Definition: VelCompRoadMap.h:160
ResourcePtr< Graph > GraphPtr
forward declaration of graph resource pointer. see graph.h for more details
Definition: VelCompRoadMap.h:63
Sets up the proper compiler directives for platform and dll export/import.
A class for parsing the xml description of a velocity component and instantiating particular instance...
Definition: VelComponentFactory.h:60
VelComponent * instance() const
Create an instance of this class's velocity component.
Definition: VelCompRoadMap.h:251
The base, abstract class defining goals.
Definition: Goal.h:110
A velocity component that returns a preferred velocity whose direction and preferred speed are comput...
Definition: VelCompRoadMap.h:82
The definition of a readers-writer lock.
Definition: ReadersWriterLock.h:62
The base class for computing an agent's preferred velocity.
Definition: VelComponent.h:112
Factory for the RoadMapVelComponent.
Definition: VelCompRoadMap.h:211
void setRoadMap(const GraphPtr &graph)
Sets the road map for this velocity component.
Definition: VelCompRoadMap.h:108
size_t _fileNameID
The identifier for the "file_name" string attribute.
Definition: VelCompRoadMap.h:276
RoadMapVelComponent * _vc
The underlying finite state machine velocity component.
Definition: VelCompRoadMap.h:203
virtual const char * name() const
The name of the velocity component.
Definition: VelCompRoadMap.h:226
The definition of a readers-writer lock.
Base Class providing a pointer interface to Resources.
Definition: VelCompRoadMap.h:63
The namespace contains the Behavior Finite State Machine (BFSM) definition.
The context for the RoadMapVelComponent.
Definition: VelCompRoadMap.h:168
The definition of a graph for performing graph searches and path planning.
The definition of how preferred velocity is computed in a state.
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
PathMap _paths
The paths for all agents in this state.
Definition: VelCompRoadMap.h:155
The factory for parsing xml data and instantiating velocity components.
GraphPtr _roadmap
The roadmap.
Definition: VelCompRoadMap.h:150
virtual const char * description() const
A description of the velocity component.
Definition: VelCompRoadMap.h:235
A path along a roadmap.
The definition of a basic UI context for finite state machine velocity components.
Base context for finite state machine velocity components.
Definition: VelCompContext.h:70