Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PedVODBEntry.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 __PEDVO_DB_ENTRY_H__
45 #define __PEDVO_DB_ENTRY_H__
46 
47 #include "SimulatorDBEntry.h"
48 #include "PedVO.h"
49 
50 namespace PedVO {
55  public:
62  virtual ::std::string briefDescription() const;
63 
70  virtual ::std::string longDescription() const;
71 
77  virtual ::std::string viewerName() const;
78 
89  virtual ::std::string commandLineName() const { return "pedvo"; }
90 
100 
108 
109  protected:
127  };
128 } // namespace PedVO
129 
130 #endif // __PEDVO_DB_ENTRY_H__
virtual ::std::string longDescription() const
Gives a long description of the simulator.
Definition: PedVODBEntry.cpp:59
Templated class for performing simulation.
Definition: SimSystem.h:115
virtual Menge::BaseAgentContext * contextFromSystem(Menge::SimSystem *simSystem)
Returns a pointer to an agent context appropriate to the corresponding simulator. ...
Definition: PedVODBEntry.cpp:80
An entry in the simulator database.
Definition: SimulatorDBEntry.h:95
The simulator database entry for the PedVO simulator.
Definition: PedVODBEntry.h:54
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
virtual ::std::string viewerName() const
Gives a label to apply to the interactive viewer.
Definition: PedVODBEntry.cpp:68
virtual Menge::Agents::SimulatorInterface * getNewSimulator()
Returns a pointer to this model's Simulator instance.
Definition: PedVODBEntry.cpp:74
The basic simulator interface required by the fsm.
Definition: SimulatorInterface.h:66
The definition of the PedVO pedestrian plug-in.
virtual Menge::Agents::AgentInitializer * getAgentInitalizer() const
Provides an AgentInitializer appropriate to this simulator class.
Definition: PedVODBEntry.cpp:86
Context class for displaying various characteristics of the Agents::BaseAgent class.
Definition: BaseAgentContext.h:73
Definition of an entry into the simulator database.
virtual ::std::string commandLineName() const
Gives a unique name to be used as a command-line parameter.
Definition: PedVODBEntry.h:89
virtual ::std::string briefDescription() const
Gives a brief description of the simulator.
Definition: PedVODBEntry.cpp:54