Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SimulatorDBEntry.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 
48 #ifndef __SIMULATOR_DB_ENTRY_H__
49 #define __SIMULATOR_DB_ENTRY_H__
50 
51 #include <string>
52 #include <iostream>
53 #include "CoreConfig.h"
54 
55 namespace Menge {
56 
57  class SimSystem;
58  class BaseAgentContext;
59  namespace Agents {
60  class AgentInitializer;
61  class SimulatorInterface;
62  }
63  namespace SceneGraph {
64  class GLScene;
65  }
66  namespace BFSM {
67  class FSMDescrip;
68  class FSM;
69  }
70 
95  class MENGE_API SimulatorDBEntry {
96  public:
103  virtual ::std::string briefDescription() const = 0;
104 
111  virtual ::std::string longDescription() const = 0;
112 
120  virtual ::std::string viewerName() const = 0;
121 
132  virtual ::std::string commandLineName() const = 0;
133 
142  virtual Agents::SimulatorInterface * getNewSimulator() = 0;
143 
164  SimSystem * getSimulatorSystem( size_t & agentCount,
165  float & simTimeStep,
166  size_t subSteps,
167  float simDuration,
168  const std::string & behaveFile,
169  const std::string & sceneFile,
170  const std::string & outFile,
171  const std::string & scbVersion,
172  bool visualize,
173  bool VERBOSE );
174 
184  void populateScene( SimSystem * system, SceneGraph::GLScene * scene );
185 
195  BaseAgentContext * getAgentContext( SimSystem * system );
196 
205  float simDuration() const;
206 
207  protected:
224  virtual BaseAgentContext * contextFromSystem( SimSystem * simSystem );
225 
236  virtual Agents::AgentInitializer * getAgentInitalizer() const;
237 
248  Agents::SimulatorInterface * initSimulator( const std::string & sceneFileName, bool VERBOSE );
249 
259  BFSM::FSM * initFSM( const std::string & behaveFile, Agents::SimulatorInterface * sim, bool VERBOSE );
260 
269  bool finalize( Agents::SimulatorInterface * sim, BFSM::FSM * fsm );
270 
284  virtual SimSystem * createSimSystem( bool visualize, float duration );
285 
291 
297  };
298 } // namespace Menge
299 
300 #endif // __SIMULATOR_DB_ENTRY_H__
Templated class for performing simulation.
Definition: SimSystem.h:115
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
Sets up the proper compiler directives for platform and dll export/import.
An entry in the simulator database.
Definition: SimulatorDBEntry.h:95
Class which determines the agent properties for each new agent.
Definition: AgentInitializer.h:75
The basic simulator interface required by the fsm.
Definition: SimulatorInterface.h:66
The SceneGraph (SceneGraph) name space, containing all elements to use in a SceneGraph.
Context class for displaying various characteristics of the Agents::BaseAgent class.
Definition: BaseAgentContext.h:73
Templated class for the behavior finite state machine.
Definition: FSM.h:126
The class which contains the entire drawable scene.
Definition: GLScene.h:72
The namespace contains the Behavior Finite State Machine (BFSM) definition.
BFSM::FSM * _fsm
A pointer to the behavior finite state machine. The database entry is not responsible for deleting it...
Definition: SimulatorDBEntry.h:296
The namespace that contains the basic simulation mechanisms.
Agents::SimulatorInterface * _sim
A pointer to the simulator. The database entry is not responsible for deleting it unless there is an ...
Definition: SimulatorDBEntry.h:290