SUMO - Simulation of Urban MObility
ODMatrix.h
Go to the documentation of this file.
1 /****************************************************************************/
9 // An O/D (origin/destination) matrix
10 /****************************************************************************/
11 // SUMO, Simulation of Urban MObility; see http://sumo.dlr.de/
12 // Copyright (C) 2006-2016 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 ODMatrix_h
23 #define ODMatrix_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 
35 #include <iostream>
36 #include <sstream>
37 #include <fstream>
38 #include <vector>
39 #include <cstdlib>
40 #include <ctime>
41 #include <algorithm>
42 #include <set>
43 #include <string>
44 #include <utils/common/SUMOTime.h>
45 #include "ODCell.h"
46 #include "ODDistrictCont.h"
49 #include <utils/common/SUMOTime.h>
50 
51 // ===========================================================================
52 // class declarations
53 // ===========================================================================
54 class OutputDevice;
55 class SUMOSAXHandler;
56 
57 
58 // ===========================================================================
59 // class definitions
60 // ===========================================================================
76 class ODMatrix {
77 public:
82  ODMatrix(const ODDistrictCont& dc);
83 
84 
86  ~ODMatrix();
87 
88 
111  bool add(SUMOReal vehicleNumber, SUMOTime begin,
112  SUMOTime end, const std::string& origin, const std::string& destination,
113  const std::string& vehicleType);
114 
126  bool add(const std::string& id, const SUMOTime depart,
127  const std::pair<const std::string, const std::string>& od,
128  const std::string& vehicleType);
129 
137  void writeDefaultAttrs(OutputDevice& dev, const bool noVtype,
138  const ODCell* const cell);
139 
165  void write(SUMOTime begin, const SUMOTime end,
166  OutputDevice& dev, const bool uniform,
167  const bool differSourceSink, const bool noVtype,
168  const std::string& prefix, const bool stepLog);
169 
170 
179  void writeFlows(const SUMOTime begin, const SUMOTime end,
180  OutputDevice& dev, const bool noVtype,
181  const std::string& prefix);
182 
183 
190  SUMOReal getNumLoaded() const;
191 
192 
199  SUMOReal getNumWritten() const;
200 
201 
208  SUMOReal getNumDiscarded() const;
209 
210 
214  void applyCurve(const Distribution_Points& ps);
215 
216 
220  void readO(LineReader& lr, SUMOReal scale,
221  std::string vehType, bool matrixHasVehType);
222 
226  void readV(LineReader& lr, SUMOReal scale,
227  std::string vehType, bool matrixHasVehType);
228 
232  void loadMatrix(OptionsCont& oc);
233 
237  void loadRoutes(OptionsCont& oc, SUMOSAXHandler& handler);
238 
242  Distribution_Points parseTimeLine(const std::vector<std::string>& def, bool timelineDayInHours);
243 
244  const std::vector<ODCell*>& getCells() {
245  return myContainer;
246  }
247 
248  void sortByBeginTime();
249 
250 protected:
255  struct ODVehicle {
257  std::string id;
263  std::string from;
265  std::string to;
266 
267  };
268 
269 
296  int& vehName, std::vector<ODVehicle>& into,
297  const bool uniform, const bool differSourceSink,
298  const std::string& prefix);
299 
300 
316  void applyCurve(const Distribution_Points& ps, ODCell* cell,
317  std::vector<ODCell*>& newCells);
318 
319 
320 private:
324  std::string getNextNonCommentLine(LineReader& lr);
325 
329  SUMOTime parseSingleTime(const std::string& time);
330 
334  std::pair<SUMOTime, SUMOTime> readTime(LineReader& lr);
335 
340 
341 
342 private:
344  std::vector<ODCell*> myContainer;
345 
347  std::map<const std::pair<const std::string, const std::string>, std::vector<ODCell*> > myShortCut;
348 
351 
353  std::set<std::string> myMissingDistricts;
354 
357 
360 
363 
364 
370  public:
373 
374 
385  int operator()(ODCell* p1, ODCell* p2) const {
386  if (p1->begin == p2->begin) {
387  if (p1->origin == p2->origin) {
388  return p1->destination < p2->destination;
389  }
390  return p1->origin < p2->origin;
391  }
392  return p1->begin < p2->begin;
393  }
394 
395  };
396 
397 
406  public:
409 
410 
419  bool operator()(const ODVehicle& p1, const ODVehicle& p2) const {
420  if (p1.depart == p2.depart) {
421  return p1.id > p2.id;
422  }
423  return p1.depart > p2.depart;
424  }
425 
426  };
427 
428 private:
430  ODMatrix(const ODMatrix& s);
431 
433  ODMatrix& operator=(const ODMatrix& s);
434 
435 };
436 
437 
438 #endif
439 
440 /****************************************************************************/
441 
SUMOReal myNumWritten
Number of written vehicles.
Definition: ODMatrix.h:359
void writeDefaultAttrs(OutputDevice &dev, const bool noVtype, const ODCell *const cell)
Helper function for flow and trip output writing the depart and arrival attributes.
Definition: ODMatrix.cpp:192
Used for sorting the cells by the begin time they describe.
Definition: ODMatrix.h:369
const std::vector< ODCell * > & getCells()
Definition: ODMatrix.h:244
long long int SUMOTime
Definition: SUMOTime.h:43
SUMOReal getNumLoaded() const
Returns the number of loaded vehicles.
Definition: ODMatrix.cpp:486
Retrieves a file linewise and reports the lines to a handler.
Definition: LineReader.h:58
const ODDistrictCont & myDistricts
The districts to retrieve sources/sinks from.
Definition: ODMatrix.h:350
An internal representation of a single vehicle.
Definition: ODMatrix.h:255
SAX-handler base for SUMO-files.
std::string from
The edge the vehicles shall start at.
Definition: ODMatrix.h:263
SUMOTime parseSingleTime(const std::string &time)
Definition: ODMatrix.cpp:327
ODMatrix & operator=(const ODMatrix &s)
invalid assignment operator
void loadMatrix(OptionsCont &oc)
read a matrix in one of several formats
Definition: ODMatrix.cpp:532
~ODMatrix()
Destructor.
Definition: ODMatrix.cpp:66
SUMOReal myNumDiscarded
Number of discarded vehicles.
Definition: ODMatrix.h:362
A single O/D-matrix cell.
Definition: ODCell.h:58
void readV(LineReader &lr, SUMOReal scale, std::string vehType, bool matrixHasVehType)
read a VISUM-matrix with the V Format
Definition: ODMatrix.cpp:368
std::string origin
Name of the origin district.
Definition: ODCell.h:69
cell_by_begin_comparator()
constructor
Definition: ODMatrix.h:372
An O/D (origin/destination) matrix.
Definition: ODMatrix.h:76
SUMOReal getNumWritten() const
Returns the number of written vehicles.
Definition: ODMatrix.cpp:492
void readO(LineReader &lr, SUMOReal scale, std::string vehType, bool matrixHasVehType)
read a VISUM-matrix with the O Format
Definition: ODMatrix.cpp:436
ODCell * cell
The cell of the ODMatrix which generated the vehicle.
Definition: ODMatrix.h:261
void loadRoutes(OptionsCont &oc, SUMOSAXHandler &handler)
read SUMO routes
Definition: ODMatrix.cpp:578
A container for districts.
Used for sorting vehicles by their departure (latest first)
Definition: ODMatrix.h:405
std::map< const std::pair< const std::string, const std::string >, std::vector< ODCell * > > myShortCut
The loaded cells indexed by origin and destination.
Definition: ODMatrix.h:347
SUMOReal computeDeparts(ODCell *cell, int &vehName, std::vector< ODVehicle > &into, const bool uniform, const bool differSourceSink, const std::string &prefix)
Computes the vehicle departs stored in the given cell and saves them in "into".
Definition: ODMatrix.cpp:153
void sortByBeginTime()
Definition: ODMatrix.cpp:625
std::vector< ODCell * > myContainer
The loaded cells.
Definition: ODMatrix.h:344
SUMOTime begin
The begin time this cell describes.
Definition: ODCell.h:63
void writeFlows(const SUMOTime begin, const SUMOTime end, OutputDevice &dev, const bool noVtype, const std::string &prefix)
Writes the flows stored in the matrix.
Definition: ODMatrix.cpp:291
SUMOReal readFactor(LineReader &lr, SUMOReal scale)
Definition: ODMatrix.cpp:356
std::pair< SUMOTime, SUMOTime > readTime(LineReader &lr)
Definition: ODMatrix.cpp:338
std::string getNextNonCommentLine(LineReader &lr)
Definition: ODMatrix.cpp:314
SUMOTime depart
The departure time of the vehicle.
Definition: ODMatrix.h:259
SUMOReal myNumLoaded
Number of loaded vehicles.
Definition: ODMatrix.h:356
int operator()(ODCell *p1, ODCell *p2) const
Comparing operator.
Definition: ODMatrix.h:385
A storage for options typed value containers)
Definition: OptionsCont.h:99
void applyCurve(const Distribution_Points &ps)
Splits the stored cells dividing them on the given time line.
Definition: ODMatrix.cpp:519
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:71
std::string destination
Name of the destination district.
Definition: ODCell.h:72
#define SUMOReal
Definition: config.h:213
void write(SUMOTime begin, const SUMOTime end, OutputDevice &dev, const bool uniform, const bool differSourceSink, const bool noVtype, const std::string &prefix, const bool stepLog)
Writes the vehicles stored in the matrix assigning the sources and sinks.
Definition: ODMatrix.cpp:221
std::string to
The edge the vehicles shall end at.
Definition: ODMatrix.h:265
ODMatrix(const ODDistrictCont &dc)
Constructor.
Definition: ODMatrix.cpp:62
std::set< std::string > myMissingDistricts
The missing districts already warned about.
Definition: ODMatrix.h:353
std::string id
The id of the vehicle.
Definition: ODMatrix.h:257
bool operator()(const ODVehicle &p1, const ODVehicle &p2) const
Comparing operator.
Definition: ODMatrix.h:419
SUMOReal getNumDiscarded() const
Returns the number of discarded vehicles.
Definition: ODMatrix.cpp:498
Distribution_Points parseTimeLine(const std::vector< std::string > &def, bool timelineDayInHours)
split the given timeline
Definition: ODMatrix.cpp:595
bool add(SUMOReal vehicleNumber, SUMOTime begin, SUMOTime end, const std::string &origin, const std::string &destination, const std::string &vehicleType)
Builds a single cell from the given values, verifying them.
Definition: ODMatrix.cpp:75