Eclipse SUMO - Simulation of Urban MObility
duarouter_main.cpp
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2001-2020 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials are made available under the
5 // terms of the Eclipse Public License 2.0 which is available at
6 // https://www.eclipse.org/legal/epl-2.0/
7 // This Source Code may also be made available under the following Secondary
8 // Licenses when the conditions for such availability set forth in the Eclipse
9 // Public License 2.0 are satisfied: GNU General Public License, version 2
10 // or later which is available at
11 // https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
12 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
13 /****************************************************************************/
20 // Main for DUAROUTER
21 /****************************************************************************/
22 #include <config.h>
23 
24 #ifdef HAVE_VERSION_H
25 #include <version.h>
26 #endif
27 
28 #include <iostream>
29 #include <string>
30 #include <limits.h>
31 #include <ctime>
32 #include <memory>
33 #include <xercesc/sax/SAXException.hpp>
34 #include <xercesc/sax/SAXParseException.hpp>
40 #include <utils/common/ToString.h>
41 #ifdef HAVE_FOX
43 #endif
45 #include <utils/options/Option.h>
50 #include <utils/router/CHRouter.h>
52 #include <utils/xml/XMLSubSys.h>
53 #include <router/ROFrame.h>
54 #include <router/ROLoader.h>
55 #include <router/RONet.h>
56 #include <router/ROEdge.h>
57 #include "RODUAEdgeBuilder.h"
58 #include "RODUAFrame.h"
59 
60 
61 // ===========================================================================
62 // functions
63 // ===========================================================================
64 /* -------------------------------------------------------------------------
65  * data processing methods
66  * ----------------------------------------------------------------------- */
72 void
73 initNet(RONet& net, ROLoader& loader, OptionsCont& oc) {
74  // load the net
75  RODUAEdgeBuilder builder;
76  ROEdge::setGlobalOptions(oc.getBool("weights.interpolate"));
77  loader.loadNet(net, builder);
78  // load the weights when wished/available
79  if (oc.isSet("weight-files")) {
80  loader.loadWeights(net, "weight-files", oc.getString("weight-attribute"), false, oc.getBool("weights.expand"));
81  }
82  if (oc.isSet("lane-weight-files")) {
83  loader.loadWeights(net, "lane-weight-files", oc.getString("weight-attribute"), true, oc.getBool("weights.expand"));
84  }
85 }
86 
87 
91 void
92 computeRoutes(RONet& net, ROLoader& loader, OptionsCont& oc) {
93  // initialise the loader
94  loader.openRoutes(net);
95  // build the router
98  const std::string measure = oc.getString("weight-attribute");
99  const std::string routingAlgorithm = oc.getString("routing-algorithm");
100  const double priorityFactor = oc.getFloat("weights.priority-factor");
101  const SUMOTime begin = string2time(oc.getString("begin"));
102  const SUMOTime end = string2time(oc.getString("end"));
103  if (measure == "traveltime" && priorityFactor == 0) {
104  if (routingAlgorithm == "dijkstra") {
105  router = new DijkstraRouter<ROEdge, ROVehicle>(ROEdge::getAllEdges(), oc.getBool("ignore-errors"), ttFunction, nullptr, false, nullptr, net.hasPermissions(), oc.isSet("restriction-params"));
106  } else if (routingAlgorithm == "astar") {
107  typedef AStarRouter<ROEdge, ROVehicle> AStar;
108  std::shared_ptr<const AStar::LookupTable> lookup;
109  if (oc.isSet("astar.all-distances")) {
110  lookup = std::make_shared<const AStar::FLT>(oc.getString("astar.all-distances"), (int)ROEdge::getAllEdges().size());
111  } else if (oc.isSet("astar.landmark-distances")) {
112  /* CHRouterWrapper<ROEdge, ROVehicle> chrouter(
113  ROEdge::getAllEdges(), true, &ROEdge::getTravelTimeStatic,
114  begin, end, SUMOTime_MAX, 1); */
116  std::vector<ReversedEdge<ROEdge, ROVehicle>*> reversed;
117  for (ROEdge* edge : ROEdge::getAllEdges()) {
118  reversed.push_back(edge->getReversedRoutingEdge());
119  }
120  for (ReversedEdge<ROEdge, ROVehicle>* redge : reversed) {
121  redge->init();
122  }
124  ROVehicle defaultVehicle(SUMOVehicleParameter(), nullptr, net.getVehicleTypeSecure(DEFAULT_VTYPE_ID), &net);
125  lookup = std::make_shared<const AStar::LMLT>(oc.getString("astar.landmark-distances"), ROEdge::getAllEdges(), &forward, &backward, &defaultVehicle,
126  oc.isSet("astar.save-landmark-distances") ? oc.getString("astar.save-landmark-distances") : "", oc.getInt("routing-threads"));
127  }
128  router = new AStar(ROEdge::getAllEdges(), oc.getBool("ignore-errors"), ttFunction, lookup, net.hasPermissions(), oc.isSet("restriction-params"));
129  } else if (routingAlgorithm == "CH") {
130  const SUMOTime weightPeriod = (oc.isSet("weight-files") ?
131  string2time(oc.getString("weight-period")) :
132  SUMOTime_MAX);
133  router = new CHRouter<ROEdge, ROVehicle>(
134  ROEdge::getAllEdges(), oc.getBool("ignore-errors"), &ROEdge::getTravelTimeStatic, SVC_IGNORING, weightPeriod, net.hasPermissions(), oc.isSet("restriction-params"));
135  } else if (routingAlgorithm == "CHWrapper") {
136  const SUMOTime weightPeriod = (oc.isSet("weight-files") ?
137  string2time(oc.getString("weight-period")) :
138  SUMOTime_MAX);
141  begin, end, weightPeriod, oc.getInt("routing-threads"));
142  } else {
143  throw ProcessError("Unknown routing Algorithm '" + routingAlgorithm + "'!");
144  }
145  } else {
147  if (measure == "traveltime") {
148  if (ROEdge::initPriorityFactor(priorityFactor)) {
150  } else {
152  }
153  } else if (measure == "CO") {
154  op = &ROEdge::getEmissionEffort<PollutantsInterface::CO>;
155  } else if (measure == "CO2") {
156  op = &ROEdge::getEmissionEffort<PollutantsInterface::CO2>;
157  } else if (measure == "PMx") {
158  op = &ROEdge::getEmissionEffort<PollutantsInterface::PM_X>;
159  } else if (measure == "HC") {
160  op = &ROEdge::getEmissionEffort<PollutantsInterface::HC>;
161  } else if (measure == "NOx") {
162  op = &ROEdge::getEmissionEffort<PollutantsInterface::NO_X>;
163  } else if (measure == "fuel") {
164  op = &ROEdge::getEmissionEffort<PollutantsInterface::FUEL>;
165  } else if (measure == "electricity") {
166  op = &ROEdge::getEmissionEffort<PollutantsInterface::ELEC>;
167  } else if (measure == "noise") {
169  } else {
171  }
172  if (measure != "traveltime" && !net.hasLoadedEffort()) {
173  WRITE_WARNING("No weight data was loaded for attribute '" + measure + "'.");
174  }
176  ROEdge::getAllEdges(), oc.getBool("ignore-errors"), op, ttFunction, false, nullptr, net.hasPermissions(), oc.isSet("restriction-params"));
177  }
178  int carWalk = 0;
179  for (const std::string& opt : oc.getStringVector("persontrip.transfer.car-walk")) {
180  if (opt == "parkingAreas") {
182  } else if (opt == "ptStops") {
184  } else if (opt == "allJunctions") {
186  }
187  }
188  for (const std::string& opt : oc.getStringVector("persontrip.transfer.taxi-walk")) {
189  if (opt == "ptStops") {
191  } else if (opt == "allJunctions") {
193  }
194  }
195  for (const std::string& opt : oc.getStringVector("persontrip.transfer.walk-taxi")) {
196  if (opt == "ptStops") {
198  } else if (opt == "allJunctions") {
200  }
201  }
202  double taxiWait = STEPS2TIME(string2time(OptionsCont::getOptions().getString("persontrip.taxi.waiting-time")));
203 
204  RailwayRouter<ROEdge, ROVehicle>* railRouter = nullptr;
205  if (net.hasBidiEdges()) {
206  railRouter = new RailwayRouter<ROEdge, ROVehicle>(ROEdge::getAllEdges(), true, ttFunction, nullptr, false, net.hasPermissions(),
207  oc.isSet("restriction-params"),
208  oc.getFloat("railway.max-train-length"));
209  }
211  new ROIntermodalRouter(RONet::adaptIntermodalRouter, carWalk, taxiWait, routingAlgorithm),
212  railRouter);
213  // process route definitions
214  try {
215  net.openOutput(oc);
216  loader.processRoutes(begin, end, string2time(oc.getString("route-steps")), net, provider);
217  net.writeIntermodal(oc, provider.getIntermodalRouter());
218  // end the processing
219  net.cleanup();
220  } catch (ProcessError&) {
221  net.cleanup();
222  throw;
223  }
224 }
225 
226 
227 /* -------------------------------------------------------------------------
228  * main
229  * ----------------------------------------------------------------------- */
230 int
231 main(int argc, char** argv) {
233  // give some application descriptions
234  oc.setApplicationDescription("Shortest path router and DUE computer for the microscopic, multi-modal traffic simulation SUMO.");
235  oc.setApplicationName("duarouter", "Eclipse SUMO duarouter Version " VERSION_STRING);
236  int ret = 0;
237  RONet* net = nullptr;
238  try {
239  XMLSubSys::init();
241  OptionsIO::setArgs(argc, argv);
243  if (oc.processMetaOptions(argc < 2)) {
245  return 0;
246  }
248  XMLSubSys::setValidation(oc.getString("xml-validation"), oc.getString("xml-validation.net"), oc.getString("xml-validation.routes"));
249 #ifdef HAVE_FOX
250  if (oc.getInt("routing-threads") > 1) {
251  // make the output aware of threading
253  }
254 #endif
256  if (!RODUAFrame::checkOptions()) {
257  throw ProcessError();
258  }
260  // load data
261  ROLoader loader(oc, false, !oc.getBool("no-step-log"));
262  net = new RONet();
263  initNet(*net, loader, oc);
264  // build routes
265  try {
266  computeRoutes(*net, loader, oc);
267  } catch (XERCES_CPP_NAMESPACE::SAXParseException& e) {
268  WRITE_ERROR(toString(e.getLineNumber()));
269  ret = 1;
270  } catch (XERCES_CPP_NAMESPACE::SAXException& e) {
271  WRITE_ERROR(StringUtils::transcode(e.getMessage()));
272  ret = 1;
273  }
274  if (MsgHandler::getErrorInstance()->wasInformed() || ret != 0) {
275  throw ProcessError();
276  }
277  } catch (const ProcessError& e) {
278  if (std::string(e.what()) != std::string("Process Error") && std::string(e.what()) != std::string("")) {
279  WRITE_ERROR(e.what());
280  }
281  MsgHandler::getErrorInstance()->inform("Quitting (on error).", false);
282  ret = 1;
283 #ifndef _DEBUG
284  } catch (const std::exception& e) {
285  if (std::string(e.what()) != std::string("")) {
286  WRITE_ERROR(e.what());
287  }
288  MsgHandler::getErrorInstance()->inform("Quitting (on error).", false);
289  ret = 1;
290  } catch (...) {
291  MsgHandler::getErrorInstance()->inform("Quitting (on unknown error).", false);
292  ret = 1;
293 #endif
294  }
295  delete net;
297  if (ret == 0) {
298  std::cout << "Success." << std::endl;
299  }
300  return ret;
301 }
302 
303 
304 /****************************************************************************/
#define WRITE_ERROR(msg)
Definition: MsgHandler.h:284
#define WRITE_WARNING(msg)
Definition: MsgHandler.h:276
IntermodalRouter< ROEdge, ROLane, RONode, ROVehicle > ROIntermodalRouter
Definition: RORoutable.h:41
SUMOTime string2time(const std::string &r)
convert string to SUMOTime
Definition: SUMOTime.cpp:45
#define STEPS2TIME(x)
Definition: SUMOTime.h:53
#define SUMOTime_MAX
Definition: SUMOTime.h:32
long long int SUMOTime
Definition: SUMOTime.h:31
@ SVC_IGNORING
vehicles ignoring classes
const std::string DEFAULT_VTYPE_ID
double gWeightsRandomFactor
Definition: StdDefs.cpp:29
std::string toString(const T &t, std::streamsize accuracy=gPrecision)
Definition: ToString.h:44
Computes the shortest path through a network using the A* algorithm.
Definition: AStarRouter.h:76
Computes the shortest path through a contracted network.
Definition: CHRouter.h:59
Computes the shortest path through a contracted network.
Computes the shortest path through a network using the Dijkstra algorithm.
@ TAXI_PICKUP_ANYWHERE
taxi customer may be picked up anywhere
@ TAXI_DROPOFF_ANYWHERE
taxi customer may exit anywhere
@ PARKING_AREAS
parking areas
@ ALL_JUNCTIONS
junctions with edges allowing the additional mode
@ TAXI_PICKUP_PT
taxi customer may be picked up at public transport stop
@ PT_STOPS
public transport stops and access
@ TAXI_DROPOFF_PT
taxi customer may be picked up at public transport stop
static MsgHandler * getErrorInstance()
Returns the instance to add errors to.
Definition: MsgHandler.cpp:80
virtual void inform(std::string msg, bool addType=true)
adds a new error to the list
Definition: MsgHandler.cpp:117
static void initOutputOptions()
init output options
Definition: MsgHandler.cpp:217
static void setFactory(Factory func)
Sets the factory function to use for new MsgHandlers.
Definition: MsgHandler.h:61
static MsgHandler * create(MsgType type)
A storage for options typed value containers)
Definition: OptionsCont.h:89
bool isSet(const std::string &name, bool failOnNonExistant=true) const
Returns the information whether the named option is set.
double getFloat(const std::string &name) const
Returns the double-value of the named option (only for Option_Float)
int getInt(const std::string &name) const
Returns the int-value of the named option (only for Option_Integer)
void setApplicationName(const std::string &appName, const std::string &fullName)
Sets the application name.
std::string getString(const std::string &name) const
Returns the string-value of the named option (only for Option_String)
void setApplicationDescription(const std::string &appDesc)
Sets the application description.
bool getBool(const std::string &name) const
Returns the boolean-value of the named option (only for Option_Bool)
const StringVector & getStringVector(const std::string &name) const
Returns the list of string-value of the named option (only for Option_StringVector)
static OptionsCont & getOptions()
Retrieves the options.
Definition: OptionsCont.cpp:58
bool processMetaOptions(bool missingOptions)
Checks for help and configuration output, returns whether we should exit.
static void setArgs(int argc, char **argv)
Stores the command line arguments for later parsing.
Definition: OptionsIO.cpp:58
static void getOptions(const bool commandLineOnly=false)
Parses the command line arguments and loads the configuration.
Definition: OptionsIO.cpp:79
Interface for building instances of duarouter-edges.
static void fillOptions()
Inserts options used by duarouter into the OptionsCont-singleton.
Definition: RODUAFrame.cpp:43
static bool checkOptions()
Checks set options from the OptionsCont-singleton for being valid for usage within duarouter.
Definition: RODUAFrame.cpp:193
A basic edge for routing applications.
Definition: ROEdge.h:70
static double getStoredEffort(const ROEdge *const edge, const ROVehicle *const, double time)
Definition: ROEdge.h:472
static bool initPriorityFactor(double priorityFactor)
initialize priority factor range
Definition: ROEdge.cpp:439
static double getTravelTimeStaticPriorityFactor(const ROEdge *const edge, const ROVehicle *const veh, double time)
Return traveltime weighted by edge priority (scaled penalty for low-priority edges)
Definition: ROEdge.h:432
static double getNoiseEffort(const ROEdge *const edge, const ROVehicle *const veh, double time)
Definition: ROEdge.cpp:211
static double getTravelTimeStaticRandomized(const ROEdge *const edge, const ROVehicle *const veh, double time)
Definition: ROEdge.h:422
static void setGlobalOptions(const bool interpolate)
Definition: ROEdge.h:492
static double getTravelTimeStatic(const ROEdge *const edge, const ROVehicle *const veh, double time)
Returns the travel time for the given edge.
Definition: ROEdge.h:418
static const ROEdgeVector & getAllEdges()
Returns all ROEdges.
Definition: ROEdge.cpp:347
The data loader.
Definition: ROLoader.h:53
bool loadWeights(RONet &net, const std::string &optionName, const std::string &measure, const bool useLanes, const bool boundariesOverride)
Loads the net weights.
Definition: ROLoader.cpp:256
void processRoutes(const SUMOTime start, const SUMOTime end, const SUMOTime increment, RONet &net, const RORouterProvider &provider)
Loads routes from all previously build route loaders.
Definition: ROLoader.cpp:195
virtual void loadNet(RONet &toFill, ROAbstractEdgeBuilder &eb)
Loads the network.
Definition: ROLoader.cpp:112
void openRoutes(RONet &net)
Builds and opens all route loaders.
Definition: ROLoader.cpp:165
The router's network representation.
Definition: RONet.h:62
SUMOVTypeParameter * getVehicleTypeSecure(const std::string &id)
Retrieves the named vehicle type.
Definition: RONet.cpp:334
bool hasBidiEdges() const
return whether the network contains bidirectional rail edges
Definition: RONet.h:410
void cleanup()
closes the file output for computed routes and deletes associated threads if necessary
Definition: RONet.cpp:310
void openOutput(const OptionsCont &options)
Opens the output for computed routes.
Definition: RONet.cpp:270
void writeIntermodal(const OptionsCont &options, ROIntermodalRouter &router) const
Writes the intermodal network and weights if requested.
Definition: RONet.cpp:291
static void adaptIntermodalRouter(ROIntermodalRouter &router)
Definition: RONet.cpp:722
bool hasPermissions() const
Definition: RONet.cpp:763
bool hasLoadedEffort() const
whether efforts were loaded from file
Definition: RONet.cpp:774
A vehicle as used by router.
Definition: ROVehicle.h:50
static void initRandGlobal(std::mt19937 *which=nullptr)
Reads the given random number options and initialises the random number generator in accordance.
Definition: RandHelper.cpp:76
IntermodalRouter< E, L, N, V > & getIntermodalRouter() const
Structure representing possible vehicle parameter.
static std::string transcode(const XMLCh *const data)
converts a 0-terminated XMLCh* array (usually UTF-16, stemming from Xerces) into std::string in UTF-8
Definition: StringUtils.h:133
static void close()
Closes all of an applications subsystems.
static bool checkOptions()
checks shared options and sets StdDefs
static void setValidation(const std::string &validationScheme, const std::string &netValidationScheme, const std::string &routeValidationScheme)
Enables or disables validation.
Definition: XMLSubSys.cpp:65
static void init()
Initialises the xml-subsystem.
Definition: XMLSubSys.cpp:54
int main(int argc, char **argv)
void initNet(RONet &net, ROLoader &loader, OptionsCont &oc)
void computeRoutes(RONet &net, ROLoader &loader, OptionsCont &oc)