SUMO - Simulation of Urban MObility
MSFrame.cpp
Go to the documentation of this file.
1 /****************************************************************************/
13 // Sets and checks options for microsim; inits global outputs and settings
14 /****************************************************************************/
15 // SUMO, Simulation of Urban MObility; see http://sumo.dlr.de/
16 // Copyright (C) 2002-2016 DLR (http://www.dlr.de/) and contributors
17 /****************************************************************************/
18 //
19 // This file is part of SUMO.
20 // SUMO is free software: you can redistribute it and/or modify
21 // it under the terms of the GNU General Public License as published by
22 // the Free Software Foundation, either version 3 of the License, or
23 // (at your option) any later version.
24 //
25 /****************************************************************************/
26 
27 
28 // ===========================================================================
29 // included modules
30 // ===========================================================================
31 #ifdef _MSC_VER
32 #include <windows_config.h>
33 #else
34 #include <config.h>
35 #endif
36 
37 #include <iostream>
38 #include <iomanip>
39 #include <fstream>
40 #include <ctime>
42 #include <utils/options/Option.h>
45 #include <utils/common/ToString.h>
48 #include <microsim/MSBaseVehicle.h>
49 #include <microsim/MSJunction.h>
50 #include <microsim/MSRoute.h>
51 #include <microsim/MSNet.h>
52 #include <microsim/MSGlobals.h>
57 #include "MSFrame.h"
59 
60 #ifdef CHECK_MEMORY_LEAKS
61 #include <foreign/nvwa/debug_new.h>
62 #endif // CHECK_MEMORY_LEAKS
63 
64 
65 // ===========================================================================
66 // method definitions
67 // ===========================================================================
68 void
71  oc.addCallExample("-b 0 -e 1000 -n net.xml -r routes.xml", "start a simulation from time 0 to 1000 with given net and routes");
72  oc.addCallExample("-c munich_config.cfg", "start with a configuration file");
73  oc.addCallExample("--help", "print help");
74 
75  // insert options sub-topics
76  SystemFrame::addConfigurationOptions(oc); // fill this subtopic, too
77  oc.addOptionSubTopic("Input");
78  oc.addOptionSubTopic("Output");
79  oc.addOptionSubTopic("Time");
80  oc.addOptionSubTopic("Processing");
81  oc.addOptionSubTopic("Routing");
82  SystemFrame::addReportOptions(oc); // fill this subtopic, too
83 
84 
85  // register configuration options
86  // register input options
87  oc.doRegister("net-file", 'n', new Option_FileName());
88  oc.addSynonyme("net-file", "net");
89  oc.addDescription("net-file", "Input", "Load road network description from FILE");
90  oc.addXMLDefault("net-file", "net");
91 
92  oc.doRegister("route-files", 'r', new Option_FileName());
93  oc.addSynonyme("route-files", "routes");
94  oc.addDescription("route-files", "Input", "Load routes descriptions from FILE(s)");
95 
96  oc.doRegister("additional-files", 'a', new Option_FileName());
97  oc.addSynonyme("additional-files", "additional");
98  oc.addDescription("additional-files", "Input", "Load further descriptions from FILE(s)");
99 
100  oc.doRegister("weight-files", 'w', new Option_FileName());
101  oc.addSynonyme("weight-files", "weights");
102  oc.addDescription("weight-files", "Input", "Load edge/lane weights for online rerouting from FILE");
103  oc.doRegister("weight-attribute", 'x', new Option_String("traveltime"));
104  oc.addSynonyme("weight-attribute", "measure", true);
105  oc.addDescription("weight-attribute", "Input", "Name of the xml attribute which gives the edge weight");
106 
107  oc.doRegister("load-state", new Option_FileName());
108  oc.addDescription("load-state", "Input", "Loads a network state from FILE");
109  oc.doRegister("load-state.offset", new Option_String("0", "TIME"));
110  oc.addDescription("load-state.offset", "Input", "Shifts all times loaded from a saved state by the given offset");
111 
112  // register output options
113  oc.doRegister("netstate-dump", new Option_FileName());
114  oc.addSynonyme("netstate-dump", "ndump");
115  oc.addSynonyme("netstate-dump", "netstate");
116  oc.addSynonyme("netstate-dump", "netstate-output");
117  oc.addDescription("netstate-dump", "Output", "Save complete network states into FILE");
118  oc.doRegister("netstate-dump.empty-edges", new Option_Bool(false));
119  oc.addSynonyme("netstate-dump.empty-edges", "netstate.empty-edges");
120  oc.addSynonyme("netstate-dump.empty-edges", "netstate-output.empty-edges");
121  oc.addSynonyme("netstate-dump.empty-edges", "dump-empty-edges", true);
122  oc.addDescription("netstate-dump.empty-edges", "Output", "Write also empty edges completely when dumping");
123  oc.doRegister("netstate-dump.precision", new Option_Integer(OUTPUT_ACCURACY));
124  oc.addSynonyme("netstate-dump.precision", "netstate.precision");
125  oc.addSynonyme("netstate-dump.precision", "netstate-output.precision");
126  oc.addSynonyme("netstate-dump.precision", "dump-precision", true);
127  oc.addDescription("netstate-dump.precision", "Output", "Write positions and speeds with the given precision (default 2)");
128 
129 
130  oc.doRegister("emission-output", new Option_FileName());
131  oc.addDescription("emission-output", "Output", "Save the emission values of each vehicle");
132  oc.doRegister("emission-output.precision", new Option_Integer(OUTPUT_ACCURACY));
133  oc.addDescription("emission-output.precision", "Output", "Write emission values with the given precision (default 2)");
134 
135  oc.doRegister("battery-output", new Option_FileName());
136  oc.addDescription("battery-output", "Output", "Save the battery values of each vehicle");
137  oc.doRegister("battery-output.precision", new Option_Integer(OUTPUT_ACCURACY));
138  oc.addDescription("battery-output.precision", "Output", "Write battery values with the given precision (default 2)");
139 
140  oc.doRegister("fcd-output", new Option_FileName());
141  oc.addDescription("fcd-output", "Output", "Save the Floating Car Data");
142  oc.doRegister("fcd-output.geo", new Option_Bool(false));
143  oc.addDescription("fcd-output.geo", "Output", "Save the Floating Car Data using geo-coordinates (lon/lat)");
144  oc.doRegister("fcd-output.signals", new Option_Bool(false));
145  oc.addDescription("fcd-output.signals", "Output", "Add the vehicle signal state to the FCD output (brake lights etc.)");
146  oc.doRegister("full-output", new Option_FileName());
147  oc.addDescription("full-output", "Output", "Save a lot of information for each timestep (very redundant)");
148  oc.doRegister("queue-output", new Option_FileName());
149  oc.addDescription("queue-output", "Output", "Save the vehicle queues at the junctions (experimental)");
150  oc.doRegister("vtk-output", new Option_FileName());
151  oc.addDescription("vtk-output", "Output", "Save complete vehicle positions inclusive speed values in the VTK Format (usage: /path/out will produce /path/out_$TIMESTEP$.vtp files)");
152  oc.doRegister("amitran-output", new Option_FileName());
153  oc.addDescription("amitran-output", "Output", "Save the vehicle trajectories in the Amitran format");
154 
155 
156  oc.doRegister("summary-output", new Option_FileName());
157  oc.addSynonyme("summary-output", "summary");
158  oc.addDescription("summary-output", "Output", "Save aggregated vehicle departure info into FILE");
159 
160  oc.doRegister("tripinfo-output", new Option_FileName());
161  oc.addSynonyme("tripinfo-output", "tripinfo");
162  oc.addDescription("tripinfo-output", "Output", "Save single vehicle trip info into FILE");
163 
164  oc.doRegister("tripinfo-output.write-unfinished", new Option_Bool(false));
165  oc.addDescription("tripinfo-output.write-unfinished", "Output", "Write tripinfo output for vehicles which have not arrived at simulation end");
166 
167  oc.doRegister("vehroute-output", new Option_FileName());
168  oc.addSynonyme("vehroute-output", "vehroutes");
169  oc.addDescription("vehroute-output", "Output", "Save single vehicle route info into FILE");
170 
171  oc.doRegister("vehroute-output.exit-times", new Option_Bool(false));
172  oc.addSynonyme("vehroute-output.exit-times", "vehroutes.exit-times");
173  oc.addDescription("vehroute-output.exit-times", "Output", "Write the exit times for all edges");
174 
175  oc.doRegister("vehroute-output.last-route", new Option_Bool(false));
176  oc.addSynonyme("vehroute-output.last-route", "vehroutes.last-route");
177  oc.addDescription("vehroute-output.last-route", "Output", "Write the last route only");
178 
179  oc.doRegister("vehroute-output.sorted", new Option_Bool(false));
180  oc.addSynonyme("vehroute-output.sorted", "vehroutes.sorted");
181  oc.addDescription("vehroute-output.sorted", "Output", "Sorts the output by departure time");
182 
183  oc.doRegister("vehroute-output.dua", new Option_Bool(false));
184  oc.addSynonyme("vehroute-output.dua", "vehroutes.dua");
185  oc.addDescription("vehroute-output.dua", "Output", "Write the output in the duarouter alternatives style");
186 
187  oc.doRegister("vehroute-output.intended-depart", new Option_Bool(false));
188  oc.addSynonyme("vehroute-output.intended-depart", "vehroutes.intended-depart");
189  oc.addDescription("vehroute-output.intended-depart", "Output", "Write the output with the intended instead of the real departure time");
190 
191  oc.doRegister("vehroute-output.route-length", new Option_Bool(false));
192  oc.addSynonyme("vehroute-output.route-length", "vehroutes.route-length");
193  oc.addDescription("vehroute-output.route-length", "Output", "Include total route length in the output");
194 
195  oc.doRegister("vehroute-output.write-unfinished", new Option_Bool(false));
196  oc.addDescription("vehroute-output.write-unfinished", "Output", "Write vehroute output for vehicles which have not arrived at simulation end");
197 
198  oc.doRegister("link-output", new Option_FileName());
199  oc.addDescription("link-output", "Output", "Save links states into FILE");
200 
201  oc.doRegister("bt-output", new Option_FileName());
202  oc.addDescription("bt-output", "Output", "Save bluetooth visibilities into FILE (in conjunction with device.btreceiver and device.btsender)");
203 
204  oc.doRegister("lanechange-output", new Option_FileName());
205  oc.addDescription("lanechange-output", "Output", "Record lane changes and their motivations for all vehicles into FILE");
206 
207 #ifdef _DEBUG
208  oc.doRegister("movereminder-output", new Option_FileName());
209  oc.addDescription("movereminder-output", "Output", "Save movereminder states of selected vehicles into FILE");
210  oc.doRegister("movereminder-output.vehicles", new Option_String());
211  oc.addDescription("movereminder-output.vehicles", "Output", "List of vehicle ids which shall save their movereminder states");
212 #endif
213 
214  oc.doRegister("save-state.times", new Option_IntVector(IntVector()));
215  oc.addDescription("save-state.times", "Output", "Use INT[] as times at which a network state written");
216  oc.doRegister("save-state.period", new Option_String("-1", "TIME"));
217  oc.addDescription("save-state.period", "Output", "save state repeatedly after TIME period");
218  oc.doRegister("save-state.prefix", new Option_FileName("state"));
219  oc.addDescription("save-state.prefix", "Output", "Prefix for network states");
220  oc.doRegister("save-state.suffix", new Option_FileName(".sbx"));
221  oc.addDescription("save-state.suffix", "Output", "Suffix for network states (.sbx or .xml)");
222  oc.doRegister("save-state.files", new Option_FileName());//
223  oc.addDescription("save-state.files", "Output", "Files for network states");
224 
225  // register the simulation settings
226  oc.doRegister("begin", 'b', new Option_String("0", "TIME"));
227  oc.addDescription("begin", "Time", "Defines the begin time in seconds; The simulation starts at this time");
228 
229  oc.doRegister("end", 'e', new Option_String("-1", "TIME"));
230  oc.addDescription("end", "Time", "Defines the end time in seconds; The simulation ends at this time");
231 
232  oc.doRegister("step-length", new Option_String("1", "TIME"));
233  oc.addDescription("step-length", "Time", "Defines the step duration in seconds");
234 
235  oc.doRegister("step-method.ballistic", new Option_Bool(false));
236  oc.addDescription("step-method.ballistic", "Processing", "Whether to use ballistic method for the positional update of vehicles (default is a semi-implicit Euler method).");
237 
238  oc.doRegister("lateral-resolution", new Option_Float(-1));
239  oc.addDescription("lateral-resolution", "Processing", "Defines the resolution in m when handling lateral positioning within a lane (with -1 all vehicles drive at the center of their lane");
240 
241  // register the processing options
242  oc.doRegister("route-steps", 's', new Option_String("200", "TIME"));
243  oc.addDescription("route-steps", "Processing", "Load routes for the next number of seconds ahead");
244 
245 #ifdef HAVE_INTERNAL_LANES
246  oc.doRegister("no-internal-links", new Option_Bool(false));
247  oc.addDescription("no-internal-links", "Processing", "Disable (junction) internal links");
248 
249  oc.doRegister("ignore-junction-blocker", new Option_String("-1", "TIME"));
250  oc.addDescription("ignore-junction-blocker", "Processing", "Ignore vehicles which block the junction after they have been standing for SECONDS (-1 means never ignore)");
251 #endif
252 
253  oc.doRegister("ignore-route-errors", new Option_Bool(false));
254  oc.addDescription("ignore-route-errors", "Processing", "Do not check whether routes are connected");
255 
256  oc.doRegister("ignore-accidents", new Option_Bool(false));
257  oc.addDescription("ignore-accidents", "Processing", "Do not check whether accidents occur");
258 
259  oc.doRegister("collision.action", new Option_String("teleport"));
260  oc.addDescription("collision.action", "Processing", "How to deal with collisions: [none,warn,teleport,remove]");
261 
262  oc.doRegister("collision.check-junctions", new Option_Bool(false));
263  oc.addDescription("collision.check-junctions", "Processing", "Enables collisions checks on junctions");
264 
265  oc.doRegister("max-num-vehicles", new Option_Integer(-1));
266  oc.addDescription("max-num-vehicles", "Processing", "Delay vehicle insertion to stay within the given maximum number");
267 
268  oc.doRegister("scale", new Option_Float(1.));
269  oc.addDescription("scale", "Processing", "Scale demand by the given factor (by discarding or duplicating vehicles)");
270 
271  oc.doRegister("time-to-teleport", new Option_String("300", "TIME"));
272  oc.addDescription("time-to-teleport", "Processing", "Specify how long a vehicle may wait until being teleported, defaults to 300, non-positive values disable teleporting");
273 
274  oc.doRegister("time-to-teleport.highways", new Option_String("0", "TIME"));
275  oc.addDescription("time-to-teleport.highways", "Processing", "The waiting time after which vehicles on a fast road (speed > 69m/s) are teleported if they are on a non-continuing lane");
276 
277  oc.doRegister("waiting-time-memory", new Option_String("100", "TIME"));
278  oc.addDescription("waiting-time-memory", "Processing", "Length of time interval, over which accumulated waiting time is taken into account");
279 
280  oc.doRegister("max-depart-delay", new Option_String("-1", "TIME"));
281  oc.addDescription("max-depart-delay", "Processing", "How long vehicles wait for departure before being skipped, defaults to -1 which means vehicles are never skipped");
282 
283  oc.doRegister("sloppy-insert", new Option_Bool(false));
284  oc.addDescription("sloppy-insert", "Processing", "Whether insertion on an edge shall not be repeated in same step once failed");
285 
286  oc.doRegister("eager-insert", new Option_Bool(false));
287  oc.addDescription("eager-insert", "Processing", "Whether each vehicle is checked separately for insertion on an edge");
288 
289  oc.doRegister("random-depart-offset", new Option_String("0", "TIME"));
290  oc.addDescription("random-depart-offset", "Processing", "Each vehicle receives a random offset to its depart value drawn uniformly from [0, TIME]");
291 
292  oc.doRegister("lanechange.duration", new Option_String("0", "TIME"));
293  oc.addDescription("lanechange.duration", "Processing", "Duration of a lane change maneuver (default 0)");
294 
295  oc.doRegister("lanechange.overtake-right", new Option_Bool(false));
296  oc.addDescription("lanechange.overtake-right", "Processing", "Whether overtaking on the right on motorways is permitted");
297 
298  oc.doRegister("tls.all-off", new Option_Bool(false));
299  oc.addDescription("tls.all-off", "Processing", "Switches off all traffic lights.");
300 
301  // pedestrian model
302  oc.doRegister("pedestrian.model", new Option_String("striping"));
303  oc.addDescription("pedestrian.model", "Processing", "Select among pedestrian models ['nonInteracting', 'striping']");
304 
305  oc.doRegister("pedestrian.striping.stripe-width", new Option_Float(0.65));
306  oc.addDescription("pedestrian.striping.stripe-width", "Processing", "Width of parallel stripes for segmenting a sidewalk (meters) for use with model 'striping'");
307 
308  oc.doRegister("pedestrian.striping.dawdling", new Option_Float(0.2));
309  oc.addDescription("pedestrian.striping.dawdling", "Processing", "factor for random slow-downs [0,1] for use with model 'striping'");
310 
311  oc.doRegister("pedestrian.striping.jamtime", new Option_String("300", "TIME"));
312  oc.addDescription("pedestrian.striping.jamtime", "Processing", "Time in seconds after which pedestrians start squeezing through a jam when using model 'striping' (non-positive values disable squeezing)");
313 
314  // generic routing options
315  oc.doRegister("routing-algorithm", new Option_String("dijkstra"));
316  oc.addDescription("routing-algorithm", "Routing",
317  "Select among routing algorithms ['dijkstra', 'astar', 'CH', 'CHWrapper']");
318  oc.doRegister("weights.random-factor", new Option_Float(1.));
319  oc.addDescription("weights.random-factor", "Routing", "Edge weights for routing are dynamically disturbed by a random factor drawn uniformly from [1,FLOAT)");
320 
321  // devices
322  oc.addOptionSubTopic("Emissions");
323  oc.doRegister("phemlight-path", new Option_FileName("./PHEMlight/"));
324  oc.addDescription("phemlight-path", "Emissions", "Determines where to load PHEMlight definitions from.");
325 
326  oc.addOptionSubTopic("Communication");
327  oc.addOptionSubTopic("Battery");
329 
330  // register report options
331  oc.doRegister("duration-log.disable", new Option_Bool(false));
332  oc.addSynonyme("duration-log.disable", "no-duration-log", false);
333  oc.addDescription("duration-log.disable", "Report", "Disable performance reports for individual simulation steps");
334 
335  oc.doRegister("duration-log.statistics", new Option_Bool(false));
336  oc.addDescription("duration-log.statistics", "Report", "Enable statistics on vehicle trips");
337 
338  oc.doRegister("no-step-log", new Option_Bool(false));
339  oc.addDescription("no-step-log", "Report", "Disable console output of current simulation step");
340 
341 
342 #ifndef NO_TRACI
343  //remote port 0 if not used
344  oc.addOptionSubTopic("TraCI Server");
345  oc.doRegister("remote-port", new Option_Integer(0));
346  oc.addDescription("remote-port", "TraCI Server", "Enables TraCI Server if set");
347 #ifdef HAVE_PYTHON
348  oc.doRegister("python-script", new Option_String());
349  oc.addDescription("python-script", "TraCI Server", "Runs TraCI script with embedded python");
350 #endif
351 #endif
352  //
353  oc.addOptionSubTopic("Mesoscopic");
354  oc.doRegister("mesosim", new Option_Bool(false));
355  oc.addDescription("mesosim", "Mesoscopic", "Enables mesoscopic simulation");
356  oc.doRegister("meso-edgelength", new Option_Float(98.0f));
357  oc.addDescription("meso-edgelength", "Mesoscopic", "Length of an edge segment in mesoscopic simulation");
358  oc.doRegister("meso-tauff", new Option_String("1.13", "TIME"));
359  oc.addDescription("meso-tauff", "Mesoscopic", "Factor for calculating the net free-free headway time");
360  oc.doRegister("meso-taufj", new Option_String("1.13", "TIME"));
361  oc.addDescription("meso-taufj", "Mesoscopic", "Factor for calculating the net free-jam headway time");
362  oc.doRegister("meso-taujf", new Option_String("2", "TIME"));
363  oc.addDescription("meso-taujf", "Mesoscopic", "Factor for calculating the jam-free headway time");
364  oc.doRegister("meso-taujj", new Option_String("1.4", "TIME"));
365  oc.addDescription("meso-taujj", "Mesoscopic", "Factor for calculating the jam-jam headway time");
366  oc.doRegister("meso-jam-threshold", new Option_Float(-1));
367  oc.addDescription("meso-jam-threshold", "Mesoscopic",
368  "Minimum percentage of occupied space to consider a segment jammed. A negative argument causes thresholds to be computed based on edge speed and tauff (default)");
369  oc.doRegister("meso-multi-queue", new Option_Bool(true));
370  oc.addDescription("meso-multi-queue", "Mesoscopic", "Enable multiple queues at edge ends");
371  oc.doRegister("meso-junction-control", new Option_Bool(false));
372  oc.addDescription("meso-junction-control", "Mesoscopic", "Enable mesoscopic traffic light and priority junction handling");
373  oc.doRegister("meso-junction-control.limited", new Option_Bool(false));
374  oc.addDescription("meso-junction-control.limited", "Mesoscopic",
375  "Enable mesoscopic traffic light and priority junction handling for saturated links. This prevents faulty traffic lights from hindering flow in low-traffic situations");
376  oc.doRegister("meso-tls-penalty", new Option_Float(0));
377  oc.addDescription("meso-tls-penalty", "Mesoscopic",
378  "Apply scaled time penalties when driving across tls controlled junctions based on green split instead of checking actual phases");
379  oc.doRegister("meso-overtaking", new Option_Bool(false));
380  oc.addDescription("meso-overtaking", "Mesoscopic", "Enable mesoscopic overtaking");
381  oc.doRegister("meso-recheck", new Option_String("0", "TIME"));
382  oc.addDescription("meso-recheck", "Mesoscopic", "Time interval for rechecking insertion into the next segment after failure");
383 
384  // add rand options
386 
387  // add GUI options
388  // the reason that we include them in vanilla sumo as well is to make reusing config files easy
389  oc.addOptionSubTopic("GUI Only");
390  oc.doRegister("gui-settings-file", new Option_FileName());
391  oc.addDescription("gui-settings-file", "GUI Only", "Load visualisation settings from FILE");
392 
393  oc.doRegister("quit-on-end", 'Q', new Option_Bool(false));
394  oc.addDescription("quit-on-end", "GUI Only", "Quits the GUI when the simulation stops");
395 
396  oc.doRegister("game", 'G', new Option_Bool(false));
397  oc.addDescription("game", "GUI Only", "Start the GUI in gaming mode");
398 
399  oc.doRegister("start", 'S', new Option_Bool(false));
400  oc.addDescription("start", "GUI Only", "Start the simulation after loading");
401 
402  oc.doRegister("demo", 'D', new Option_Bool(false));
403  oc.addDescription("demo", "GUI Only", "Restart the simulation after ending (demo mode)");
404 
405  oc.doRegister("disable-textures", 'T', new Option_Bool(false));
406  oc.addDescription("disable-textures", "GUI Only", "Do not load background pictures");
407 
408  oc.doRegister("window-size", new Option_String());
409  oc.addDescription("window-size", "GUI Only", "Create initial window with the given x,y size");
410 
411 #ifdef HAVE_OSG
412  oc.doRegister("osg-view", new Option_Bool(false));
413  oc.addDescription("osg-view", "GUI Only", "Start with an OpenSceneGraph view instead of the regular 2D view");
414 #endif
415 
416 }
417 
418 
419 void
421  // standard outputs
422  OutputDevice::createDeviceByOption("netstate-dump", "netstate", "netstate_file.xsd");
423  OutputDevice::createDeviceByOption("summary-output", "summary", "summary_file.xsd");
424  OutputDevice::createDeviceByOption("tripinfo-output", "tripinfos", "tripinfo_file.xsd");
425 
426  //extended
427  OutputDevice::createDeviceByOption("fcd-output", "fcd-export", "fcd_file.xsd");
428  OutputDevice::createDeviceByOption("emission-output", "emission-export", "emission_file.xsd");
429  OutputDevice::createDeviceByOption("battery-output", "battery-export");
430  OutputDevice::createDeviceByOption("full-output", "full-export", "full_file.xsd");
431  OutputDevice::createDeviceByOption("queue-output", "queue-export", "queue_file.xsd");
432  OutputDevice::createDeviceByOption("amitran-output", "trajectories", "amitran/trajectories.xsd\" timeStepSize=\"" + toString(STEPS2MS(DELTA_T)));
433 
434  //OutputDevice::createDeviceByOption("vtk-output", "vtk-export");
435  OutputDevice::createDeviceByOption("link-output", "link-output");
436  OutputDevice::createDeviceByOption("bt-output", "bt-output");
437  OutputDevice::createDeviceByOption("lanechange-output", "lanechanges");
438 
439 #ifdef _DEBUG
440  OutputDevice::createDeviceByOption("movereminder-output", "movereminder-output");
441 #endif
442 
444 }
445 
446 
447 bool
450  bool ok = true;
451  if (!oc.isSet("net-file")) {
452  WRITE_ERROR("No network file (-n) specified.");
453  ok = false;
454  }
455  if (oc.getFloat("scale") < 0.) {
456  WRITE_ERROR("Invalid scaling factor.");
457  ok = false;
458  }
459  if (oc.getBool("vehroute-output.exit-times") && !oc.isSet("vehroute-output")) {
460  WRITE_ERROR("A vehroute-output file is needed for exit times.");
461  ok = false;
462  }
463  if (oc.isSet("gui-settings-file") &&
464  oc.getString("gui-settings-file") != "" &&
465  !oc.isUsableFileList("gui-settings-file")) {
466  ok = false;
467  }
468  if (oc.getBool("demo") && oc.isDefault("start")) {
469  oc.set("start", "true");
470  }
471  if (oc.getBool("demo") && oc.getBool("quit-on-end")) {
472  WRITE_ERROR("You can either restart or quit on end.");
473  ok = false;
474  }
475  if (oc.getBool("meso-junction-control.limited") && !oc.getBool("meso-junction-control")) {
476  oc.set("meso-junction-control", "true");
477  }
478  const SUMOTime begin = string2time(oc.getString("begin"));
479  const SUMOTime end = string2time(oc.getString("end"));
480  if (begin < 0) {
481  WRITE_ERROR("The begin time should not be negative.");
482  ok = false;
483  }
484  if (end != string2time("-1")) {
485  if (end < begin) {
486  WRITE_ERROR("The end time should be after the begin time.");
487  ok = false;
488  }
489  }
490  if (string2time(oc.getString("step-length")) <= 0) {
491  WRITE_ERROR("the minimum step-length is 0.001");
492  ok = false;
493  }
494 #ifdef _DEBUG
495  if (oc.isSet("movereminder-output.vehicles") && !oc.isSet("movereminder-output")) {
496  WRITE_ERROR("option movereminder-output.vehicles requires option movereminder-output to be set");
497  ok = false;
498  }
499 #endif
500  if (oc.getBool("sloppy-insert")) {
501  WRITE_WARNING("The option 'sloppy-insert' is deprecated, because it is now activated by default, see the new option 'eager-insert'.");
502  }
503  if (string2time(oc.getString("lanechange.duration")) > 0 && oc.getFloat("lateral-resolution") > 0) {
504  WRITE_ERROR("Only one of the options 'lanechange.duration' or 'lateral-resolution' may be given.");
505  }
506  if (oc.getBool("ignore-accidents")) {
507  WRITE_WARNING("The option 'ignore-accidents' is deprecated. Use 'collision.action none' instead.");
508  }
509  if (oc.getBool("duration-log.statistics") && oc.isDefault("verbose")) {
510  oc.set("verbose", "true");
511  }
512  ok &= MSDevice::checkOptions(oc);
513  return ok;
514 }
515 
516 
517 void
519  // pre-initialise the network
520  // set whether empty edges shall be printed on dump
521  MSGlobals::gOmitEmptyEdgesOnDump = !oc.getBool("netstate-dump.empty-edges");
522 #ifdef HAVE_INTERNAL_LANES
523  // set whether internal lanes shall be used
524  MSGlobals::gUsingInternalLanes = !oc.getBool("no-internal-links");
525  MSGlobals::gIgnoreJunctionBlocker = string2time(oc.getString("ignore-junction-blocker")) < 0 ?
526  std::numeric_limits<SUMOTime>::max() : string2time(oc.getString("ignore-junction-blocker"));
527 #else
530 #endif
531  // set the grid lock time
532  MSGlobals::gTimeToGridlock = string2time(oc.getString("time-to-teleport")) < 0 ? 0 : string2time(oc.getString("time-to-teleport"));
533  MSGlobals::gTimeToGridlockHighways = string2time(oc.getString("time-to-teleport.highways")) < 0 ? 0 : string2time(oc.getString("time-to-teleport.highways"));
534  MSGlobals::gCheck4Accidents = !oc.getBool("ignore-accidents");
535  MSGlobals::gCheckRoutes = !oc.getBool("ignore-route-errors");
536  MSGlobals::gLaneChangeDuration = string2time(oc.getString("lanechange.duration"));
537  MSGlobals::gLateralResolution = oc.getFloat("lateral-resolution");
538  MSGlobals::gStateLoaded = oc.isSet("load-state");
539  MSGlobals::gUseMesoSim = oc.getBool("mesosim");
540  MSGlobals::gMesoLimitedJunctionControl = oc.getBool("meso-junction-control.limited");
541  MSGlobals::gMesoOvertaking = oc.getBool("meso-overtaking");
542  MSGlobals::gMesoTLSPenalty = oc.getFloat("meso-tls-penalty");
543  MSGlobals::gSemiImplicitEulerUpdate = !oc.getBool("step-method.ballistic");
545  MSGlobals::gUsingInternalLanes = false;
546  }
547  MSGlobals::gWaitingTimeMemory = string2time(oc.getString("waiting-time-memory"));
550 
551  DELTA_T = string2time(oc.getString("step-length"));
552 #ifdef _DEBUG
553  if (oc.isSet("movereminder-output")) {
554  MSBaseVehicle::initMoveReminderOutput(oc);
555  }
556 #endif
557 }
558 
559 
560 
561 /****************************************************************************/
562 
static bool gOmitEmptyEdgesOnDump
Information whether empty edges shall be written on dump.
Definition: MSGlobals.h:59
void doRegister(const std::string &name, Option *v)
Adds an option under the given name.
Definition: OptionsCont.cpp:86
static void insertRandOptions()
Initialises the given options container with random number options.
Definition: RandHelper.cpp:53
long long int SUMOTime
Definition: SUMOTime.h:43
static void addReportOptions(OptionsCont &oc)
Adds reporting options to the given container.
Definition: SystemFrame.cpp:75
static void buildStreams()
Builds the streams used possibly by the simulation.
Definition: MSFrame.cpp:420
void addCallExample(const std::string &example, const std::string &desc)
Add a call example.
static bool gStateLoaded
Information whether a state has been loaded.
Definition: MSGlobals.h:92
SUMOTime DELTA_T
Definition: SUMOTime.cpp:39
static void initCollisionOptions(const OptionsCont &oc)
Definition: MSLane.cpp:2585
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.
static bool gMesoOvertaking
Definition: MSGlobals.h:101
static void addConfigurationOptions(OptionsCont &oc)
Adds configuration options to the given container.
Definition: SystemFrame.cpp:50
#define WRITE_WARNING(msg)
Definition: MsgHandler.h:200
static OptionsCont & getOptions()
Retrieves the options.
Definition: OptionsCont.cpp:69
static bool gCheck4Accidents
Definition: MSGlobals.h:80
#define OUTPUT_ACCURACY
Definition: config.h:163
static void fillOptions()
Inserts options used by the simulation into the OptionsCont-singleton.
Definition: MSFrame.cpp:69
void addSynonyme(const std::string &name1, const std::string &name2, bool isDeprecated=false)
Adds a synonyme for an options name (any order)
static void init()
Static intialization.
bool isSet(const std::string &name, bool failOnNonExistant=true) const
Returns the information whether the named option is set.
#define max(a, b)
Definition: polyfonts.c:65
std::vector< int > IntVector
Definition of a vector of ints.
Definition: Option.h:48
bool isUsableFileList(const std::string &name) const
Checks whether the named option is usable as a file list (with at least a single file) ...
static bool gCheckRoutes
Definition: MSGlobals.h:83
std::string getString(const std::string &name) const
Returns the string-value of the named option (only for Option_String)
SUMOTime string2time(const std::string &r)
Definition: SUMOTime.cpp:46
void addOptionSubTopic(const std::string &topic)
Adds an option subtopic.
static bool gUsingInternalLanes
Information whether the simulation regards internal lanes.
Definition: MSGlobals.h:73
static void initGlobalOptions(const OptionsCont &oc)
init global model parameters
std::string toString(const T &t, std::streamsize accuracy=OUTPUT_ACCURACY)
Definition: ToString.h:55
static bool checkOptions(OptionsCont &oc)
check device-specific options
Definition: MSDevice.cpp:73
static bool checkOptions()
Checks the set options.
Definition: MSFrame.cpp:448
#define WRITE_ERROR(msg)
Definition: MsgHandler.h:206
static SUMOTime gTimeToGridlockHighways
Definition: MSGlobals.h:70
bool set(const std::string &name, const std::string &value)
Sets the given value for the named option.
An integer-option.
Definition: Option.h:313
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:99
static SUMOReal gLateralResolution
Definition: MSGlobals.h:89
static SUMOTime gTimeToGridlock
Definition: MSGlobals.h:67
static void insertOptions(OptionsCont &oc)
Inserts options for building devices.
Definition: MSDevice.cpp:62
static SUMOTime gWaitingTimeMemory
length of memory for waiting times (in millisecs)
Definition: MSGlobals.h:110
static SUMOTime gIgnoreJunctionBlocker
Definition: MSGlobals.h:77
static bool createDeviceByOption(const std::string &optionName, const std::string &rootElement="", const std::string &schemaFile="")
Creates the device using the output definition stored in the named option.
static bool gSemiImplicitEulerUpdate
Definition: MSGlobals.h:63
static void setMSGlobals(OptionsCont &oc)
Sets the global microsim-options.
Definition: MSFrame.cpp:518
void addDescription(const std::string &name, const std::string &subtopic, const std::string &description)
Adds a description for an option.
static SUMOReal gMesoTLSPenalty
Definition: MSGlobals.h:104
static SUMOTime gLaneChangeDuration
Definition: MSGlobals.h:86
static bool gUseMesoSim
Definition: MSGlobals.h:95
static bool gMesoLimitedJunctionControl
Definition: MSGlobals.h:98
#define STEPS2MS(x)
Definition: SUMOTime.h:68
SUMOReal getFloat(const std::string &name) const
Returns the SUMOReal-value of the named option (only for Option_Float)