Eclipse SUMO - Simulation of Urban MObility
NIFrame.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-2019 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials
5 // are made available under the terms of the Eclipse Public License v2.0
6 // which accompanies this distribution, and is available at
7 // http://www.eclipse.org/legal/epl-v20.html
8 // SPDX-License-Identifier: EPL-2.0
9 /****************************************************************************/
18 // Sets and checks options for netimport
19 /****************************************************************************/
20 
21 
22 // ===========================================================================
23 // included modules
24 // ===========================================================================
25 #include <config.h>
26 
27 #include <string>
28 #include <iostream>
29 #include <fstream>
30 #include <utils/options/Option.h>
34 #include <utils/common/ToString.h>
38 #include <netbuild/NBNetBuilder.h>
39 #include <netwrite/NWFrame.h>
41 #include "NIImporter_DlrNavteq.h"
42 #include "NIFrame.h"
43 
44 
45 // ===========================================================================
46 // method definitions
47 // ===========================================================================
48 void
49 NIFrame::fillOptions(bool forNetedit) {
51  // register input formats
52  oc.doRegister("sumo-net-file", 's', new Option_FileName());
53  oc.addSynonyme("sumo-net-file", "sumo-net", true);
54  oc.addDescription("sumo-net-file", "Input", "Read SUMO-net from FILE");
55  oc.addXMLDefault("sumo-net-file", "net");
56 
57  oc.doRegister("node-files", 'n', new Option_FileName());
58  oc.addSynonyme("node-files", "xml-node-files", true);
59  oc.addSynonyme("node-files", "xml-nodes", true);
60  oc.addSynonyme("node-files", "nodes");
61  oc.addDescription("node-files", "Input", "Read XML-node defs from FILE");
62 
63  oc.doRegister("edge-files", 'e', new Option_FileName());
64  oc.addSynonyme("edge-files", "xml-edge-files", true);
65  oc.addSynonyme("edge-files", "xml-edges", true);
66  oc.addSynonyme("edge-files", "edges");
67  oc.addDescription("edge-files", "Input", "Read XML-edge defs from FILE");
68 
69  oc.doRegister("connection-files", 'x', new Option_FileName());
70  oc.addSynonyme("connection-files", "xml-connection-files", true);
71  oc.addSynonyme("connection-files", "xml-connections", true);
72  oc.addSynonyme("connection-files", "connections");
73  oc.addDescription("connection-files", "Input", "Read XML-connection defs from FILE");
74 
75  oc.doRegister("tllogic-files", 'i', new Option_FileName());
76  oc.addDescription("tllogic-files", "Input", "Read XML-traffic light defs from FILE");
77 
78  oc.doRegister("type-files", 't', new Option_FileName());
79  oc.addSynonyme("type-files", "xml-type-files", true);
80  oc.addSynonyme("type-files", "xml-types", true);
81  oc.addSynonyme("type-files", "types");
82  oc.addDescription("type-files", "Input", "Read XML-type defs from FILE");
83 
84  if (!forNetedit) {
85  // would cause confusion because netedit loads stops and shapes using option --additional-files
86  oc.doRegister("ptstop-files", new Option_FileName());
87  oc.addDescription("ptstop-files", "Input", "Reads public transport stops from FILE");
88  oc.doRegister("ptline-files", new Option_FileName());
89  oc.addDescription("ptline-files", "Input", "Reads public transport lines from FILE");
90  oc.doRegister("polygon-files", new Option_FileName());
91  oc.addDescription("polygon-files", "Input", "Reads polygons from FILE for embedding in network where applicable");
92  }
93 
94  oc.doRegister("shapefile-prefix", new Option_FileName());
95  oc.addSynonyme("shapefile-prefix", "shapefile");
96  oc.addSynonyme("shapefile-prefix", "arcview", true);
97  oc.addSynonyme("shapefile-prefix", "tiger", true);
98  oc.addDescription("shapefile-prefix", "Input", "Read shapefiles (ArcView, Tiger, ...) from files starting with 'FILE'");
99 
100  oc.doRegister("dlr-navteq-prefix", new Option_FileName());
101  oc.addSynonyme("dlr-navteq-prefix", "dlr-navteq");
102  oc.addSynonyme("dlr-navteq-prefix", "elmar2", true);
103  oc.addDescription("dlr-navteq-prefix", "Input", "Read converted Navteq GDF data (unsplitted Elmar-network) from path 'FILE'");
104 
105  oc.doRegister("osm-files", new Option_FileName());
106  oc.addSynonyme("osm-files", "osm");
107  oc.addDescription("osm-files", "Input", "Read OSM-network from path 'FILE(s)'");
108 
109  oc.doRegister("opendrive-files", new Option_FileName());
110  oc.addSynonyme("opendrive-files", "opendrive");
111  oc.addDescription("opendrive-files", "Input", "Read OpenDRIVE-network from FILE");
112 
113  oc.doRegister("visum-file", new Option_FileName());
114  oc.addSynonyme("visum-file", "visum");
115  oc.addDescription("visum-file", "Input", "Read VISUM-net from FILE");
116 
117  oc.doRegister("vissim-file", new Option_FileName());
118  oc.addSynonyme("vissim-file", "vissim");
119  oc.addDescription("vissim-file", "Input", "Read VISSIM-net from FILE");
120 
121  oc.doRegister("robocup-dir", new Option_FileName());
122  oc.addSynonyme("robocup-dir", "robocup-net", true);
123  oc.addSynonyme("robocup-dir", "robocup");
124  oc.addDescription("robocup-dir", "Input", "Read RoboCup-net from DIR");
125 
126  oc.doRegister("matsim-files", new Option_FileName());
127  oc.addSynonyme("matsim-files", "matsim");
128  oc.addDescription("matsim-files", "Input", "Read MATsim-net from FILE");
129 
130  oc.doRegister("itsumo-files", new Option_FileName());
131  oc.addSynonyme("itsumo-files", "itsumo");
132  oc.addDescription("itsumo-files", "Input", "Read ITSUMO-net from FILE");
133 
134  oc.doRegister("heightmap.shapefiles", new Option_FileName());
135  oc.addDescription("heightmap.shapefiles", "Input", "Read heightmap from ArcGIS shapefile");
136 
137  oc.doRegister("heightmap.geotiff", new Option_FileName());
138  oc.addDescription("heightmap.geotiff", "Input", "Read heightmap from GeoTIFF");
139 
140  // register basic processing options
141  oc.doRegister("ignore-errors", new Option_Bool(false));
142  oc.addSynonyme("ignore-errors", "dismiss-loading-errors", true);
143  oc.addDescription("ignore-errors", "Report", "Continue on broken input");
144 
145  oc.doRegister("ignore-errors.connections", new Option_Bool(false));
146  oc.addDescription("ignore-errors.connections", "Report", "Continue on invalid connections");
147 
148  oc.doRegister("show-errors.connections-first-try", new Option_Bool(false));
149  oc.addDescription("show-errors.connections-first-try", "Report", "Show errors in connections at parsing");
150 
151  oc.doRegister("ignore-errors.edge-type", new Option_Bool(false));
152  oc.addDescription("ignore-errors.edge-type", "Report", "Continue on unknown edge types");
153 
154  oc.doRegister("speed-in-kmh", new Option_Bool(false));
155  oc.addDescription("speed-in-kmh", "Processing", "vmax is parsed as given in km/h (some)");
156 
157  oc.doRegister("construction-date", new Option_String());
158  oc.addDescription("construction-date", "Processing", "Use YYYY-MM-DD date to determine the readiness of features under construction");
159 
160  oc.doRegister("flatten", new Option_Bool(false));
161  oc.addDescription("flatten", "Processing", "Remove all z-data");
162 
163  // register xml options
164  oc.doRegister("plain.extend-edge-shape", new Option_Bool(false));
165  oc.addSynonyme("plain.extend-edge-shape", "xml.keep-shape", true);
166  oc.addDescription("plain.extend-edge-shape", "Processing", "If edge shapes do not end at the node positions, extend them");
167 
168  // register osm options
169  oc.doRegister("osm.skip-duplicates-check", new Option_Bool(false));
170  oc.addDescription("osm.skip-duplicates-check", "Formats", "Skips the check for duplicate nodes and edges");
171 
172  oc.doRegister("osm.elevation", new Option_Bool(false));
173  oc.addDescription("osm.elevation", "Formats", "Imports elevation data");
174 
175  oc.doRegister("osm.layer-elevation", new Option_Float(0));
176  oc.addDescription("osm.layer-elevation", "Formats", "Reconstruct (relative) elevation based on layer data. Each layer is raised by FLOAT m");
177 
178  oc.doRegister("osm.layer-elevation.max-grade", new Option_Float(10));
179  oc.addDescription("osm.layer-elevation.max-grade", "Formats", "Maximum grade threshold in % at 50km/h when reconstrucing elevation based on layer data. The value is scaled according to road speed.");
180 
181  oc.doRegister("osm.oneway-spread-right", new Option_Bool(false));
182  oc.addDescription("osm.oneway-spread-right", "Formats", "Whether one-way roads should be spread to the side instead of centered");
183 
184  oc.doRegister("osm.stop-output.length", new Option_Float(25));
185  oc.addDescription("osm.stop-output.length", "Formats", "The default length of a public transport stop in FLOAT m");
186  oc.doRegister("osm.stop-output.length.bus", new Option_Float(15));
187  oc.addDescription("osm.stop-output.length.bus", "Formats", "The default length of a bus stop in FLOAT m");
188  oc.doRegister("osm.stop-output.length.tram", new Option_Float(25));
189  oc.addDescription("osm.stop-output.length.tram", "Formats", "The default length of a tram stop in FLOAT m");
190  oc.doRegister("osm.stop-output.length.train", new Option_Float(200));
191  oc.addDescription("osm.stop-output.length.train", "Formats", "The default length of a train stop in FLOAT m");
192 
193  oc.doRegister("osm.all-attributes", new Option_Bool(false));
194  oc.addDescription("osm.all-attributes", "Formats", "Whether additional attributes shall be imported");
195 
196 
197  // register matsim options
198  oc.doRegister("matsim.keep-length", new Option_Bool(false));
199  oc.addDescription("matsim.keep-length", "Formats", "The edge lengths given in the MATSIM-file will be kept");
200 
201  oc.doRegister("matsim.lanes-from-capacity", new Option_Bool(false));
202  oc.addDescription("matsim.lanes-from-capacity", "Formats", "The lane number will be computed from the capacity");
203 
204 
205  // register shapefile options
206  oc.doRegister("shapefile.street-id", new Option_String());
207  oc.addSynonyme("shapefile.street-id", "arcview.street-id", true);
208  oc.addDescription("shapefile.street-id", "Formats", "Read edge ids from column STR");
209 
210  oc.doRegister("shapefile.from-id", new Option_String());
211  oc.addSynonyme("shapefile.from-id", "arcview.from-id", true);
212  oc.addDescription("shapefile.from-id", "Formats", "Read from-node ids from column STR");
213 
214  oc.doRegister("shapefile.to-id", new Option_String());
215  oc.addSynonyme("shapefile.to-id", "arcview.to-id", true);
216  oc.addDescription("shapefile.to-id", "Formats", "Read to-node ids from column STR");
217 
218  oc.doRegister("shapefile.type-id", new Option_String());
219  oc.addSynonyme("shapefile.type-id", "arcview.type-id", true);
220  oc.addDescription("shapefile.type-id", "Formats", "Read type ids from column STR");
221 
222  oc.doRegister("shapefile.laneNumber", new Option_String());
223  oc.addDescription("shapefile.laneNumber", "Formats", "Read lane number from column STR");
224 
225  oc.doRegister("shapefile.speed", new Option_String());
226  oc.addDescription("shapefile.speed", "Formats", "Read speed from column STR");
227 
228  oc.doRegister("shapefile.name", new Option_String());
229  oc.addDescription("shapefile.name", "Formats", "Read (non-unique) name from column STR");
230 
231  oc.doRegister("shapefile.node-join-dist", new Option_Float(0));
232  oc.addDescription("shapefile.node-join-dist", "Formats", "Distance threshold for determining whether distinct shapes are connected (used when from-id and to-id are not available)");
233 
234  oc.doRegister("shapefile.add-params", new Option_String());
235  oc.addDescription("shapefile.add-params", "Formats", "Add the list of field names as edge params");
236 
237  oc.doRegister("shapefile.use-defaults-on-failure", new Option_Bool(false));
238  oc.addSynonyme("shapefile.use-defaults-on-failure", "arcview.use-defaults-on-failure", true);
239  oc.addDescription("shapefile.use-defaults-on-failure", "Formats", "Uses edge type defaults on problems");
240 
241  oc.doRegister("shapefile.all-bidirectional", new Option_Bool(false));
242  oc.addSynonyme("shapefile.all-bidirectional", "shapefile.all-bidi");
243  oc.addSynonyme("shapefile.all-bidirectional", "arcview.all-bidi", true);
244  oc.addDescription("shapefile.all-bidirectional", "Formats", "Insert edges in both directions");
245 
246  oc.doRegister("shapefile.guess-projection", new Option_Bool(false));
247  oc.addSynonyme("shapefile.guess-projection", "arcview.guess-projection", true);
248  oc.addDescription("shapefile.guess-projection", "Formats", "Guess the proper projection");
249 
250 
251  // register vissim options
252  oc.doRegister("vissim.join-distance", new Option_Float(5.0f));
253  oc.addSynonyme("vissim.join-distance", "vissim.offset", true);
254  oc.addDescription("vissim.join-distance", "Formats", "Structure join offset");
255 
256  oc.doRegister("vissim.default-speed", new Option_Float(50.0f));
257  oc.addDescription("vissim.default-speed", "Formats", "Use FLOAT as default speed");
258 
259  oc.doRegister("vissim.speed-norm", new Option_Float(1.0f));
260  oc.addDescription("vissim.speed-norm", "Formats", "Factor for edge velocity");
261 
262  oc.doRegister("vissim.report-unset-speeds", new Option_Bool(false));
263  oc.addDescription("vissim.report-unset-speeds", "Formats", "Writes lanes without an explicit speed set");
264 
265 
266  // register visum options
267  oc.doRegister("visum.language-file", new Option_FileName());
268  oc.addDescription("visum.language-file", "Formats", "Load language mappings from FILE");
269 
270  oc.doRegister("visum.use-type-priority", new Option_Bool(false));
271  oc.addDescription("visum.use-type-priority", "Formats", "Uses priorities from types");
272 
273  oc.doRegister("visum.use-type-laneno", new Option_Bool(false));
274  oc.addDescription("visum.use-type-laneno", "Formats", "Uses lane numbers from types");
275 
276  oc.doRegister("visum.use-type-speed", new Option_Bool(false));
277  oc.addDescription("visum.use-type-speed", "Formats", "Uses speeds from types");
278 
279  oc.doRegister("visum.connector-speeds", new Option_Float(100.));
280  oc.addDescription("visum.connector-speeds", "Formats", "Sets connector speed");
281 
282  oc.doRegister("visum.connectors-lane-number", new Option_Integer(3));
283  oc.addSynonyme("visum.connectors-lane-number", "visum.connector-laneno", true);
284  oc.addDescription("visum.connectors-lane-number", "Formats", "Sets connector lane number");
285 
286  oc.doRegister("visum.no-connectors", new Option_Bool(false));
287  oc.addDescription("visum.no-connectors", "Formats", "Excludes connectors");
288 
289  oc.doRegister("visum.recompute-lane-number", new Option_Bool(false));
290  oc.addSynonyme("visum.recompute-lane-number", "visum.recompute-laneno", true);
291  oc.addDescription("visum.recompute-lane-number", "Formats", "Computes the number of lanes from the edges' capacities");
292 
293  oc.doRegister("visum.verbose-warnings", new Option_Bool(false));
294  oc.addDescription("visum.verbose-warnings", "Formats", "Prints all warnings, some of which are due to VISUM misbehaviour");
295 
296  oc.doRegister("visum.lanes-from-capacity.norm", new Option_Float((double) 1800));
297  oc.addSynonyme("visum.lanes-from-capacity.norm", "capacity-norm", true);
298  oc.addSynonyme("visum.lanes-from-capacity.norm", "lanes-from-capacity.norm");
299  oc.addDescription("visum.lanes-from-capacity.norm", "Formats", "The factor for flow to no. lanes conversion");
300 
301 
302  // register opendrive options
303  oc.doRegister("opendrive.import-all-lanes", new Option_Bool(false));
304  oc.addDescription("opendrive.import-all-lanes", "Formats", "Imports all lane types");
305  oc.doRegister("opendrive.ignore-widths", new Option_Bool(false));
306  oc.addDescription("opendrive.ignore-widths", "Formats", "Whether lane widths shall be ignored.");
307  oc.doRegister("opendrive.curve-resolution", new Option_Float(2.0));
308  oc.addDescription("opendrive.curve-resolution", "Formats", "The geometry resolution in m when importing curved geometries as line segments.");
309  oc.doRegister("opendrive.advance-stopline", new Option_Float(0.0));
310  oc.addDescription("opendrive.advance-stopline", "Formats", "Allow stop lines to be built beyond the start of the junction if the geometries allow so");
311  oc.doRegister("opendrive.min-width", new Option_Float(1.8));
312  oc.addDescription("opendrive.min-width", "Formats", "The minimum lane width for determining start or end of variable-width lanes");
313  oc.doRegister("opendrive.internal-shapes", new Option_Bool(false));
314  oc.addDescription("opendrive.internal-shapes", "Formats", "Import internal lane shapes");
315 
316  // register some additional options
317  oc.doRegister("tls.discard-loaded", new Option_Bool(false));
318  oc.addDescription("tls.discard-loaded", "TLS Building", "Does not instatiate traffic lights loaded from other formats than plain-XML");
319 
320  oc.doRegister("tls.discard-simple", new Option_Bool(false));
321  oc.addDescription("tls.discard-simple", "TLS Building", "Does not instatiate traffic lights at geometry-like nodes loaded from other formats than plain-XML");
322 
323  // register railway options
324  oc.doRegister("railway.signals.discard", new Option_Bool(false));
325  oc.addDescription("railway.signals.discard", "Railway", "Discard all railway signal information loaded from other formats than plain-xml");
326 }
327 
328 
329 bool
332  bool ok = oc.checkDependingSuboptions("shapefile", "shapefile.");
333  ok &= oc.checkDependingSuboptions("visum-file", "visum.");
334  ok &= oc.checkDependingSuboptions("vissim-file", "vissim.");
335 #ifdef PROJ_API_FILE
336  int numProjections = oc.getBool("simple-projection") + oc.getBool("proj.utm") + oc.getBool("proj.dhdn") + (oc.getString("proj").length() > 1);
337  if ((oc.isSet("osm-files") || oc.isSet("dlr-navteq-prefix") || oc.isSet("shapefile-prefix")) && numProjections == 0) {
338  if (oc.isDefault("proj")) {
339  oc.set("proj.utm", "true");
340  }
341  }
342  if (oc.isSet("dlr-navteq-prefix") && oc.isDefault("proj.scale")) {
343  oc.set("proj.scale", NIImporter_DlrNavteq::GEO_SCALE);
344  }
345 #else
346  if ((oc.isSet("osm-files") || oc.isSet("dlr-navteq-prefix") || oc.isSet("shapefile-prefix")) && !oc.getBool("simple-projection")) {
347  WRITE_ERROR("Cannot import network data without PROJ-Library. Please install packages proj before building sumo");
348  ok = false;
349  }
350 #endif
351  if (oc.isSet("sumo-net-file")) {
352  if (oc.isWriteable("no-turnarounds")) {
353  // changed default since turnarounds are loaded from the net file.
354  oc.set("no-turnarounds", "true");
355  }
356  if (oc.isWriteable("offset.disable-normalization")) {
357  // changed default since we wish to preserve the network as far as possible
358  oc.set("offset.disable-normalization", "true");
359  }
360  if (oc.isWriteable("geometry.max-grade.fix")) {
361  // changed default since we wish to preserve the network as far as possible
362  oc.set("geometry.max-grade.fix", "false");
363  }
364  if (!oc.getBool("opposites.guess") && oc.isWriteable("opposites.guess.fix-lengths")) {
365  // changed default since we wish to preserve the network as far as possible
366  oc.set("opposites.guess.fix-lengths", "true");
367  }
368  }
369  if (!oc.isSet("type-files")) {
370  const char* sumoPath = std::getenv("SUMO_HOME");
371  if (sumoPath == nullptr) {
372  WRITE_WARNING("Environment variable SUMO_HOME is not set, using built in type maps.");
373  } else {
374  const std::string path = sumoPath + std::string("/data/typemap/");
375  if (oc.isSet("osm-files")) {
376  oc.setDefault("type-files", path + "osmNetconvert.typ.xml");
377  }
378  if (oc.isSet("opendrive-files")) {
379  oc.setDefault("type-files", path + "opendriveNetconvert.typ.xml");
380  }
381  }
382  }
383  if (oc.isSet("opendrive-files")) {
384  if (oc.isDefault("tls.left-green.time")) {
385  // legacy behavior. see #2114
386  oc.set("tls.left-green.time", "0");
387  }
388  if (oc.isDefault("rectangular-lane-cut")) {
389  // a better interpretation of imported geometries
390  oc.set("rectangular-lane-cut", "true");
391  }
392  if (oc.isDefault("geometry.max-grade.fix")) {
393  // a better interpretation of imported geometries
394  oc.set("geometry.max-grade.fix", "false");
395  }
396  }
397  return ok;
398 }
399 
400 
401 
402 /****************************************************************************/
403 
void doRegister(const std::string &name, Option *v)
Adds an option under the given name.
Definition: OptionsCont.cpp:75
static void fillOptions(bool forNetedit=false)
Inserts options used by the network importer and network building modules.
Definition: NIFrame.cpp:49
bool getBool(const std::string &name) const
Returns the boolean-value of the named option (only for Option_Bool)
bool isDefault(const std::string &name) const
Returns the information whether the named option has still the default value.
#define WRITE_WARNING(msg)
Definition: MsgHandler.h:239
static OptionsCont & getOptions()
Retrieves the options.
Definition: OptionsCont.cpp:58
void addSynonyme(const std::string &name1, const std::string &name2, bool isDeprecated=false)
Adds a synonyme for an options name (any order)
Definition: OptionsCont.cpp:96
bool isSet(const std::string &name, bool failOnNonExistant=true) const
Returns the information whether the named option is set.
bool setDefault(const std::string &name, const std::string &value)
Sets the given value for the named option as new default value.
std::string getString(const std::string &name) const
Returns the string-value of the named option (only for Option_String)
bool isWriteable(const std::string &name)
Returns the information whether the named option may be set.
static bool checkOptions()
Checks set options from the OptionsCont-singleton for being valid.
Definition: NIFrame.cpp:330
#define WRITE_ERROR(msg)
Definition: MsgHandler.h:245
bool checkDependingSuboptions(const std::string &name, const std::string &prefix) const
Checks whether an option is set, which has options with a prefix depending on it. ...
bool set(const std::string &name, const std::string &value)
Sets the given value for the named option.
An integer-option.
Definition: Option.h:333
void addXMLDefault(const std::string &name, const std::string &xmlRoot="")
Adds an XML root element to handle by default. The special root "" denotes the default handler...
A storage for options typed value containers)
Definition: OptionsCont.h:90
void addDescription(const std::string &name, const std::string &subtopic, const std::string &description)
Adds a description for an option.
static const std::string GEO_SCALE
scaling factor for geo coordinates (DLRNavteq format uses this to increase floating point precisions)...