Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
XMLSimulatorBase.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 
50 #ifndef __XML_SIMULATOR_BASE__
51 #define __XML_SIMULATOR_BASE__
52 
53 #include "SimXMLLoader.h"
54 #include "mengeCommon.h"
55 #include <vector>
56 
57 namespace Menge {
58 
59  namespace Agents {
60 
61  class Elevation;
62  class SpatialQuery;
63  class BaseAgent;
64  class SimulatorState;
65 
66  #ifdef _MSC_VER
67 
72  #pragma warning( disable : 4290 )
73  #endif
74 
78  class MENGE_API XMLParamException : public virtual MengeException {
79  public:
84 
90  XMLParamException( const std::string & s ): MengeException(s) {}
91 
92  };
93 
99  public:
104 
111  };
112 
126  class MENGE_API XMLSimulatorBase {
127  public:
132 
136  ~XMLSimulatorBase();
137 
147  virtual bool hasExpTarget() { return true; }
148 
161  virtual bool isExpTarget( const std::string & tagName ) = 0;
162 
178  virtual bool setExpParam( const std::string & paramName, const std::string & value ) throw( XMLParamException ) = 0;
179 
190  virtual BaseAgent * addAgent( const Vector2 & pos, AgentInitializer * agentInit ) = 0;
191 
197  virtual void setElevationInstance( Elevation * elevation ) = 0;
198 
204  virtual bool hasElevation() const = 0;
205 
211  virtual void setSpatialQuery( SpatialQuery * spatialQuery ) = 0;
212 
218  virtual SpatialQuery * getSpatialQuery() = 0;
219 
225  virtual bool hasSpatialQuery() const = 0;
226 
230  virtual bool initSpatialQuery() = 0;
231 
236  virtual void finalize() {};
237 
243  SimulatorState * getInitialState() { return _initState; }
244 
245  protected:
250  };
251  } // namespace Agents
252 } // namespace Menge
253 #endif // __XML_SIMULATOR_BASE__
SimulatorState * _initState
The initial state of the simulator.
Definition: XMLSimulatorBase.h:249
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
Class which determines the agent properties for each new agent.
Definition: AgentInitializer.h:75
XMLParamFatalException(const std::string &s)
Constructor with message.
Definition: XMLSimulatorBase.h:110
Base exception class for menge operations.
Definition: MengeException.h:58
SimulatorState * getInitialState()
Returns a pointer to the simulator's initial state.
Definition: XMLSimulatorBase.h:243
virtual void finalize()
After all agents and all obstacles have been added to the scene does the work to finish preparing the...
Definition: XMLSimulatorBase.h:236
virtual bool hasExpTarget()
Reports if there are any target-specific experiment parameters.
Definition: XMLSimulatorBase.h:147
Exception thrown when the xml parameter parser has an error which cannot be recovered from...
Definition: XMLSimulatorBase.h:98
XMLParamException(const std::string &s)
Constructor with message.
Definition: XMLSimulatorBase.h:90
Exception for invalid parameters from XML specification.
Definition: XMLSimulatorBase.h:78
XMLParamFatalException()
Default constructor.
Definition: XMLSimulatorBase.h:103
Base class for fatal exceptions.
Definition: MengeException.h:99
Contains functionality for parsing simulation specifcation from an XML file.
The base class for determining an agent's elevation.
Definition: Elevation.h:107
The base class for performing spatial queries.
Definition: SpatialQuery.h:114
Defines the basic agent properties and functionality that all simulation agents share.
Definition: BaseAgent.h:123
XMLParamException()
Default constructor.
Definition: XMLSimulatorBase.h:83
The base class for extracting simulator settings from the XML specification.
Definition: XMLSimulatorBase.h:126
The namespace that contains the basic simulation mechanisms.
A class which caches the state of the simulator.
Definition: SimulatorState.h:64