SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MSRoute.h
Go to the documentation of this file.
1 /****************************************************************************/
10 // A vehicle route
11 /****************************************************************************/
12 // SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
13 // Copyright (C) 2001-2012 DLR (http://www.dlr.de/) and contributors
14 /****************************************************************************/
15 //
16 // This file is part of SUMO.
17 // SUMO is free software: you can redistribute it and/or modify
18 // it under the terms of the GNU General Public License as published by
19 // the Free Software Foundation, either version 3 of the License, or
20 // (at your option) any later version.
21 //
22 /****************************************************************************/
23 #ifndef MSRoute_h
24 #define MSRoute_h
25 
26 
27 // ===========================================================================
28 // included modules
29 // ===========================================================================
30 #ifdef _MSC_VER
31 #include <windows_config.h>
32 #else
33 #include <config.h>
34 #endif
35 
36 #include <string>
37 #include <map>
38 #include <vector>
39 #include <algorithm>
40 #include <utils/common/Named.h>
42 #include <utils/common/RGBColor.h>
44 
45 
46 // ===========================================================================
47 // class declarations
48 // ===========================================================================
49 class MSEdge;
50 class BinaryInputDevice;
52 
53 
54 typedef std::vector<const MSEdge*> MSEdgeVector;
55 typedef MSEdgeVector::const_iterator MSRouteIterator;
56 
57 
58 // ===========================================================================
59 // class definitions
60 // ===========================================================================
64 class MSRoute : public Named {
65 public:
67  MSRoute(const std::string& id, const MSEdgeVector& edges,
68  unsigned int references, const RGBColor& c,
69  const std::vector<SUMOVehicleParameter::Stop> &stops) ;
70 
72  virtual ~MSRoute() ;
73 
75  MSRouteIterator begin() const;
76 
78  MSRouteIterator end() const;
79 
81  unsigned size() const;
82 
84  const MSEdge* getLastEdge() const;
85 
87  void addReference() const;
88 
90  void release() const;
91 
93  void writeEdgeIDs(OutputDevice& os, const MSEdge* const from, const MSEdge* const upTo = 0) const;
94 
95  bool contains(const MSEdge* const edge) const {
96  return std::find(myEdges.begin(), myEdges.end(), edge) != myEdges.end();
97  }
98 
99  bool containsAnyOf(const std::vector<MSEdge*> &edgelist) const;
100 
101  const MSEdge* operator[](unsigned index) const;
102 
103 #ifdef HAVE_MESOSIM
104 
105 
106 
111  static void dict_saveState(std::ostream& os) ;
112 
113 
118  static void dict_loadState(BinaryInputDevice& bis) ;
120 #endif
121 
122  const MSEdgeVector& getEdges() const {
123  return myEdges;
124  }
125 
126  SUMOReal getLength() const;
127 
136  SUMOReal getDistanceBetween(SUMOReal fromPos, SUMOReal toPos, const MSEdge* fromEdge, const MSEdge* toEdge) const;
137 
139  const RGBColor& getColor() const;
140 
142  const std::vector<SUMOVehicleParameter::Stop> &getStops() const;
143 
144 public:
154  static bool dictionary(const std::string& id, const MSRoute* route);
155 
165  static bool dictionary(const std::string& id, RandomDistributor<const MSRoute*> *routeDist);
166 
175  static const MSRoute* dictionary(const std::string& id);
176 
184  static RandomDistributor<const MSRoute*> *distDictionary(const std::string& id);
185 
187  static void clear();
188 
189  static void insertIDs(std::vector<std::string> &into);
190 
191 
192 private:
195 
197  mutable unsigned int myReferenceCounter;
198 
201 
203  std::vector<SUMOVehicleParameter::Stop> myStops;
204 
205 private:
207  typedef std::map<std::string, const MSRoute*> RouteDict;
208 
211 
213  typedef std::map<std::string, RandomDistributor<const MSRoute*>*> RouteDistDict;
214 
217 
218 };
219 
220 
221 #endif
222 
223 /****************************************************************************/
224