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 <string>
43 #include <utils/common/SUMOTime.h>
44 #include "ODCell.h"
45 #include "ODDistrictCont.h"
48 #include <utils/common/SUMOTime.h>
49 
50 // ===========================================================================
51 // class declarations
52 // ===========================================================================
53 class OutputDevice;
54 class SUMOSAXHandler;
55 
56 
57 // ===========================================================================
58 // class definitions
59 // ===========================================================================
75 class ODMatrix {
76 public:
81  ODMatrix(const ODDistrictCont& dc);
82 
83 
85  ~ODMatrix();
86 
87 
109  void add(SUMOReal vehicleNumber, SUMOTime begin,
110  SUMOTime end, const std::string& origin, const std::string& destination,
111  const std::string& vehicleType);
112 
123  void add(const std::string& id, const SUMOTime depart,
124  const std::pair<const std::string, const std::string>& od,
125  const std::string& vehicleType);
126 
134  void writeDefaultAttrs(OutputDevice& dev, const bool noVtype,
135  const ODCell* const cell);
136 
162  void write(SUMOTime begin, const SUMOTime end,
163  OutputDevice& dev, const bool uniform,
164  const bool differSourceSink, const bool noVtype,
165  const std::string& prefix, const bool stepLog);
166 
167 
176  void writeFlows(const SUMOTime begin, const SUMOTime end,
177  OutputDevice& dev, const bool noVtype,
178  const std::string& prefix);
179 
180 
187  SUMOReal getNoLoaded() const;
188 
189 
196  SUMOReal getNoWritten() const;
197 
198 
205  SUMOReal getNoDiscarded() const;
206 
207 
211  void applyCurve(const Distribution_Points& ps);
212 
213 
217  void readO(LineReader& lr, SUMOReal scale,
218  std::string vehType, bool matrixHasVehType);
219 
223  void readV(LineReader& lr, SUMOReal scale,
224  std::string vehType, bool matrixHasVehType);
225 
229  void loadMatrix(OptionsCont& oc);
230 
234  void loadRoutes(OptionsCont& oc, SUMOSAXHandler& handler);
235 
239  Distribution_Points parseTimeLine(const std::vector<std::string>& def, bool timelineDayInHours);
240 
241  const std::vector<ODCell*>& getCells() {
242  return myContainer;
243  }
244 
245  void sortByBeginTime();
246 
247 protected:
252  struct ODVehicle {
254  std::string id;
260  std::string from;
262  std::string to;
263 
264  };
265 
266 
293  size_t& vehName, std::vector<ODVehicle>& into,
294  const bool uniform, const bool differSourceSink,
295  const std::string& prefix);
296 
297 
313  void applyCurve(const Distribution_Points& ps, ODCell* cell,
314  std::vector<ODCell*>& newCells);
315 
316 
317 private:
321  std::string getNextNonCommentLine(LineReader& lr);
322 
326  SUMOTime parseSingleTime(const std::string& time);
327 
331  std::pair<SUMOTime, SUMOTime> readTime(LineReader& lr);
332 
337 
338 
339 protected:
341  std::vector<ODCell*> myContainer;
342 
344  std::map<const std::pair<const std::string, const std::string>, std::vector<ODCell*> > myShortCut;
345 
348 
351 
354 
357 
358 
364  public:
367 
368 
379  int operator()(ODCell* p1, ODCell* p2) const {
380  if (p1->begin == p2->begin) {
381  if (p1->origin == p2->origin) {
382  return p1->destination < p2->destination;
383  }
384  return p1->origin < p2->origin;
385  }
386  return p1->begin < p2->begin;
387  }
388 
389  };
390 
391 
400  public:
403 
404 
413  bool operator()(const ODVehicle& p1, const ODVehicle& p2) const {
414  if (p1.depart == p2.depart) {
415  return p1.id > p2.id;
416  }
417  return p1.depart > p2.depart;
418  }
419 
420  };
421 
422 private:
424  ODMatrix(const ODMatrix& s);
425 
427  ODMatrix& operator=(const ODMatrix& s);
428 
429 };
430 
431 
432 #endif
433 
434 /****************************************************************************/
435 
SUMOReal getNoLoaded() const
Returns the number of loaded vehicles.
Definition: ODMatrix.cpp:468
SUMOReal myNoLoaded
Number of loaded vehicles.
Definition: ODMatrix.h:350
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:174
Used for sorting the cells by the begin time they describe.
Definition: ODMatrix.h:363
const std::vector< ODCell * > & getCells()
Definition: ODMatrix.h:241
long long int SUMOTime
Definition: SUMOTime.h:43
SUMOReal computeDeparts(ODCell *cell, size_t &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:135
Retrieves a file linewise and reports the lines to a handler.
Definition: LineReader.h:58
SUMOReal myNoWritten
Number of written vehicles.
Definition: ODMatrix.h:353
const ODDistrictCont & myDistricts
The districts to retrieve sources/sinks from.
Definition: ODMatrix.h:347
An internal representation of a single vehicle.
Definition: ODMatrix.h:252
void 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
SAX-handler base for SUMO-files.
std::string from
The edge the vehicles shall start at.
Definition: ODMatrix.h:260
SUMOTime parseSingleTime(const std::string &time)
Definition: ODMatrix.cpp:309
ODMatrix & operator=(const ODMatrix &s)
invalid assignment operator
void loadMatrix(OptionsCont &oc)
read a matrix in one of several formats
Definition: ODMatrix.cpp:514
SUMOReal getNoDiscarded() const
Returns the number of discarded vehicles.
Definition: ODMatrix.cpp:480
~ODMatrix()
Destructor.
Definition: ODMatrix.cpp:66
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:350
std::string origin
Name of the origin district.
Definition: ODCell.h:69
cell_by_begin_comparator()
constructor
Definition: ODMatrix.h:366
An O/D (origin/destination) matrix.
Definition: ODMatrix.h:75
void readO(LineReader &lr, SUMOReal scale, std::string vehType, bool matrixHasVehType)
read a VISUM-matrix with the O Format
Definition: ODMatrix.cpp:418
ODCell * cell
The cell of the ODMatrix which generated the vehicle.
Definition: ODMatrix.h:258
void loadRoutes(OptionsCont &oc, SUMOSAXHandler &handler)
read SUMO routes
Definition: ODMatrix.cpp:560
A container for districts.
SUMOReal getNoWritten() const
Returns the number of written vehicles.
Definition: ODMatrix.cpp:474
Used for sorting vehicles by their departure (latest first)
Definition: ODMatrix.h:399
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:344
SUMOReal myNoDiscarded
Number of discarded vehicles.
Definition: ODMatrix.h:356
void sortByBeginTime()
Definition: ODMatrix.cpp:607
std::vector< ODCell * > myContainer
The loaded cells.
Definition: ODMatrix.h:341
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:273
SUMOReal readFactor(LineReader &lr, SUMOReal scale)
Definition: ODMatrix.cpp:338
std::pair< SUMOTime, SUMOTime > readTime(LineReader &lr)
Definition: ODMatrix.cpp:320
std::string getNextNonCommentLine(LineReader &lr)
Definition: ODMatrix.cpp:296
SUMOTime depart
The departure time of the vehicle.
Definition: ODMatrix.h:256
int operator()(ODCell *p1, ODCell *p2) const
Comparing operator.
Definition: ODMatrix.h:379
A storage for options typed value containers)
Definition: OptionsCont.h:108
void applyCurve(const Distribution_Points &ps)
Splits the stored cells dividing them on the given time line.
Definition: ODMatrix.cpp:501
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:203
std::string to
The edge the vehicles shall end at.
Definition: ODMatrix.h:262
ODMatrix(const ODDistrictCont &dc)
Constructor.
Definition: ODMatrix.cpp:62
std::string id
The id of the vehicle.
Definition: ODMatrix.h:254
bool operator()(const ODVehicle &p1, const ODVehicle &p2) const
Comparing operator.
Definition: ODMatrix.h:413
Distribution_Points parseTimeLine(const std::vector< std::string > &def, bool timelineDayInHours)
split the given timeline
Definition: ODMatrix.cpp:577