SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SUMORouteHandler.h
Go to the documentation of this file.
1 /****************************************************************************/
9 // Parser for routes during their loading
10 /****************************************************************************/
11 // SUMO, Simulation of Urban MObility; see http://sumo-sim.org/
12 // Copyright (C) 2001-2013 DLR (http://www.dlr.de/) and contributors
13 /****************************************************************************/
14 //
15 // This file is part of SUMO.
16 // SUMO is free software: you can redistribute it and/or modify
17 // it under the terms of the GNU General Public License as published by
18 // the Free Software Foundation, either version 3 of the License, or
19 // (at your option) any later version.
20 //
21 /****************************************************************************/
22 #ifndef SUMORouteHandler_h
23 #define SUMORouteHandler_h
24 
25 
26 // ===========================================================================
27 // included modules
28 // ===========================================================================
29 #ifdef _MSC_VER
30 #include <windows_config.h>
31 #else
32 #include <config.h>
33 #endif
34 
36 #include <utils/common/SUMOTime.h>
39 
40 
41 // ===========================================================================
42 // class declarations
43 // ===========================================================================
44 class SUMOVTypeParameter;
45 
46 
47 // ===========================================================================
48 // class definitions
49 // ===========================================================================
58 public:
60  SUMORouteHandler(const std::string& file);
61 
63  virtual ~SUMORouteHandler();
64 
66  SUMOTime getLastDepart() const;
67 
69  bool checkStopPos(SUMOReal& startPos, SUMOReal& endPos, const SUMOReal laneLength,
70  const SUMOReal minLength, const bool friendlyPos);
71 
72 protected:
74 
75 
83  virtual void myStartElement(int element,
84  const SUMOSAXAttributes& attrs);
85 
86 
93  virtual void myEndElement(int element);
95 
96 
98  virtual void openVehicleTypeDistribution(const SUMOSAXAttributes& attrs) = 0;
99 
101  virtual void closeVehicleTypeDistribution() = 0;
102 
104  virtual void openRoute(const SUMOSAXAttributes& attrs) = 0;
105 
111  virtual void closeRoute(const bool mayBeDisconnected = false) = 0;
112 
114  virtual void openRouteDistribution(const SUMOSAXAttributes& attrs) = 0;
115 
117  virtual void closeRouteDistribution() = 0;
118 
120  virtual void closeVehicle() = 0;
121 
123  virtual void closePerson() = 0;
124 
126  virtual void closeFlow() = 0;
127 
129  virtual void addStop(const SUMOSAXAttributes& attrs) = 0;
130 
132  bool checkLastDepart();
133 
135  void registerLastDepart();
136 
138  void addParam(const SUMOSAXAttributes& attrs);
139 
140 protected:
143 
146 
148  std::string myActiveRouteID;
149 
151  std::string myActiveRouteRefID;
152 
155 
158 
160  std::vector<SUMOVehicleParameter::Stop> myActiveRouteStops;
161 
164 
167 
170 
173 
174 private:
177 
180 
181 };
182 
183 
184 #endif
185 
186 /****************************************************************************/
virtual void openVehicleTypeDistribution(const SUMOSAXAttributes &attrs)=0
virtual void myEndElement(int element)
Called when a closing tag occurs.
SUMOVehicleParameter * myVehicleParameter
Parameter of the current vehicle, trip, person, or flow.
SUMOTime myEndDefault
The default value for flow ends.
Structure representing possible vehicle parameter.
virtual void addStop(const SUMOSAXAttributes &attrs)=0
Processing of a stop.
bool checkStopPos(SUMOReal &startPos, SUMOReal &endPos, const SUMOReal laneLength, const SUMOReal minLength, const bool friendlyPos)
check start and end position of a stop
SUMOVTypeParameter * myCurrentVType
The currently parsed vehicle type.
SUMOReal myActiveRouteProbability
The id of the current route.
SUMORouteHandler & operator=(const SUMORouteHandler &s)
Invalidated assignment operator.
virtual void openRouteDistribution(const SUMOSAXAttributes &attrs)=0
void registerLastDepart()
save last depart (only to be used if vehicle is not discarded)
std::string myActiveRouteID
The id of the current route.
SAX-handler base for SUMO-files.
IDSupplier myIdSupplier
generates numerical ids
SUMOTime myBeginDefault
The default value for flow begins.
virtual void closeVehicle()=0
Ends the processing of a vehicle.
Encapsulated SAX-Attributes.
void addParam(const SUMOSAXAttributes &attrs)
assign arbitrary vehicle parameters
virtual ~SUMORouteHandler()
standard destructor
SUMORouteHandler(const std::string &file)
standard constructor
virtual void closeRoute(const bool mayBeDisconnected=false)=0
Parser for routes during their loading.
std::vector< SUMOVehicleParameter::Stop > myActiveRouteStops
List of the stops on the parsed route.
Structure representing possible vehicle parameter.
virtual void myStartElement(int element, const SUMOSAXAttributes &attrs)
Called on the opening of a tag;.
virtual void closeVehicleTypeDistribution()=0
SUMOTime myLastDepart
The insertion time of the vehicle read last.
virtual void closeRouteDistribution()=0
virtual void closeFlow()=0
Ends the processing of a flow.
const RGBColor * myActiveRouteColor
The currently parsed route&#39;s color.
virtual void closePerson()=0
Ends the processing of a person.
#define SUMOReal
Definition: config.h:221
SUMOTime getLastDepart() const
Returns the last loaded depart time.
bool checkLastDepart()
Checks whether the route file is sorted by departure time if needed.
std::string myActiveRouteRefID
The id of the route the current route references to.
virtual void openRoute(const SUMOSAXAttributes &attrs)=0