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