SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
jtrrouter_main.cpp
Go to the documentation of this file.
1 /****************************************************************************/
9 // Main for JTRROUTER
10 /****************************************************************************/
11 // SUMO, Simulation of Urban MObility; see http://sumo-sim.org/
12 // Copyright (C) 2001-2014 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 
23 
24 // ===========================================================================
25 // included modules
26 // ===========================================================================
27 #ifdef _MSC_VER
28 #include <windows_config.h>
29 #else
30 #include <config.h>
31 #endif
32 
33 #ifdef HAVE_VERSION_H
34 #include <version.h>
35 #endif
36 
37 #include <xercesc/sax/SAXException.hpp>
38 #include <xercesc/sax/SAXParseException.hpp>
40 #include <iostream>
41 #include <string>
42 #include <limits.h>
43 #include <ctime>
44 #include <set>
45 #include <router/ROFrame.h>
46 #include <router/ROLoader.h>
47 #include <router/RONet.h>
49 #include <utils/options/Option.h>
54 #include <utils/common/ToString.h>
57 #include <utils/xml/XMLSubSys.h>
58 #include "ROJTREdgeBuilder.h"
59 #include "ROJTRRouter.h"
60 #include "ROJTREdge.h"
61 #include "ROJTRTurnDefLoader.h"
62 #include "ROJTRFrame.h"
64 
65 #ifdef CHECK_MEMORY_LEAKS
66 #include <foreign/nvwa/debug_new.h>
67 #endif // CHECK_MEMORY_LEAKS
68 
69 
70 // ===========================================================================
71 // functions
72 // ===========================================================================
73 /* -------------------------------------------------------------------------
74  * data processing methods
75  * ----------------------------------------------------------------------- */
81 void
82 initNet(RONet& net, ROLoader& loader,
83  const std::vector<SUMOReal>& turnDefs) {
84  // load the net
85  ROJTREdgeBuilder builder;
86  loader.loadNet(net, builder);
87  // set the turn defaults
88  const std::map<std::string, ROEdge*>& edges = net.getEdgeMap();
89  for (std::map<std::string, ROEdge*>::const_iterator i = edges.begin(); i != edges.end(); ++i) {
90  static_cast<ROJTREdge*>((*i).second)->setTurnDefaults(turnDefs);
91  }
92 }
93 
94 std::vector<SUMOReal>
96  std::vector<SUMOReal> ret;
97  std::vector<std::string> defs = oc.getStringVector("turn-defaults");
98  if (defs.size() < 2) {
99  throw ProcessError("The defaults for turnings must be a tuple of at least two numbers divided by ','.");
100  }
101  for (std::vector<std::string>::const_iterator i = defs.begin(); i != defs.end(); ++i) {
102  try {
103  SUMOReal val = TplConvert::_2SUMOReal((*i).c_str());
104  ret.push_back(val);
105  } catch (NumberFormatException&) {
106  throw ProcessError("A turn default is not numeric.");
107  }
108  }
109  return ret;
110 }
111 
112 
113 void
115  // load the turning definitions (and possible sink definition)
116  if (oc.isSet("turn-ratio-files")) {
117  ROJTRTurnDefLoader loader(net);
118  std::vector<std::string> ratio_files = oc.getStringVector("turn-ratio-files");
119  for (std::vector<std::string>::const_iterator i = ratio_files.begin(); i != ratio_files.end(); ++i) {
120  if (!XMLSubSys::runParser(loader, *i)) {
121  throw ProcessError();
122  }
123  }
124  }
125  if (MsgHandler::getErrorInstance()->wasInformed() && oc.getBool("ignore-errors")) {
127  }
128  // parse sink edges specified at the input/within the configuration
129  if (oc.isSet("sink-edges")) {
130  std::vector<std::string> edges = oc.getStringVector("sink-edges");
131  for (std::vector<std::string>::const_iterator i = edges.begin(); i != edges.end(); ++i) {
132  ROJTREdge* edge = static_cast<ROJTREdge*>(net.getEdge(*i));
133  if (edge == 0) {
134  throw ProcessError("The edge '" + *i + "' declared as a sink is not known.");
135  }
136  edge->setType(ROEdge::ET_SINK);
137  }
138  }
139 }
140 
141 
145 void
147  // initialise the loader
148  loader.openRoutes(net);
149  // prepare the output
150  net.openOutput(oc.getString("output-file"), "", oc.getString("vtype-output"));
151  // build the router
152  ROJTRRouter router(net, oc.getBool("ignore-errors"), oc.getBool("accept-all-destinations"),
153  (int)(((SUMOReal) net.getEdgeNo()) * OptionsCont::getOptions().getFloat("max-edges-factor")),
154  oc.getBool("ignore-vclasses"), oc.getBool("allow-loops"));
155  loader.processRoutes(string2time(oc.getString("begin")), string2time(oc.getString("end")), net, router);
156  net.closeOutput();
157 }
158 
159 
160 /* -------------------------------------------------------------------------
161  * main
162  * ----------------------------------------------------------------------- */
163 int
164 main(int argc, char** argv) {
166  // give some application descriptions
167  oc.setApplicationDescription("Router for the microscopic road traffic simulation SUMO based on junction turning ratios.");
168  oc.setApplicationName("jtrrouter", "SUMO jtrrouter Version " + (std::string)VERSION_STRING);
169  int ret = 0;
170  RONet* net = 0;
171  try {
172  // initialise the application system (messaging, xml, options)
173  XMLSubSys::init();
175  OptionsIO::getOptions(true, argc, argv);
176  if (oc.processMetaOptions(argc < 2)) {
178  return 0;
179  }
180  XMLSubSys::setValidation(oc.getString("xml-validation"), oc.getString("xml-validation.net"));
182  if (!ROJTRFrame::checkOptions()) {
183  throw ProcessError();
184  }
186  std::vector<SUMOReal> defs = getTurningDefaults(oc);
187  // load data
188  ROLoader loader(oc, true, !oc.getBool("no-step-log"));
189  net = new RONet();
190  initNet(*net, loader, defs);
191  try {
192  // parse and set the turn defaults first
193  loadJTRDefinitions(*net, oc);
194  // build routes
195  computeRoutes(*net, loader, oc);
196  } catch (XERCES_CPP_NAMESPACE::SAXParseException& e) {
197  WRITE_ERROR(toString(e.getLineNumber()));
198  ret = 1;
199  } catch (XERCES_CPP_NAMESPACE::SAXException& e) {
200  WRITE_ERROR(TplConvert::_2str(e.getMessage()));
201  ret = 1;
202  }
203  if (MsgHandler::getErrorInstance()->wasInformed()) {
204  throw ProcessError();
205  }
206  } catch (const ProcessError& e) {
207  if (std::string(e.what()) != std::string("Process Error") && std::string(e.what()) != std::string("")) {
208  WRITE_ERROR(e.what());
209  }
210  MsgHandler::getErrorInstance()->inform("Quitting (on error).", false);
211  ret = 1;
212 #ifndef _DEBUG
213  } catch (const std::exception& e) {
214  if (std::string(e.what()) != std::string("")) {
215  WRITE_ERROR(e.what());
216  }
217  MsgHandler::getErrorInstance()->inform("Quitting (on error).", false);
218  ret = 1;
219  } catch (...) {
220  MsgHandler::getErrorInstance()->inform("Quitting (on unknown error).", false);
221  ret = 1;
222 #endif
223  }
224  delete net;
226  if (ret == 0) {
227  std::cout << "Success." << std::endl;
228  }
229  return ret;
230 }
231 
232 
233 
234 /****************************************************************************/
void processRoutes(SUMOTime start, SUMOTime end, RONet &net, SUMOAbstractRouter< ROEdge, ROVehicle > &router)
Loads routes from all previously build route loaders.
Definition: ROLoader.cpp:190
std::vector< std::string > getStringVector(const std::string &name) const
Returns the list of string-vector-value of the named option (only for Option_String) ...
static void init()
Initialises the xml-subsystem.
Definition: XMLSubSys.cpp:58
static MsgHandler * getErrorInstance()
Returns the instance to add errors to.
Definition: MsgHandler.cpp:80
Computes routes using junction turning percentages.
Definition: ROJTRRouter.h:52
static void getOptions(bool loadConfig, int argc=0, char **argv=0)
Parses the command line arguments and loads the configuration optionally.
Definition: OptionsIO.cpp:64
static SUMOReal _2SUMOReal(const E *const data)
Definition: TplConvert.h:223
void openRoutes(RONet &net)
Builds and opens all route loaders.
Definition: ROLoader.cpp:165
static void setValidation(const std::string &validationScheme, const std::string &netValidationScheme)
Enables or disables validation.
Definition: XMLSubSys.cpp:69
unsigned int getEdgeNo() const
Returns the number of edges the network contains.
Definition: RONet.cpp:397
void setApplicationDescription(const std::string &appDesc)
Sets the application description.
ROEdge * getEdge(const std::string &name) const
Retrieves an edge from the network.
Definition: RONet.h:100
bool getBool(const std::string &name) const
Returns the boolean-value of the named option (only for Option_Bool)
std::vector< SUMOReal > getTurningDefaults(OptionsCont &oc)
SUMOReal getFloat(const std::string &name) const
Returns the SUMOReal-value of the named option (only for Option_Float)
static bool runParser(GenericSAXHandler &handler, const std::string &file, const bool isNet=false)
Runs the given handler on the given file; returns if everything's ok.
Definition: XMLSubSys.cpp:114
static void close()
Closes all of an applications subsystems.
const std::map< std::string, ROEdge * > & getEdgeMap() const
Definition: RONet.cpp:409
static OptionsCont & getOptions()
Retrieves the options.
Definition: OptionsCont.cpp:67
static void initRandGlobal(MTRand *which=0)
Reads the given random number options and initialises the random number generator in accordance...
Definition: RandHelper.cpp:68
void openOutput(const std::string &filename, const std::string altFilename, const std::string typeFilename)
Opens the output for computed routes.
Definition: RONet.cpp:121
std::string getString(const std::string &name) const
Returns the string-value of the named option (only for Option_String)
void initNet(RONet &net, ROLoader &loader, const std::vector< SUMOReal > &turnDefs)
void closeOutput()
closes the file output for computed routes
Definition: RONet.cpp:140
void setType(EdgeType type)
Sets the type of te edge.
Definition: ROEdge.cpp:308
Loader for the of turning percentages and source/sink definitions.
static std::string _2str(const E *const data)
Definition: TplConvert.h:56
The data loader.
Definition: ROLoader.h:62
bool processMetaOptions(bool missingOptions)
Checks for help and configuration output, returns whether we should exit.
SUMOTime string2time(const std::string &r)
Definition: SUMOTime.cpp:48
An edge the jtr-router may route through.
Definition: ROJTREdge.h:57
std::string toString(const T &t, std::streamsize accuracy=OUTPUT_ACCURACY)
Definition: ToString.h:52
virtual void loadNet(RONet &toFill, ROAbstractEdgeBuilder &eb)
Loads the network.
Definition: ROLoader.cpp:128
int main(int argc, char **argv)
#define VERSION_STRING
Definition: config.h:227
#define WRITE_ERROR(msg)
Definition: MsgHandler.h:201
The router's network representation.
Definition: RONet.h:65
static void fillOptions()
Inserts options used by jtrrouter into the OptionsCont-singleton.
Definition: ROJTRFrame.cpp:56
static bool checkOptions()
Checks set options from the OptionsCont-singleton for being valid for usage within jtrrouter...
Definition: ROJTRFrame.cpp:103
void inform(std::string msg, bool addType=true)
adds a new error to the list
Definition: MsgHandler.cpp:89
A storage for options typed value containers)
Definition: OptionsCont.h:108
#define SUMOReal
Definition: config.h:215
An edge where vehicles disappear (no vehicle may leave this edge)
Definition: ROEdge.h:81
void clear()
Clears information whether an error occured previously.
Definition: MsgHandler.cpp:149
static void initOutputOptions()
Definition: MsgHandler.cpp:193
void computeRoutes(RONet &net, ROLoader &loader, OptionsCont &oc)
bool isSet(const std::string &name, bool failOnNonExistant=true) const
Returns the information whether the named option is set.
Interface for building instances of jtrrouter-edges.
void setApplicationName(const std::string &appName, const std::string &fullName)
Sets the application name.
void loadJTRDefinitions(RONet &net, OptionsCont &oc)