SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
NBFrame.cpp
Go to the documentation of this file.
1 /****************************************************************************/
9 // Sets and checks options for netbuild
10 /****************************************************************************/
11 // SUMO, Simulation of Urban MObility; see http://sumo-sim.org/
12 // Copyright (C) 2001-2013 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 #include <string>
34 #include <fstream>
35 #include "NBFrame.h"
36 #include "NBNodeCont.h"
37 #include "NBEdgeCont.h"
39 #include "NBDistrictCont.h"
40 #include "NBDistribution.h"
41 #include "NBRequest.h"
42 #include "NBTypeCont.h"
47 #include <utils/common/ToString.h>
51 
52 #ifdef CHECK_MEMORY_LEAKS
53 #include <foreign/nvwa/debug_new.h>
54 #endif // CHECK_MEMORY_LEAKS
55 
56 
57 // ===========================================================================
58 // method definitions
59 // ===========================================================================
60 void
61 NBFrame::fillOptions(bool forNetgen) {
63  // register building defaults
64  oc.doRegister("default.lanenumber", 'L', new Option_Integer(1));
65  oc.addSynonyme("default.lanenumber", "lanenumber", true);
66  oc.addDescription("default.lanenumber", "Building Defaults", "The default number of lanes in an edge");
67 
68  oc.doRegister("default.speed", 'S', new Option_Float((SUMOReal) 13.9));
69  oc.addSynonyme("default.speed", "speed", true);
70  oc.addDescription("default.speed", "Building Defaults", "The default speed on an edge (in m/s)");
71 
72  oc.doRegister("default.priority", 'P', new Option_Integer(-1));
73  oc.addSynonyme("default.priority", "priority", true);
74  oc.addDescription("default.priority", "Building Defaults", "The default priority of an edge");
75 
76 
77  // register the data processing options
78  oc.doRegister("no-internal-links", new Option_Bool(false)); // !!! not described
79  oc.addDescription("no-internal-links", "Processing", "Omits internal links");
80 
81  if (!forNetgen) {
82  oc.doRegister("dismiss-vclasses", new Option_Bool(false));
83  oc.addDescription("dismiss-vclasses", "Processing", "Removes vehicle class restrictions from imported edges.");
84  }
85 
86  oc.doRegister("no-turnarounds", new Option_Bool(false));
87  oc.addDescription("no-turnarounds", "Processing", "Disables building turnarounds");
88 
89  oc.doRegister("no-turnarounds.tls", new Option_Bool(false));
90  oc.addSynonyme("no-turnarounds.tls", "no-tls-turnarounds", true);
91  oc.addDescription("no-turnarounds.tls", "Processing", "Disables building turnarounds at tls-controlled junctions");
92 
93  oc.doRegister("no-left-connections", new Option_Bool(false));
94  oc.addDescription("no-left-connections", "Processing", "Disables building connections to left");
95 
96  if (!forNetgen) {
97  oc.doRegister("geometry.split", new Option_Bool(false)); // !!!not described
98  oc.addSynonyme("geometry.split", "split-geometry", true);
99  oc.addDescription("geometry.split", "Processing", "Splits edges across geometry nodes");
100 
101  oc.doRegister("geometry.remove", 'R', new Option_Bool(false));
102  oc.addSynonyme("geometry.remove", "remove-geometry", true);
103  oc.addDescription("geometry.remove", "Processing", "Replace nodes which only define edge geometry by geometry points (joins edges)");
104 
105  oc.doRegister("geometry.max-segment-length", new Option_Float(0));
106  oc.addDescription("geometry.max-segment-length", "Processing", "splits geometry to restrict segment length");
107 
108  oc.doRegister("geometry.min-dist", new Option_Float());
109  oc.addDescription("geometry.min-dist", "Processing", "reduces too similar geometry points");
110 
111  oc.doRegister("geometry.max-angle", new Option_Float(99));
112  oc.addDescription("geometry.max-angle", "Processing", "Warn about edge geometries with an angle above DEGREES in successive segments");
113 
114  oc.doRegister("geometry.min-radius", new Option_Float(9));
115  oc.addDescription("geometry.min-radius", "Processing", "Warn about edge geometries with a turning radius less than METERS at the start or end");
116 
117  oc.doRegister("geometry.min-radius.fix", new Option_Bool(false));
118  oc.addDescription("geometry.min-radius.fix", "Processing", "Straighten edge geometries to avoid turning radii less than geometry.min-radius");
119  }
120 
121  oc.doRegister("offset.disable-normalization", new Option_Bool(false));
122  oc.addSynonyme("offset.disable-normalization", "disable-normalize-node-positions", true);
123  oc.addDescription("offset.disable-normalization", "Processing", "Turn off normalizing node positions");
124 
125  oc.doRegister("offset.x", new Option_Float(0));
126  oc.addSynonyme("offset.x", "x-offset-to-apply", true);
127  oc.addDescription("offset.x", "Processing", "Adds FLOAT to net x-positions");
128 
129  oc.doRegister("offset.y", new Option_Float(0));
130  oc.addSynonyme("offset.y", "y-offset-to-apply", true);
131  oc.addDescription("offset.y", "Processing", "Adds FLOAT to net y-positions");
132 
133  oc.doRegister("flip-y-axis", new Option_Bool(false));
134  oc.addSynonyme("flip-y-axis", "flip-y");
135  oc.addDescription("flip-y-axis", "Processing", "Flips the y-coordinate along zero");
136 
137  oc.doRegister("roundabouts.guess", new Option_Bool(false));
138  oc.addSynonyme("roundabouts.guess", "guess-roundabouts", true);
139  oc.addDescription("roundabouts.guess", "Processing", "Enable roundabout-guessing");
140 
141  oc.doRegister("lefthand", new Option_Bool(false));
142  oc.addDescription("lefthand", "Processing", "Assumes left-hand traffic on the network");
143 
144  oc.doRegister("junctions.join", new Option_Bool(false));
145  oc.addDescription("junctions.join", "Processing",
146  "Joins junctions that are close to each other (recommended for OSM import)");
147 
148  oc.doRegister("junctions.join-dist", new Option_Float(10));
149  oc.addDescription("junctions.join-dist", "Processing",
150  "Determines the maximal distance for joining junctions (defaults to 10)");
151 
152  if (!forNetgen) {
153  oc.doRegister("junctions.join-exclude", new Option_String());
154  oc.addDescription("junctions.join-exclude", "Processing", "Interprets STR as list of junctions to exclude from joining");
155 
156  oc.doRegister("speed.offset", new Option_Float(0));
157  oc.addDescription("speed.offset", "Processing", "Modifies all edge speeds by adding FLOAT");
158 
159  oc.doRegister("speed.factor", new Option_Float(1));
160  oc.addDescription("speed.factor", "Processing", "Modifies all edge speeds by multiplying FLOAT");
161  }
162 
163 
164  oc.doRegister("check-lane-foes.roundabout", new Option_Bool(true));
165  oc.addDescription("check-lane-foes.roundabout", "Processing",
166  "Allow driving onto a multi-lane road if there are foes on other lanes (at roundabouts)");
167  oc.doRegister("check-lane-foes.all", new Option_Bool(false));
168  oc.addDescription("check-lane-foes.all", "Processing",
169  "Allow driving onto a multi-lane road if there are foes on other lanes (everywhere)");
170 
171  // tls setting options
172  // explicit tls
173  oc.doRegister("tls.set", new Option_String());
174  oc.addSynonyme("tls.set", "explicite-tls", true);
175  oc.addDescription("tls.set", "TLS Building", "Interprets STR as list of junctions to be controlled by TLS");
176 
177  oc.doRegister("tls.unset", new Option_String());
178  oc.addSynonyme("tls.unset", "explicite-no-tls", true);
179  oc.addDescription("tls.unset", "TLS Building", "Interprets STR as list of junctions to be not controlled by TLS");
180 
181  // tls-guessing
182  oc.doRegister("tls.guess", new Option_Bool(false));
183  oc.addSynonyme("tls.guess", "guess-tls", true);
184  oc.addDescription("tls.guess", "TLS Building", "Turns on TLS guessing");
185 
186  if (!forNetgen) {
187  oc.doRegister("tls.taz-nodes", new Option_Bool(false));
188  oc.addSynonyme("tls.taz-nodes", "tls-guess.district-nodes", true);
189  oc.addDescription("tls.taz-nodes", "TLS Building", "Sets district nodes as tls-controlled"); // !!! describe
190  }
191 
192  oc.doRegister("tls-guess.joining", new Option_Bool(false));
193  oc.addDescription("tls-guess.joining", "TLS Building", "Includes node clusters into guess"); // !!! describe
194 
195  oc.doRegister("tls.join", new Option_Bool(false));
196  oc.addSynonyme("tls.join", "try-join-tls", true);
197  oc.addDescription("tls.join", "TLS Building", "Tries to cluster tls-controlled nodes"); // !!! describe
198 
199  oc.doRegister("tls.join-dist", new Option_Float(20));
200  oc.addDescription("tls.join-dist", "Processing",
201  "Determines the maximal distance for joining traffic lights (defaults to 20)");
202 
203  // computational
204  oc.doRegister("tls.green.time", new Option_Integer(31));
205  oc.addSynonyme("tls.green.time", "traffic-light-green", true);
206  oc.addDescription("tls.green.time", "TLS Building", "Use INT as green phase duration");
207 
208  oc.doRegister("tls.yellow.min-decel", 'D', new Option_Float(3.0));
209  oc.addSynonyme("tls.yellow.min-decel", "min-decel", true);
210  oc.addDescription("tls.yellow.min-decel", "TLS Building", "Defines smallest vehicle deceleration");
211 
212  oc.doRegister("tls.yellow.patch-small", new Option_Bool(false));
213  oc.addSynonyme("tls.yellow.patch-small", "patch-small-tyellow", true);
214  oc.addDescription("tls.yellow.patch-small", "TLS Building", "Given yellow times are patched even if being too short");
215 
216  oc.doRegister("tls.yellow.time", new Option_Integer());
217  oc.addSynonyme("tls.yellow.time", "traffic-light-yellow", true);
218  oc.addDescription("tls.yellow.time", "TLS Building", "Set INT as fixed time for yellow phase durations");
219 
220  // tls-shifts
221  oc.doRegister("tls.half-offset", new Option_String());
222  oc.addSynonyme("tls.half-offset", "tl-logics.half-offset", true);
223  oc.addDescription("tls.half-offset", "TLS Building", "TLSs in STR will be shifted by half-phase");
224 
225  oc.doRegister("tls.quarter-offset", new Option_String());
226  oc.addSynonyme("tls.quarter-offset", "tl-logics.quarter-offset", true);
227  oc.addDescription("tls.quarter-offset", "TLS Building", "TLSs in STR will be shifted by quarter-phase");
228 
229  // tls type
230  oc.doRegister("tls.default-type", new Option_String("static"));
231  oc.addDescription("tls.default-type", "TLS Building", "TLSs with unspecified type will use STR as their algorithm.");
232 
233 
234  // edge pruning
235  oc.doRegister("keep-edges.min-speed", new Option_Float());
236  oc.addSynonyme("keep-edges.min-speed", "edges-min-speed", true);
237  oc.addDescription("keep-edges.min-speed", "Edge Removal", "Only keep edges with speed in meters/second > FLOAT");
238 
239  oc.doRegister("remove-edges.explicit", new Option_String());
240  oc.addSynonyme("remove-edges.explicit", "remove-edges");
241  oc.addDescription("remove-edges.explicit", "Edge Removal", "Remove edges in STR");
242 
243  oc.doRegister("keep-edges.explicit", new Option_String());
244  oc.addSynonyme("keep-edges.explicit", "keep-edges");
245  oc.addDescription("keep-edges.explicit", "Edge Removal", "Only keep edges in STR");
246 
247  oc.doRegister("keep-edges.input-file", new Option_FileName());
248  oc.addDescription("keep-edges.input-file", "Edge Removal", "Only keep edges in FILE");
249 
250  if (!forNetgen) {
251  oc.doRegister("keep-edges.postload", new Option_Bool(false));
252  oc.addDescription("keep-edges.postload", "Edge Removal", "Remove edges after joining");
253  }
254 
255  oc.doRegister("keep-edges.in-boundary", new Option_String());
256  oc.addDescription("keep-edges.in-boundary", "Edge Removal", "Only keep edges which are located within the given boundary (given either as CARTESIAN corner coordinates <xmin,ymin,xmax,ymax> or as polygon <x0,y0,x1,y1,...>)");
257 
258  oc.doRegister("keep-edges.in-geo-boundary", new Option_String());
259  oc.addDescription("keep-edges.in-geo-boundary", "Edge Removal", "Only keep edges which are located within the given boundary (given either as GEODETIC corner coordinates <lon-min,lat-min,lon-max,lat-max> or as polygon <lon0,lat0,lon1,lat1,...>)");
260 
261  if (!forNetgen) {
262  oc.doRegister("keep-edges.by-vclass", new Option_String());
263  oc.addDescription("keep-edges.by-vclass", "Edge Removal", "Only keep edges which allow one of the vclasss in STR");
264 
265  oc.doRegister("remove-edges.by-vclass", new Option_String());
266  oc.addDescription("remove-edges.by-vclass", "Edge Removal", "Remove edges which allow only vclasses from STR");
267 
268  oc.doRegister("keep-edges.by-type", new Option_String());
269  oc.addDescription("keep-edges.by-type", "Edge Removal", "Only keep edges where type is in STR");
270 
271  oc.doRegister("remove-edges.by-type", new Option_String());
272  oc.addDescription("remove-edges.by-type", "Edge Removal", "Remove edges where type is in STR");
273 
274  oc.doRegister("remove-edges.isolated", new Option_Bool(false));
275  oc.addSynonyme("remove-edges.isolated", "remove-isolated", true);
276  oc.addDescription("remove-edges.isolated", "Edge Removal", "Removes isolated edges");
277  }
278 
279 
280  // unregulated nodes options
281  oc.doRegister("keep-nodes-unregulated", new Option_Bool(false));
282  oc.addSynonyme("keep-nodes-unregulated", "keep-unregulated");
283  oc.addDescription("keep-nodes-unregulated", "Unregulated Nodes", "All nodes will be unregulated");
284 
285  oc.doRegister("keep-nodes-unregulated.explicit", new Option_String());
286  oc.addSynonyme("keep-nodes-unregulated.explicit", "keep-unregulated.explicit");
287  oc.addSynonyme("keep-nodes-unregulated.explicit", "keep-unregulated.nodes", true);
288  oc.addDescription("keep-nodes-unregulated.explicit", "Unregulated Nodes", "Do not regulate nodes in STR");
289 
290  oc.doRegister("keep-nodes-unregulated.district-nodes", new Option_Bool(false));
291  oc.addSynonyme("keep-nodes-unregulated.district-nodes", "keep-unregulated.district-nodes");
292  oc.addDescription("keep-nodes-unregulated.district-nodes", "Unregulated Nodes", "Do not regulate district nodes");
293 
294 
295  // ramp guessing options
296  if (!forNetgen) {
297  oc.doRegister("ramps.guess", new Option_Bool(false));
298  oc.addSynonyme("ramps.guess", "guess-ramps", true);
299  oc.addDescription("ramps.guess", "Ramp Guessing", "Enable ramp-guessing");
300 
301  oc.doRegister("ramps.max-ramp-speed", new Option_Float(-1));
302  oc.addSynonyme("ramps.max-ramp-speed", "ramp-guess.max-ramp-speed", true);
303  oc.addDescription("ramps.max-ramp-speed", "Ramp Guessing", "Treat edges with speed > FLOAT as no ramps");
304 
305  oc.doRegister("ramps.min-highway-speed", new Option_Float((SUMOReal)(79 / 3.6)));
306  oc.addSynonyme("ramps.min-highway-speed", "ramp-guess.min-highway-speed", true);
307  oc.addDescription("ramps.min-highway-speed", "Ramp Guessing", "Treat edges with speed < FLOAT as no highways");
308 
309  oc.doRegister("ramps.ramp-length", new Option_Float(100));
310  oc.addSynonyme("ramps.ramp-length", "ramp-guess.ramp-length", true);
311  oc.addDescription("ramps.ramp-length", "Ramp Guessing", "Use FLOAT as ramp-length");
312 
313  oc.doRegister("ramps.set", new Option_String());
314  oc.addSynonyme("ramps.set", "ramp-guess.explicite", true);
315  oc.addDescription("ramps.set", "Ramp Guessing", "Tries to handle the given edges as ramps");
316 
317  oc.doRegister("ramps.no-split", new Option_Bool(false));
318  oc.addSynonyme("ramps.no-split", "ramp-guess.no-split", true);
319  oc.addDescription("ramps.no-split", "Ramp Guessing", "Avoids edge splitting");
320  }
321 }
322 
323 
324 bool
327  bool ok = true;
328  //
329  if (!oc.isDefault("tls-guess.joining")) {
330  WRITE_WARNING("'--tls-guess.joining' was joined with '--tls.join'.\n Please use '--tls.join' in future only.");
331  if (!oc.isSet("tls.join")) {
332  oc.set("tls.join", "true");
333  }
334  }
335  if (!SUMOXMLDefinitions::TrafficLightTypes.hasString(oc.getString("tls.default-type"))) {
336  WRITE_ERROR("unsupported value '" + oc.getString("tls.default-type") + "' for option '--tls.default-type'");
337  ok = false;
338  }
339  if (oc.isSet("keep-edges.in-boundary") && oc.isSet("keep-edges.in-geo-boundary")) {
340  WRITE_ERROR("only one of the options 'keep-edges.in-boundary' or 'keep-edges.in-geo-boundary' may be given");
341  ok = false;
342  }
343  return ok;
344 }
345 
346 
347 /****************************************************************************/
void doRegister(const std::string &name, Option *v)
Adds an option under the given name.
Definition: OptionsCont.cpp:84
static bool checkOptions()
Checks set options from the OptionsCont-singleton for being valid.
Definition: NBFrame.cpp:325
#define WRITE_WARNING(msg)
Definition: MsgHandler.h:196
static OptionsCont & getOptions()
Retrieves the options.
Definition: OptionsCont.cpp:67
void addSynonyme(const std::string &name1, const std::string &name2, bool isDeprecated=false)
Adds a synonyme for an options name (any order)
std::string getString(const std::string &name) const
Returns the string-value of the named option (only for Option_String)
static StringBijection< TrafficLightType > TrafficLightTypes
bool isDefault(const std::string &name) const
Returns the information whether the named option has still the default value.
#define WRITE_ERROR(msg)
Definition: MsgHandler.h:201
bool set(const std::string &name, const std::string &value)
Sets the given value for the named option.
An integer-option.
Definition: Option.h:308
A storage for options typed value containers)
Definition: OptionsCont.h:108
static void fillOptions(bool forNetgen)
Inserts options used by the network converter.
Definition: NBFrame.cpp:61
#define SUMOReal
Definition: config.h:221
void addDescription(const std::string &name, const std::string &subtopic, const std::string &description)
Adds a description for an option.
bool isSet(const std::string &name, bool failOnNonExistant=true) const
Returns the information whether the named option is set.