Eclipse SUMO - Simulation of Urban MObility
MSFrame.cpp
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2002-2022 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials are made available under the
5 // terms of the Eclipse Public License 2.0 which is available at
6 // https://www.eclipse.org/legal/epl-2.0/
7 // This Source Code may also be made available under the following Secondary
8 // Licenses when the conditions for such availability set forth in the Eclipse
9 // Public License 2.0 are satisfied: GNU General Public License, version 2
10 // or later which is available at
11 // https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
12 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
13 /****************************************************************************/
24 // Sets and checks options for microsim; inits global outputs and settings
25 /****************************************************************************/
26 #include <config.h>
27 
28 #include <iostream>
29 #include <iomanip>
30 #include <fstream>
31 #include <ctime>
33 #include <utils/options/Option.h>
36 #include <utils/common/ToString.h>
41 #include <microsim/MSBaseVehicle.h>
42 #include <microsim/MSJunction.h>
43 #include <microsim/MSRoute.h>
44 #include <microsim/MSNet.h>
45 #include <microsim/MSLane.h>
46 #include <microsim/MSGlobals.h>
52 #include "MSFrame.h"
54 
55 
56 // ===========================================================================
57 // method definitions
58 // ===========================================================================
59 void
62  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");
63  oc.addCallExample("-c munich_config.cfg", "start with a configuration file");
64  oc.addCallExample("--help", "print help");
65 
66  // insert options sub-topics
67  SystemFrame::addConfigurationOptions(oc); // fill this subtopic, too
68  oc.addOptionSubTopic("Input");
69  oc.addOptionSubTopic("Output");
70  oc.addOptionSubTopic("Time");
71  oc.addOptionSubTopic("Processing");
72  oc.addOptionSubTopic("Routing");
73 
74  // register configuration options
75  // register input options
76  oc.doRegister("net-file", 'n', new Option_FileName());
77  oc.addSynonyme("net-file", "net");
78  oc.addDescription("net-file", "Input", "Load road network description from FILE");
79  oc.addXMLDefault("net-file", "net");
80 
81  oc.doRegister("route-files", 'r', new Option_FileName());
82  oc.addSynonyme("route-files", "routes");
83  oc.addDescription("route-files", "Input", "Load routes descriptions from FILE(s)");
84 
85  oc.doRegister("additional-files", 'a', new Option_FileName());
86  oc.addSynonyme("additional-files", "additional");
87  oc.addDescription("additional-files", "Input", "Load further descriptions from FILE(s)");
88 
89  oc.doRegister("weight-files", 'w', new Option_FileName());
90  oc.addSynonyme("weight-files", "weights");
91  oc.addDescription("weight-files", "Input", "Load edge/lane weights for online rerouting from FILE");
92  oc.doRegister("weight-attribute", 'x', new Option_String("traveltime"));
93  oc.addSynonyme("weight-attribute", "measure", true);
94  oc.addDescription("weight-attribute", "Input", "Name of the xml attribute which gives the edge weight");
95 
96  oc.doRegister("load-state", new Option_FileName());
97  oc.addDescription("load-state", "Input", "Loads a network state from FILE");
98  oc.doRegister("load-state.offset", new Option_String("0", "TIME"));
99  oc.addDescription("load-state.offset", "Input", "Shifts all times loaded from a saved state by the given offset");
100  oc.doRegister("load-state.remove-vehicles", new Option_StringVector(StringVector({""})));
101  oc.addDescription("load-state.remove-vehicles", "Input", "Removes vehicles with the given IDs from the loaded state");
102 
103  oc.doRegister("junction-taz", new Option_Bool(false));
104  oc.addDescription("junction-taz", "Input", "Initialize a TAZ for every junction to use attributes toJunction and fromJunction");
105 
106  // need to do this here to be able to check for network and route input options
108 
109  // register output options
110  oc.doRegister("netstate-dump", new Option_FileName());
111  oc.addSynonyme("netstate-dump", "ndump");
112  oc.addSynonyme("netstate-dump", "netstate");
113  oc.addSynonyme("netstate-dump", "netstate-output");
114  oc.addDescription("netstate-dump", "Output", "Save complete network states into FILE");
115  oc.doRegister("netstate-dump.empty-edges", new Option_Bool(false));
116  oc.addSynonyme("netstate-dump.empty-edges", "netstate.empty-edges");
117  oc.addSynonyme("netstate-dump.empty-edges", "netstate-output.empty-edges");
118  oc.addSynonyme("netstate-dump.empty-edges", "dump-empty-edges", true);
119  oc.addDescription("netstate-dump.empty-edges", "Output", "Write also empty edges completely when dumping");
120  oc.doRegister("netstate-dump.precision", new Option_Integer(2));
121  oc.addSynonyme("netstate-dump.precision", "netstate.precision");
122  oc.addSynonyme("netstate-dump.precision", "netstate-output.precision");
123  oc.addSynonyme("netstate-dump.precision", "dump-precision", true);
124  oc.addDescription("netstate-dump.precision", "Output", "Write positions and speeds with the given precision (default 2)");
125 
126 
127  oc.doRegister("emission-output", new Option_FileName());
128  oc.addDescription("emission-output", "Output", "Save the emission values of each vehicle");
129  oc.doRegister("emission-output.precision", new Option_Integer(2));
130  oc.addDescription("emission-output.precision", "Output", "Write emission values with the given precision (default 2)");
131 
132  oc.doRegister("emission-output.step-scaled", new Option_Bool(false));
133  oc.addDescription("emission-output.step-scaled", "Output", "Write emission values scaled to the step length rather than as per-second values");
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(2));
138  oc.addDescription("battery-output.precision", "Output", "Write battery values with the given precision (default 2)");
139 
140  oc.doRegister("elechybrid-output", new Option_FileName());
141  oc.addDescription("elechybrid-output", "Output", "Save the elecHybrid values of each vehicle");
142  oc.doRegister("elechybrid-output.precision", new Option_Integer(2));
143  oc.addDescription("elechybrid-output.precision", "Output", "Write elecHybrid values with the given precision (default 2)");
144  oc.doRegister("elechybrid-output.aggregated", new Option_Bool(false));
145  oc.addDescription("elechybrid-output.aggregated", "Output", "Write elecHybrid values into one aggregated file");
146 
147  oc.doRegister("chargingstations-output", new Option_FileName());
148  oc.addDescription("chargingstations-output", "Output", "Write data of charging stations");
149 
150  oc.doRegister("overheadwiresegments-output", new Option_FileName());
151  oc.addDescription("overheadwiresegments-output", "Output", "Write data of overhead wire segments");
152 
153  oc.doRegister("substations-output", new Option_FileName());
154  oc.addDescription("substations-output", "Output", "Write data of electrical substation stations");
155  oc.doRegister("substations-output.precision", new Option_Integer(2));
156  oc.addDescription("substations-output.precision", "Output", "Write substation values with the given precision (default 2)");
157 
158  oc.doRegister("fcd-output", new Option_FileName());
159  oc.addDescription("fcd-output", "Output", "Save the Floating Car Data");
160  oc.doRegister("fcd-output.geo", new Option_Bool(false));
161  oc.addDescription("fcd-output.geo", "Output", "Save the Floating Car Data using geo-coordinates (lon/lat)");
162  oc.doRegister("fcd-output.signals", new Option_Bool(false));
163  oc.addDescription("fcd-output.signals", "Output", "Add the vehicle signal state to the FCD output (brake lights etc.)");
164  oc.doRegister("fcd-output.distance", new Option_Bool(false));
165  oc.addDescription("fcd-output.distance", "Output", "Add kilometrage to the FCD output (linear referencing)");
166  oc.doRegister("fcd-output.acceleration", new Option_Bool(false));
167  oc.addDescription("fcd-output.acceleration", "Output", "Add acceleration to the FCD output");
168  oc.doRegister("fcd-output.max-leader-distance", new Option_Float(-1));
169  oc.addDescription("fcd-output.max-leader-distance", "Output", "Add leader vehicle information to the FCD output (within the given distance)");
170  oc.doRegister("fcd-output.params", new Option_StringVector());
171  oc.addDescription("fcd-output.params", "Output", "Add generic parameter values to the FCD output");
172  oc.doRegister("fcd-output.filter-edges.input-file", new Option_FileName());
173  oc.addDescription("fcd-output.filter-edges.input-file", "Output", "Restrict fcd output to the edge selection from the given input file");
174  oc.doRegister("fcd-output.attributes", new Option_StringVector());
175  oc.addDescription("fcd-output.attributes", "Output", "List attributes that should be included in the FCD output");
176 
177  oc.doRegister("device.ssm.filter-edges.input-file", new Option_FileName());
178  oc.addDescription("device.ssm.filter-edges.input-file", "Output", "Restrict SSM device output to the edge selection from the given input file");
179 
180  oc.doRegister("full-output", new Option_FileName());
181  oc.addDescription("full-output", "Output", "Save a lot of information for each timestep (very redundant)");
182 
183  oc.doRegister("queue-output", new Option_FileName());
184  oc.addDescription("queue-output", "Output", "Save the vehicle queues at the junctions (experimental)");
185  oc.doRegister("queue-output.period", new Option_String("-1", "TIME"));
186  oc.addDescription("queue-output.period", "Output", "Save vehicle queues with the given period");
187 
188  oc.doRegister("vtk-output", new Option_FileName());
189  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)");
190  oc.doRegister("amitran-output", new Option_FileName());
191  oc.addDescription("amitran-output", "Output", "Save the vehicle trajectories in the Amitran format");
192 
193 
194  oc.doRegister("summary-output", new Option_FileName());
195  oc.addSynonyme("summary-output", "summary");
196  oc.addDescription("summary-output", "Output", "Save aggregated vehicle departure info into FILE");
197 
198  oc.doRegister("person-summary-output", new Option_FileName());
199  oc.addDescription("person-summary-output", "Output", "Save aggregated person counts into FILE");
200 
201  oc.doRegister("tripinfo-output", new Option_FileName());
202  oc.addSynonyme("tripinfo-output", "tripinfo");
203  oc.addDescription("tripinfo-output", "Output", "Save single vehicle trip info into FILE");
204 
205  oc.doRegister("tripinfo-output.write-unfinished", new Option_Bool(false));
206  oc.addDescription("tripinfo-output.write-unfinished", "Output", "Write tripinfo output for vehicles which have not arrived at simulation end");
207 
208  oc.doRegister("tripinfo-output.write-undeparted", new Option_Bool(false));
209  oc.addDescription("tripinfo-output.write-undeparted", "Output", "Write tripinfo output for vehicles which have not departed at simulation end because of depart delay");
210 
211  oc.doRegister("vehroute-output", new Option_FileName());
212  oc.addSynonyme("vehroute-output", "vehroutes");
213  oc.addDescription("vehroute-output", "Output", "Save single vehicle route info into FILE");
214 
215  oc.doRegister("vehroute-output.exit-times", new Option_Bool(false));
216  oc.addSynonyme("vehroute-output.exit-times", "vehroutes.exit-times");
217  oc.addDescription("vehroute-output.exit-times", "Output", "Write the exit times for all edges");
218 
219  oc.doRegister("vehroute-output.last-route", new Option_Bool(false));
220  oc.addSynonyme("vehroute-output.last-route", "vehroutes.last-route");
221  oc.addDescription("vehroute-output.last-route", "Output", "Write the last route only");
222 
223  oc.doRegister("vehroute-output.sorted", new Option_Bool(false));
224  oc.addSynonyme("vehroute-output.sorted", "vehroutes.sorted");
225  oc.addDescription("vehroute-output.sorted", "Output", "Sorts the output by departure time");
226 
227  oc.doRegister("vehroute-output.dua", new Option_Bool(false));
228  oc.addSynonyme("vehroute-output.dua", "vehroutes.dua");
229  oc.addDescription("vehroute-output.dua", "Output", "Write the output in the duarouter alternatives style");
230 
231  oc.doRegister("vehroute-output.cost", new Option_Bool(false));
232  oc.addDescription("vehroute-output.cost", "Output", "Write costs for all routes");
233 
234  oc.doRegister("vehroute-output.intended-depart", new Option_Bool(false));
235  oc.addSynonyme("vehroute-output.intended-depart", "vehroutes.intended-depart");
236  oc.addDescription("vehroute-output.intended-depart", "Output", "Write the output with the intended instead of the real departure time");
237 
238  oc.doRegister("vehroute-output.route-length", new Option_Bool(false));
239  oc.addSynonyme("vehroute-output.route-length", "vehroutes.route-length");
240  oc.addDescription("vehroute-output.route-length", "Output", "Include total route length in the output");
241 
242  oc.doRegister("vehroute-output.write-unfinished", new Option_Bool(false));
243  oc.addDescription("vehroute-output.write-unfinished", "Output", "Write vehroute output for vehicles which have not arrived at simulation end");
244 
245  oc.doRegister("vehroute-output.skip-ptlines", new Option_Bool(false));
246  oc.addDescription("vehroute-output.skip-ptlines", "Output", "Skip vehroute output for public transport vehicles");
247 
248  oc.doRegister("vehroute-output.incomplete", new Option_Bool(false));
249  oc.addDescription("vehroute-output.incomplete", "Output", "Include invalid routes and route stubs in vehroute output");
250 
251  oc.doRegister("vehroute-output.stop-edges", new Option_Bool(false));
252  oc.addDescription("vehroute-output.stop-edges", "Output", "Include information about edges between stops");
253 
254  oc.doRegister("vehroute-output.speedfactor", new Option_Bool(false));
255  oc.addDescription("vehroute-output.speedfactor", "Output", "Write the vehicle speedFactor (defaults to 'true' if departSpeed is written)");
256 
257  oc.doRegister("link-output", new Option_FileName());
258  oc.addDescription("link-output", "Output", "Save links states into FILE");
259 
260  oc.doRegister("railsignal-block-output", new Option_FileName());
261  oc.addDescription("railsignal-block-output", "Output", "Save railsignal-blocks into FILE");
262 
263  oc.doRegister("bt-output", new Option_FileName());
264  oc.addDescription("bt-output", "Output", "Save bluetooth visibilities into FILE (in conjunction with device.btreceiver and device.btsender)");
265 
266  oc.doRegister("lanechange-output", new Option_FileName());
267  oc.addDescription("lanechange-output", "Output", "Record lane changes and their motivations for all vehicles into FILE");
268 
269  oc.doRegister("lanechange-output.started", new Option_Bool(false));
270  oc.addDescription("lanechange-output.started", "Output", "Record start of lane change manoeuvres");
271 
272  oc.doRegister("lanechange-output.ended", new Option_Bool(false));
273  oc.addDescription("lanechange-output.ended", "Output", "Record end of lane change manoeuvres");
274 
275  oc.doRegister("lanechange-output.xy", new Option_Bool(false));
276  oc.addDescription("lanechange-output.xy", "Output", "Record coordinates of lane change manoeuvres");
277 
278  oc.doRegister("stop-output", new Option_FileName());
279  oc.addDescription("stop-output", "Output", "Record stops and loading/unloading of passenger and containers for all vehicles into FILE");
280  oc.doRegister("stop-output.write-unfinished", new Option_Bool(false));
281  oc.addDescription("stop-output.write-unfinished", "Output", "Write stop output for stops which have not ended at simulation end");
282 
283  oc.doRegister("collision-output", new Option_FileName());
284  oc.addDescription("collision-output", "Output", "Write collision information into FILE");
285 
286  oc.doRegister("statistic-output", new Option_FileName());
287  oc.addSynonyme("statistic-output", "statistics-output");
288  oc.addDescription("statistic-output", "Output", "Write overall statistics into FILE");
289 
290 #ifdef _DEBUG
291  oc.doRegister("movereminder-output", new Option_FileName());
292  oc.addDescription("movereminder-output", "Output", "Save movereminder states of selected vehicles into FILE");
293  oc.doRegister("movereminder-output.vehicles", new Option_StringVector());
294  oc.addDescription("movereminder-output.vehicles", "Output", "List of vehicle ids which shall save their movereminder states");
295 #endif
296 
297  oc.doRegister("save-state.times", new Option_StringVector());
298  oc.addDescription("save-state.times", "Output", "Use TIME[] as times at which a network state written");
299  oc.doRegister("save-state.period", new Option_String("-1", "TIME"));
300  oc.addDescription("save-state.period", "Output", "save state repeatedly after TIME period");
301  oc.doRegister("save-state.period.keep", new Option_Integer(0));
302  oc.addDescription("save-state.period.keep", "Output", "Keep only the last INT periodic state files");
303  oc.doRegister("save-state.prefix", new Option_FileName(StringVector({ "state" })));
304  oc.addDescription("save-state.prefix", "Output", "Prefix for network states");
305  oc.doRegister("save-state.suffix", new Option_String(".xml.gz"));
306  oc.addDescription("save-state.suffix", "Output", "Suffix for network states (.xml.gz or .xml)");
307  oc.doRegister("save-state.files", new Option_FileName());
308  oc.addDescription("save-state.files", "Output", "Files for network states");
309  oc.doRegister("save-state.rng", new Option_Bool(false));
310  oc.addDescription("save-state.rng", "Output", "Save random number generator states");
311  oc.doRegister("save-state.transportables", new Option_Bool(false));
312  oc.addDescription("save-state.transportables", "Output", "Save person and container states (experimental)");
313  oc.doRegister("save-state.constraints", new Option_Bool(false));
314  oc.addDescription("save-state.constraints", "Output", "Save rail signal constraints");
315  oc.doRegister("save-state.precision", new Option_Integer(2));
316  oc.addDescription("save-state.precision", "Output", "Write internal state values with the given precision (default 2)");
317 
318  // register the simulation settings
319  oc.doRegister("begin", 'b', new Option_String("0", "TIME"));
320  oc.addDescription("begin", "Time", "Defines the begin time in seconds; The simulation starts at this time");
321 
322  oc.doRegister("end", 'e', new Option_String("-1", "TIME"));
323  oc.addDescription("end", "Time", "Defines the end time in seconds; The simulation ends at this time");
324 
325  oc.doRegister("step-length", new Option_String("1", "TIME"));
326  oc.addDescription("step-length", "Time", "Defines the step duration in seconds");
327 
328  oc.doRegister("step-method.ballistic", new Option_Bool(false));
329  oc.addDescription("step-method.ballistic", "Processing", "Whether to use ballistic method for the positional update of vehicles (default is a semi-implicit Euler method).");
330 
331  oc.doRegister("extrapolate-departpos", new Option_Bool(false));
332  oc.addDescription("extrapolate-departpos", "Processing", "Whether vehicles that depart between simulation steps should extrapolate the depart position");
333 
334  oc.doRegister("threads", new Option_Integer(1));
335  oc.addDescription("threads", "Processing", "Defines the number of threads for parallel simulation");
336 
337  oc.doRegister("lateral-resolution", new Option_Float(-1));
338  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");
339 
340  // register the processing options
341  oc.doRegister("route-steps", 's', new Option_String("200", "TIME"));
342  oc.addDescription("route-steps", "Processing", "Load routes for the next number of seconds ahead");
343 
344  oc.doRegister("no-internal-links", new Option_Bool(false));
345  oc.addDescription("no-internal-links", "Processing", "Disable (junction) internal links");
346 
347  oc.doRegister("ignore-junction-blocker", new Option_String("-1", "TIME"));
348  oc.addDescription("ignore-junction-blocker", "Processing", "Ignore vehicles which block the junction after they have been standing for SECONDS (-1 means never ignore)");
349 
350  oc.doRegister("ignore-route-errors", new Option_Bool(false));
351  oc.addDescription("ignore-route-errors", "Processing", "(1) Do not check whether routes are connected. (2) Allow inserting a vehicle in a situation which requires emergency braking.");
352 
353  oc.doRegister("ignore-accidents", new Option_Bool(false));
354  oc.addDescription("ignore-accidents", "Processing", "Do not check whether accidents occur");
355 
356  oc.doRegister("collision.action", new Option_String("teleport"));
357  oc.addDescription("collision.action", "Processing", "How to deal with collisions: [none,warn,teleport,remove]");
358 
359  oc.doRegister("collision.stoptime", new Option_String("0", "TIME"));
360  oc.addDescription("collision.stoptime", "Processing", "Let vehicle stop for TIME before performing collision.action (except for action 'none')");
361 
362  oc.doRegister("collision.check-junctions", new Option_Bool(false));
363  oc.addDescription("collision.check-junctions", "Processing", "Enables collisions checks on junctions");
364 
365  oc.doRegister("collision.check-junctions.mingap", new Option_Float(0));
366  oc.addDescription("collision.check-junctions.mingap", "Processing", "Increase or decrease sensitivity for junction collision check");
367 
368  oc.doRegister("collision.mingap-factor", new Option_Float(-1));
369  oc.addDescription("collision.mingap-factor", "Processing", "Sets the fraction of minGap that must be maintained to avoid collision detection. If a negative value is given, the carFollowModel parameter is used");
370 
371  oc.doRegister("max-num-vehicles", new Option_Integer(-1));
372  oc.addDescription("max-num-vehicles", "Processing", "Delay vehicle insertion to stay within the given maximum number");
373 
374  oc.doRegister("max-num-teleports", new Option_Integer(-1));
375  oc.addDescription("max-num-teleports", "Processing", "Abort the simulation if the given maximum number of teleports is exceeded");
376 
377  oc.doRegister("scale", new Option_Float(1.));
378  oc.addDescription("scale", "Processing", "Scale demand by the given factor (by discarding or duplicating vehicles)");
379 
380  oc.doRegister("scale-suffix", new Option_String("."));
381  oc.addDescription("scale-suffix", "Processing", "Suffix to be added when creating ids for cloned vehicles");
382 
383  oc.doRegister("time-to-teleport", new Option_String("300", "TIME"));
384  oc.addDescription("time-to-teleport", "Processing", "Specify how long a vehicle may wait until being teleported, defaults to 300, non-positive values disable teleporting");
385 
386  oc.doRegister("time-to-teleport.highways", new Option_String("0", "TIME"));
387  oc.addDescription("time-to-teleport.highways", "Processing", "The waiting time after which vehicles on a fast road (speed > 69km/h) are teleported if they are on a non-continuing lane");
388 
389  oc.doRegister("time-to-teleport.disconnected", new Option_String("-1", "TIME"));
390  oc.addDescription("time-to-teleport.disconnected", "Processing", "The waiting time after which vehicles with a disconnected route are teleported. Negative values disable teleporting");
391 
392  oc.doRegister("time-to-teleport.remove", new Option_Bool(false));
393  oc.addDescription("time-to-teleport.remove", "Processing", "Whether vehicles shall be removed after waiting too long instead of being teleported");
394 
395  oc.doRegister("waiting-time-memory", new Option_String("100", "TIME"));
396  oc.addDescription("waiting-time-memory", "Processing", "Length of time interval, over which accumulated waiting time is taken into account (default is 100s.)");
397 
398  oc.doRegister("max-depart-delay", new Option_String("-1", "TIME"));
399  oc.addDescription("max-depart-delay", "Processing", "How long vehicles wait for departure before being skipped, defaults to -1 which means vehicles are never skipped");
400 
401  oc.doRegister("sloppy-insert", new Option_Bool(false));
402  oc.addDescription("sloppy-insert", "Processing", "Whether insertion on an edge shall not be repeated in same step once failed");
403 
404  oc.doRegister("eager-insert", new Option_Bool(false));
405  oc.addDescription("eager-insert", "Processing", "Whether each vehicle is checked separately for insertion on an edge");
406 
407  oc.doRegister("random-depart-offset", new Option_String("0", "TIME"));
408  oc.addDescription("random-depart-offset", "Processing", "Each vehicle receives a random offset to its depart value drawn uniformly from [0, TIME]");
409 
410  oc.doRegister("lanechange.duration", new Option_String("0", "TIME"));
411  oc.addDescription("lanechange.duration", "Processing", "Duration of a lane change maneuver (default 0)");
412 
413  oc.doRegister("lanechange.overtake-right", new Option_Bool(false));
414  oc.addDescription("lanechange.overtake-right", "Processing", "Whether overtaking on the right on motorways is permitted");
415 
416  oc.doRegister("tls.all-off", new Option_Bool(false));
417  oc.addDescription("tls.all-off", "Processing", "Switches off all traffic lights.");
418 
419  oc.doRegister("tls.actuated.show-detectors", new Option_Bool(false));
420  oc.addDescription("tls.actuated.show-detectors", "Processing", "Sets default visibility for actuation detectors");
421 
422  oc.doRegister("tls.delay_based.detector-range", new Option_Float(100));
423  oc.addDescription("tls.delay_based.detector-range", "Processing", "Sets default range for detecting delayed vehicles");
424 
425  oc.doRegister("tls.yellow.min-decel", new Option_Float(3.0));
426  oc.addDescription("tls.yellow.min-decel", "Processing", "Minimum deceleration when braking at yellow");
427 
428  oc.doRegister("railsignal-moving-block", new Option_Bool(false));
429  oc.addDescription("railsignal-moving-block", "Processing", "Let railsignals operate in moving-block mode by default");
430 
431  oc.doRegister("time-to-impatience", new Option_String("300", "TIME"));
432  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");
433 
434  oc.doRegister("default.action-step-length", new Option_Float(0.0));
435  oc.addDescription("default.action-step-length", "Processing", "Length of the default interval length between action points for the car-following and lane-change models (in seconds). If not specified, the simulation step-length is used per default. Vehicle- or VType-specific settings override the default. Must be a multiple of the simulation step-length.");
436 
437  oc.doRegister("default.carfollowmodel", new Option_String("Krauss"));
438  oc.addDescription("default.carfollowmodel", "Processing", "Select default car following model (Krauss, IDM, ...)");
439  oc.addSynonyme("default.carfollowmodel", "carfollow.model");
440 
441  oc.doRegister("default.speeddev", new Option_Float(-1));
442  oc.addDescription("default.speeddev", "Processing", "Select default speed deviation. A negative value implies vClass specific defaults (0.1 for the default passenger class");
443 
444  oc.doRegister("default.emergencydecel", new Option_String("default"));
445  oc.addDescription("default.emergencydecel", "Processing", "Select default emergencyDecel value among ('decel', 'default', FLOAT) which sets the value either to the same as the deceleration value, a vClass-class specific default or the given FLOAT in m/s^2");
446 
447  oc.doRegister("overhead-wire.solver", new Option_Bool(true));
448  oc.addDescription("overhead-wire.solver", "Processing", "Use Kirchhoff's laws for solving overhead wire circuit");
449 
450  oc.doRegister("overhead-wire.recuperation", new Option_Bool(true));
451  oc.addDescription("overhead-wire.recuperation", "Processing", "Enable recuperation from the vehicle equipped with elecHybrid device into the ovrehead wire.");
452 
453  oc.doRegister("overhead-wire.substation-current-limits", new Option_Bool(true));
454  oc.addDescription("overhead-wire.substation-current-limits", "Processing", "Enable current limits of traction substation during solving the overhead wire electrical circuit.");
455 
456  oc.doRegister("emergencydecel.warning-threshold", new Option_Float(1));
457  oc.addDescription("emergencydecel.warning-threshold", "Processing", "Sets the fraction of emergency decel capability that must be used to trigger a warning.");
458 
459  oc.doRegister("parking.maneuver", new Option_Bool(false));
460  oc.addDescription("parking.maneuver", "Processing", "Whether parking simulation includes manoeuvering time and associated lane blocking");
461 
462  oc.doRegister("use-stop-ended", new Option_Bool(false));
463  oc.addDescription("use-stop-ended", "Processing", "Override stop until times with stop ended times when given");
464 
465  // pedestrian model
466  oc.doRegister("pedestrian.model", new Option_String("striping"));
467  oc.addDescription("pedestrian.model", "Processing", "Select among pedestrian models ['nonInteracting', 'striping', 'remote']");
468 
469  oc.doRegister("pedestrian.striping.stripe-width", new Option_Float(0.64));
470  oc.addDescription("pedestrian.striping.stripe-width", "Processing", "Width of parallel stripes for segmenting a sidewalk (meters) for use with model 'striping'");
471 
472  oc.doRegister("pedestrian.striping.dawdling", new Option_Float(0.2));
473  oc.addDescription("pedestrian.striping.dawdling", "Processing", "Factor for random slow-downs [0,1] for use with model 'striping'");
474 
475  oc.doRegister("pedestrian.striping.mingap-to-vehicle", new Option_Float(0.25));
476  oc.addDescription("pedestrian.striping.mingap-to-vehicle", "Processing", "Minimal gap / safety buffer (in meters) from a pedestrian to another vehicle for use with model 'striping'");
477 
478  oc.doRegister("pedestrian.striping.jamtime", new Option_String("300", "TIME"));
479  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)");
480  oc.doRegister("pedestrian.striping.jamtime.crossing", new Option_String("10", "TIME"));
481  oc.addDescription("pedestrian.striping.jamtime.crossing", "Processing", "Time in seconds after which pedestrians start squeezing through a jam while on a pedestrian crossing when using model 'striping' (non-positive values disable squeezing)");
482  oc.doRegister("pedestrian.striping.jamtime.narrow", new Option_String("1", "TIME"));
483  oc.addDescription("pedestrian.striping.jamtime.narrow", "Processing", "Time in seconds after which pedestrians start squeezing through a jam while on a narrow lane when using model 'striping'");
484 
485  oc.doRegister("pedestrian.striping.reserve-oncoming", new Option_Float(0.0));
486  oc.addDescription("pedestrian.striping.reserve-oncoming", "Processing", "Fraction of stripes to reserve for oncoming pedestrians");
487 
488  oc.doRegister("pedestrian.striping.reserve-oncoming.junctions", new Option_Float(0.34));
489  oc.addDescription("pedestrian.striping.reserve-oncoming.junctions", "Processing", "Fraction of stripes to reserve for oncoming pedestrians on crossings and walkingareas");
490 
491  oc.doRegister("pedestrian.remote.address", new Option_String("localhost:9000"));
492  oc.addDescription("pedestrian.remote.address", "Processing", "The address (host:port) of the external simulation");
493 
494  oc.doRegister("ride.stop-tolerance", new Option_Float(10.));
495  oc.addDescription("ride.stop-tolerance", "Processing", "Tolerance to apply when matching pedestrian and vehicle positions on boarding at individual stops");
496 
497  // generic routing options
498  oc.doRegister("routing-algorithm", new Option_String("dijkstra"));
499  oc.addDescription("routing-algorithm", "Routing",
500  "Select among routing algorithms ['dijkstra', 'astar', 'CH', 'CHWrapper']");
501 
502  oc.doRegister("weights.random-factor", new Option_Float(1.));
503  oc.addDescription("weights.random-factor", "Routing", "Edge weights for routing are dynamically disturbed by a random factor drawn uniformly from [1,FLOAT)");
504 
505  oc.doRegister("weights.minor-penalty", new Option_Float(1.5));
506  oc.addDescription("weights.minor-penalty", "Routing", "Apply the given time penalty when computing minimum routing costs for minor-link internal lanes");
507 
508  oc.doRegister("weights.priority-factor", new Option_Float(0));
509  oc.addDescription("weights.priority-factor", "Routing", "Consider edge priorities in addition to travel times, weighted by factor");
510 
511  oc.doRegister("weights.separate-turns", new Option_Float(0));
512  oc.addDescription("weights.separate-turns", "Routing", "Distinguish travel time by turn direction and shift a fraction of the estimated time loss ahead of the intersection onto the internal edges");
513 
514  oc.doRegister("astar.all-distances", new Option_FileName());
515  oc.addDescription("astar.all-distances", "Routing", "Initialize lookup table for astar from the given file (generated by marouter --all-pairs-output)");
516 
517  oc.doRegister("astar.landmark-distances", new Option_FileName());
518  oc.addDescription("astar.landmark-distances", "Routing", "Initialize lookup table for astar ALT-variant from the given file");
519 
520  oc.doRegister("persontrip.walkfactor", new Option_Float(double(0.75)));
521  oc.addDescription("persontrip.walkfactor", "Routing", "Use FLOAT as a factor on pedestrian maximum speed during intermodal routing");
522 
523  oc.doRegister("persontrip.walk-opposite-factor", new Option_Float(1.0));
524  oc.addDescription("persontrip.walk-opposite-factor", "Processing", "Use FLOAT as a factor on walking speed against vehicle traffic direction");
525 
526  oc.doRegister("persontrip.transfer.car-walk", new Option_StringVector(StringVector({ "parkingAreas" })));
527  oc.addDescription("persontrip.transfer.car-walk", "Routing",
528  "Where are mode changes from car to walking allowed (possible values: 'parkingAreas', 'ptStops', 'allJunctions' and combinations)");
529 
530  oc.doRegister("persontrip.transfer.taxi-walk", new Option_StringVector());
531  oc.addDescription("persontrip.transfer.taxi-walk", "Routing", "Where taxis can drop off customers ('allJunctions, 'ptStops')");
532 
533  oc.doRegister("persontrip.transfer.walk-taxi", new Option_StringVector());
534  oc.addDescription("persontrip.transfer.walk-taxi", "Routing", "Where taxis can pick up customers ('allJunctions, 'ptStops')");
535 
536  oc.doRegister("persontrip.default.group", new Option_String());
537  oc.addDescription("persontrip.default.group", "Routing", "When set, trips between the same origin and destination will share a taxi by default");
538 
539  oc.doRegister("persontrip.taxi.waiting-time", new Option_String("300", "TIME"));
540  oc.addDescription("persontrip.taxi.waiting-time", "Routing", "Estimated time for taxi pickup");
541 
542  oc.doRegister("railway.max-train-length", new Option_Float(1000.0));
543  oc.addDescription("railway.max-train-length", "Routing", "Use FLOAT as a maximum train length when initializing the railway router");
544 
545  // devices
546  oc.addOptionSubTopic("Emissions");
547  oc.doRegister("phemlight-path", new Option_FileName(StringVector({ "./PHEMlight/" })));
548  oc.addDescription("phemlight-path", "Emissions", "Determines where to load PHEMlight definitions from.");
549 
550  oc.addOptionSubTopic("Communication");
551  oc.addOptionSubTopic("Battery");
553 
554  // register report options
555  oc.doRegister("duration-log.disable", new Option_Bool(false));
556  oc.addSynonyme("duration-log.disable", "no-duration-log", false);
557  oc.addDescription("duration-log.disable", "Report", "Disable performance reports for individual simulation steps");
558 
559  oc.doRegister("duration-log.statistics", 't', new Option_Bool(false));
560  oc.addDescription("duration-log.statistics", "Report", "Enable statistics on vehicle trips");
561 
562  oc.doRegister("no-step-log", new Option_Bool(false));
563  oc.addDescription("no-step-log", "Report", "Disable console output of current simulation step");
564 
565  oc.doRegister("step-log.period", new Option_Integer(100));
566  oc.addDescription("step-log.period", "Report", "Number of simulation steps between step-log outputs");
567 
568  //remote port 0 if not used
569  oc.addOptionSubTopic("TraCI Server");
570  oc.doRegister("remote-port", new Option_Integer(0));
571  oc.addDescription("remote-port", "TraCI Server", "Enables TraCI Server if set");
572  oc.doRegister("num-clients", new Option_Integer(1));
573  oc.addDescription("num-clients", "TraCI Server", "Expected number of connecting clients");
574 
575  oc.addOptionSubTopic("Mesoscopic");
576  oc.doRegister("mesosim", new Option_Bool(false));
577  oc.addDescription("mesosim", "Mesoscopic", "Enables mesoscopic simulation");
578  oc.doRegister("meso-edgelength", new Option_Float(98.0f));
579  oc.addDescription("meso-edgelength", "Mesoscopic", "Length of an edge segment in mesoscopic simulation");
580  oc.doRegister("meso-tauff", new Option_String("1.13", "TIME"));
581  oc.addDescription("meso-tauff", "Mesoscopic", "Factor for calculating the net free-free headway time");
582  oc.doRegister("meso-taufj", new Option_String("1.13", "TIME"));
583  oc.addDescription("meso-taufj", "Mesoscopic", "Factor for calculating the net free-jam headway time");
584  oc.doRegister("meso-taujf", new Option_String("1.73", "TIME"));
585  oc.addDescription("meso-taujf", "Mesoscopic", "Factor for calculating the jam-free headway time");
586  oc.doRegister("meso-taujj", new Option_String("1.4", "TIME"));
587  oc.addDescription("meso-taujj", "Mesoscopic", "Factor for calculating the jam-jam headway time");
588  oc.doRegister("meso-jam-threshold", new Option_Float(-1));
589  oc.addDescription("meso-jam-threshold", "Mesoscopic",
590  "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)");
591  oc.doRegister("meso-multi-queue", new Option_Bool(true));
592  oc.addDescription("meso-multi-queue", "Mesoscopic", "Enable multiple queues at edge ends");
593  oc.doRegister("meso-lane-queue", new Option_Bool(false));
594  oc.addDescription("meso-lane-queue", "Mesoscopic", "Enable separate queues for every lane");
595  oc.doRegister("meso-ignore-lanes-by-vclass", new Option_StringVector(StringVector({ "pedestrian", "bicycle" })));
596  oc.addDescription("meso-ignore-lanes-by-vclass", "Mesoscopic", "Do not build queues (or reduce capacity) for lanes allowing only the given vclasses");
597  oc.addSynonyme("meso-ignore-lanes-by-vclass", "meso.ignore-lanes.by-vclass");
598  oc.doRegister("meso-junction-control", new Option_Bool(false));
599  oc.addDescription("meso-junction-control", "Mesoscopic", "Enable mesoscopic traffic light and priority junction handling");
600  oc.doRegister("meso-junction-control.limited", new Option_Bool(false));
601  oc.addDescription("meso-junction-control.limited", "Mesoscopic",
602  "Enable mesoscopic traffic light and priority junction handling for saturated links. This prevents faulty traffic lights from hindering flow in low-traffic situations");
603  oc.doRegister("meso-tls-penalty", new Option_Float(0));
604  oc.addDescription("meso-tls-penalty", "Mesoscopic",
605  "Apply scaled travel time penalties when driving across tls controlled junctions based on green split instead of checking actual phases");
606  oc.doRegister("meso-tls-flow-penalty", new Option_Float(0));
607  oc.addDescription("meso-tls-flow-penalty", "Mesoscopic",
608  "Apply scaled headway penalties when driving across tls controlled junctions based on green split instead of checking actual phases");
609  oc.doRegister("meso-minor-penalty", new Option_String("0", "TIME"));
610  oc.addDescription("meso-minor-penalty", "Mesoscopic",
611  "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.");
612  oc.doRegister("meso-overtaking", new Option_Bool(false));
613  oc.addDescription("meso-overtaking", "Mesoscopic", "Enable mesoscopic overtaking");
614  oc.doRegister("meso-recheck", new Option_String("0", "TIME"));
615  oc.addDescription("meso-recheck", "Mesoscopic", "Time interval for rechecking insertion into the next segment after failure");
616 
617  // add rand options
619  oc.doRegister("thread-rngs", new Option_Integer(64));
620  oc.addDescription("thread-rngs", "Random Number",
621  "Number of pre-allocated random number generators to ensure repeatable multi-threaded simulations (should be at least the number of threads for repeatable simulations).");
622 
623  // add GUI options
624  // the reason that we include them in vanilla sumo as well is to make reusing config files easy
625  oc.addOptionSubTopic("GUI Only");
626  oc.doRegister("gui-settings-file", 'g', new Option_FileName());
627  oc.addDescription("gui-settings-file", "GUI Only", "Load visualisation settings from FILE");
628 
629  oc.doRegister("quit-on-end", 'Q', new Option_Bool(false));
630  oc.addDescription("quit-on-end", "GUI Only", "Quits the GUI when the simulation stops");
631 
632  oc.doRegister("game", 'G', new Option_Bool(false));
633  oc.addDescription("game", "GUI Only", "Start the GUI in gaming mode");
634 
635  oc.doRegister("game.mode", new Option_String("tls"));
636  oc.addDescription("game.mode", "GUI Only", "Select the game type ('tls', 'drt')");
637 
638  oc.doRegister("start", 'S', new Option_Bool(false));
639  oc.addDescription("start", "GUI Only", "Start the simulation after loading");
640 
641  oc.doRegister("delay", 'd', new Option_Float(0.0));
642  oc.addDescription("delay", "GUI Only", "Use FLOAT in ms as delay between simulation steps");
643 
644  oc.doRegister("breakpoints", 'B', new Option_StringVector());
645  oc.addDescription("breakpoints", "GUI Only", "Use TIME[] as times when the simulation should halt");
646 
647  oc.doRegister("edgedata-files", new Option_FileName());
648  oc.addDescription("edgedata-files", "GUI Only", "Load edge/lane weights for visualization from FILE");
649 
650  oc.doRegister("demo", 'D', new Option_Bool(false));
651  oc.addDescription("demo", "GUI Only", "Restart the simulation after ending (demo mode)");
652 
653  oc.doRegister("disable-textures", 'T', new Option_Bool(false));
654  oc.addDescription("disable-textures", "GUI Only", "Do not load background pictures");
655 
656  oc.doRegister("registry-viewport", new Option_Bool(false));
657  oc.addDescription("registry-viewport", "GUI Only", "Load current viewport from registry");
658 
659  oc.doRegister("window-size", new Option_StringVector());
660  oc.addDescription("window-size", "GUI Only", "Create initial window with the given x,y size");
661 
662  oc.doRegister("window-pos", new Option_StringVector());
663  oc.addDescription("window-pos", "GUI Only", "Create initial window at the given x,y position");
664 
665  oc.doRegister("tracker-interval", new Option_String("1", "TIME"));
666  oc.addDescription("tracker-interval", "GUI Only", "The aggregation period for value tracker windows");
667 
668 #ifdef HAVE_OSG
669  oc.doRegister("osg-view", new Option_Bool(false));
670  oc.addDescription("osg-view", "GUI Only", "Start with an OpenSceneGraph view instead of the regular 2D view");
671 #endif
672 
673  // gui testing
674  oc.doRegister("gui-testing", new Option_Bool(false));
675  oc.addDescription("gui-testing", "GUI Only", "Enable overlay for screen recognition");
676 
677  // gui testing - debug
678  oc.doRegister("gui-testing-debug", new Option_Bool(false));
679  oc.addDescription("gui-testing-debug", "GUI Only", "Enable output messages during GUI-Testing");
680 
681  // gui testing - settings output
682  oc.doRegister("gui-testing.setting-output", new Option_FileName());
683  oc.addDescription("gui-testing.setting-output", "GUI Only", "Save gui settings in the given settings output file");
684 }
685 
686 
687 void
689  // standard outputs
690  OutputDevice::createDeviceByOption("netstate-dump", "netstate", "netstate_file.xsd");
691  OutputDevice::createDeviceByOption("summary-output", "summary", "summary_file.xsd");
692  OutputDevice::createDeviceByOption("person-summary-output", "personSummary", "person_summary_file.xsd");
693  OutputDevice::createDeviceByOption("tripinfo-output", "tripinfos", "tripinfo_file.xsd");
694 
695  //extended
696  OutputDevice::createDeviceByOption("fcd-output", "fcd-export", "fcd_file.xsd");
697  OutputDevice::createDeviceByOption("emission-output", "emission-export", "emission_file.xsd");
698  OutputDevice::createDeviceByOption("battery-output", "battery-export");
699  if (OptionsCont::getOptions().getBool("elechybrid-output.aggregated")) {
700  // RICE_TODO: Add path to elechybrid-output.aggregated xsd file
701  OutputDevice::createDeviceByOption("elechybrid-output", "elecHybrid-export-aggregated", "\" recuperationEnabled=\"" + toString(MSGlobals::gOverheadWireRecuperation));
702  }
703  //OutputDevice::createDeviceByOption("elecHybrid-output", "elecHybrid-export");
704  OutputDevice::createDeviceByOption("chargingstations-output", "chargingstations-export");
705  OutputDevice::createDeviceByOption("overheadwiresegments-output", "overheadWireSegments-export");
706  OutputDevice::createDeviceByOption("substations-output", "substations-export");
707  OutputDevice::createDeviceByOption("full-output", "full-export", "full_file.xsd");
708  OutputDevice::createDeviceByOption("queue-output", "queue-export", "queue_file.xsd");
709  OutputDevice::createDeviceByOption("amitran-output", "trajectories", "amitran/trajectories.xsd\" timeStepSize=\"" + toString(STEPS2MS(DELTA_T)));
710 
711  //OutputDevice::createDeviceByOption("vtk-output", "vtk-export");
712  OutputDevice::createDeviceByOption("link-output", "link-output");
713  OutputDevice::createDeviceByOption("railsignal-block-output", "railsignal-block-output");
714  OutputDevice::createDeviceByOption("bt-output", "bt-output");
715  OutputDevice::createDeviceByOption("lanechange-output", "lanechanges");
716  OutputDevice::createDeviceByOption("stop-output", "stops", "stopinfo_file.xsd");
717  OutputDevice::createDeviceByOption("collision-output", "collisions", "collision_file.xsd");
718  OutputDevice::createDeviceByOption("statistic-output", "statistics", "statistic_file.xsd");
719 
720 #ifdef _DEBUG
721  OutputDevice::createDeviceByOption("movereminder-output", "movereminder-output");
722 #endif
723 
725  MSStopOut::init();
726 }
727 
728 
729 bool
732  bool ok = true;
733  if (!oc.isSet("net-file") && oc.isDefault("remote-port")) {
734  WRITE_ERROR("No network file (-n) specified.");
735  ok = false;
736  }
737  if (oc.getFloat("scale") < 0.) {
738  WRITE_ERROR("Invalid scaling factor.");
739  ok = false;
740  }
741  if (oc.getBool("vehroute-output.exit-times") && !oc.isSet("vehroute-output")) {
742  WRITE_ERROR("A vehroute-output file is needed for exit times.");
743  ok = false;
744  }
745  if (oc.isSet("gui-settings-file") &&
746  oc.getString("gui-settings-file") != "" &&
747  !oc.isUsableFileList("gui-settings-file")) {
748  ok = false;
749  }
750  if (oc.getBool("demo") && oc.isDefault("start")) {
751  oc.set("start", "true");
752  }
753  if (oc.getBool("demo") && oc.getBool("quit-on-end")) {
754  WRITE_ERROR("You can either restart or quit on end.");
755  ok = false;
756  }
757  if (oc.getBool("meso-junction-control.limited") && !oc.getBool("meso-junction-control")) {
758  oc.set("meso-junction-control", "true");
759  }
760  if (oc.getBool("mesosim")) {
761  if (oc.isDefault("pedestrian.model")) {
762  oc.set("pedestrian.model", "nonInteracting");
763  }
764  }
765  const SUMOTime begin = string2time(oc.getString("begin"));
766  const SUMOTime end = string2time(oc.getString("end"));
767  if (begin < 0) {
768  WRITE_ERROR("The begin time should not be negative.");
769  ok = false;
770  }
771  // DELTA_T not yet initialized
772  const SUMOTime deltaT = MAX2((SUMOTime)1, string2time(oc.getString("step-length")));
773  if (begin < TIME2STEPS(1)) {
774  checkStepLengthMultiple(begin, " for begin", deltaT);
775  }
776  if (end != string2time("-1")) {
777  if (end < begin) {
778  WRITE_ERROR("The end time should be after the begin time.");
779  ok = false;
780  }
781  }
782  if (string2time(oc.getString("step-length")) <= 0) {
783  WRITE_ERROR("the minimum step-length is 0.001");
784  ok = false;
785  }
786  const SUMOTime period = string2time(oc.getString("device.fcd.period"));
787  if (period > 0) {
788  checkStepLengthMultiple(period, " for device.fcd.period", deltaT);
789  }
790  const SUMOTime statePeriod = string2time(oc.getString("save-state.period"));
791  if (statePeriod > 0) {
792  checkStepLengthMultiple(statePeriod, " for save-state.period", deltaT);
793  }
794  for (const std::string& timeStr : oc.getStringVector("save-state.times")) {
795  try {
796  const SUMOTime saveT = string2time(timeStr);
797  if (end > 0 && saveT >= end) {
798  WRITE_WARNING("The save-state time=" + timeStr + " will not be used before simulation end at " + time2string(end) + ".");
799  } else {
800  checkStepLengthMultiple(saveT, " for save-state.times", deltaT);
801  }
802  } catch (ProcessError& e) {
803  WRITE_ERROR("Invalid time '" + timeStr + "' for option 'save-state.times'. " + e.what());
804  ok = false;
805  }
806  }
807 
808 #ifdef _DEBUG
809  if (oc.isSet("movereminder-output.vehicles") && !oc.isSet("movereminder-output")) {
810  WRITE_ERROR("option movereminder-output.vehicles requires option movereminder-output to be set");
811  ok = false;
812  }
813 #endif
814  if (oc.getBool("sloppy-insert")) {
815  WRITE_WARNING("The option 'sloppy-insert' is deprecated, because it is now activated by default, see the new option 'eager-insert'.");
816  }
817  if (string2time(oc.getString("lanechange.duration")) > 0 && oc.getFloat("lateral-resolution") > 0) {
818  WRITE_ERROR("Only one of the options 'lanechange.duration' or 'lateral-resolution' may be given.");
819  ok = false;
820  }
821  if (oc.getBool("mesosim") && (oc.getFloat("lateral-resolution") > 0 || string2time(oc.getString("lanechange.duration")) > 0)) {
822  WRITE_ERROR("Sublane dynamics are not supported by mesoscopic simulation");
823  ok = false;
824  }
825  if (oc.getBool("ignore-accidents")) {
826  WRITE_WARNING("The option 'ignore-accidents' is deprecated. Use 'collision.action none' instead.");
827  }
828  if (oc.getBool("duration-log.statistics") && oc.isDefault("verbose")) {
829  oc.set("verbose", "true");
830  }
831  if (oc.isDefault("precision") && string2time(oc.getString("step-length")) % 10 != 0) {
832  oc.set("precision", "3");
833  }
834  if (oc.isDefault("tracker-interval") && !oc.isDefault("step-length")) {
835  oc.set("tracker-interval", oc.getString("step-length"));
836  }
837  if (oc.getBool("tripinfo-output.write-undeparted")) {
838  if (!oc.isDefault("tripinfo-output.write-unfinished") && !oc.getBool("tripinfo-output.write-unfinished")) {
839  WRITE_WARNING("option tripinfo-output.write-undeparted implies tripinfo-output.write-unfinished");
840  }
841  oc.set("tripinfo-output.write-unfinished", "true");
842  }
843  if (oc.getInt("precision") > 2) {
844  if (oc.isDefault("netstate-dump.precision")) {
845  oc.set("netstate-dump.precision", toString(oc.getInt("precision")));
846  }
847  if (oc.isDefault("emission-output.precision")) {
848  oc.set("emission-output.precision", toString(oc.getInt("precision")));
849  }
850  if (oc.isDefault("battery-output.precision")) {
851  oc.set("battery-output.precision", toString(oc.getInt("precision")));
852  }
853  if (oc.isDefault("elechybrid-output.precision")) {
854  oc.set("elechybrid-output.precision", toString(oc.getInt("precision")));
855  }
856  if (oc.isDefault("substations-output.precision")) {
857  oc.set("substations-output.precision", toString(oc.getInt("precision")));
858  }
859  }
860  if (!SUMOXMLDefinitions::CarFollowModels.hasString(oc.getString("carfollow.model"))) {
861  WRITE_ERROR("Unknown model '" + oc.getString("carfollow.model") + "' for option 'carfollow.model'.");
862  ok = false;
863  }
864  if (oc.isSet("default.emergencydecel")) {
865  const std::string val = oc.getString("default.emergencydecel");
866  if (val != "default" && val != "decel") {
867  try {
869  } catch (NumberFormatException&) {
870  WRITE_ERROR("Invalid value '" + val + "' for option 'default.emergencydecel'. Must be a FLOAT or 'default' or 'decel'");
871  ok = false;
872  }
873  }
874  }
875  if (oc.getFloat("delay") < 0.0) {
876  WRITE_ERROR("You need a non-negative delay.");
877  ok = false;
878  }
879  for (const std::string& val : oc.getStringVector("breakpoints")) {
880  try {
881  string2time(val);
882  } catch (ProcessError& e) {
883  WRITE_ERROR("Invalid time '" + val + "' for option 'breakpoints'. " + e.what());
884  ok = false;
885  }
886  }
887 #ifndef HAVE_FOX
888  if (oc.getInt("threads") > 1) {
889  WRITE_ERROR("Parallel simulation is only possible when compiled with Fox.");
890  ok = false;
891  }
892 #endif
893  if (oc.getInt("threads") < 1) {
894  WRITE_ERROR("You need at least one thread.");
895  ok = false;
896  }
897  if (oc.getInt("threads") > oc.getInt("thread-rngs")) {
898  WRITE_WARNING("Number of threads exceeds number of thread-rngs. Simulation runs with the same seed may produce different results");
899  }
900  if (oc.getString("game.mode") != "tls" && oc.getString("game.mode") != "drt") {
901  WRITE_ERROR("game.mode must be one of ['tls', 'drt']");
902  ok = false;
903  }
904 
905  if (oc.isSet("persontrip.transfer.car-walk")) {
906  for (const std::string& opt : OptionsCont::getOptions().getStringVector("persontrip.transfer.car-walk")) {
907  if (opt != "parkingAreas" && opt != "ptStops" && opt != "allJunctions") {
908  WRITE_ERROR("Invalid transfer option '" + opt + "'. Must be one of 'parkingAreas', 'ptStops' and 'allJunctions'");
909  ok = false;
910  }
911  }
912  }
913 
914  ok &= MSDevice::checkOptions(oc);
916 
917  return ok;
918 }
919 
920 
921 void
923  // pre-initialise the network
924  // set whether empty edges shall be printed on dump
925  MSGlobals::gOmitEmptyEdgesOnDump = !oc.getBool("netstate-dump.empty-edges");
926  // set whether internal lanes shall be used
927  MSGlobals::gUsingInternalLanes = !oc.getBool("no-internal-links");
928  MSGlobals::gIgnoreJunctionBlocker = string2time(oc.getString("ignore-junction-blocker")) < 0 ?
929  std::numeric_limits<SUMOTime>::max() : string2time(oc.getString("ignore-junction-blocker"));
930  // set the grid lock time
931  MSGlobals::gTimeToGridlock = string2time(oc.getString("time-to-teleport")) < 0 ? 0 : string2time(oc.getString("time-to-teleport"));
932  MSGlobals::gTimeToImpatience = string2time(oc.getString("time-to-impatience"));
933  MSGlobals::gTimeToGridlockHighways = string2time(oc.getString("time-to-teleport.highways")) < 0 ? 0 : string2time(oc.getString("time-to-teleport.highways"));
934  MSGlobals::gTimeToTeleportDisconnected = string2time(oc.getString("time-to-teleport.disconnected"));
935  MSGlobals::gRemoveGridlocked = oc.getBool("time-to-teleport.remove");
936  MSGlobals::gCheck4Accidents = !oc.getBool("ignore-accidents");
937  MSGlobals::gCheckRoutes = !oc.getBool("ignore-route-errors");
938  MSGlobals::gWeightsSeparateTurns = oc.getFloat("weights.separate-turns");
939  MSGlobals::gLaneChangeDuration = string2time(oc.getString("lanechange.duration"));
940  MSGlobals::gLateralResolution = oc.getFloat("lateral-resolution");
942  MSGlobals::gStateLoaded = oc.isSet("load-state");
943  MSGlobals::gUseMesoSim = oc.getBool("mesosim");
944  MSGlobals::gMesoLimitedJunctionControl = oc.getBool("meso-junction-control.limited");
947  }
948  MSGlobals::gWaitingTimeMemory = string2time(oc.getString("waiting-time-memory"));
950  MSGlobals::gOverheadWireSolver = oc.getBool("overhead-wire.solver");
951  MSGlobals::gOverheadWireRecuperation = oc.getBool("overhead-wire.recuperation");
952  MSGlobals::gOverheadWireCurrentLimits = oc.getBool("overhead-wire.substation-current-limits");
953 
955 
956  DELTA_T = string2time(oc.getString("step-length"));
957 
958  const bool integrationMethodSet = !oc.isDefault("step-method.ballistic");
959  const bool actionStepLengthSet = !oc.isDefault("default.action-step-length");
960  MSGlobals::gSemiImplicitEulerUpdate = !oc.getBool("step-method.ballistic");
961  // Init default value for gActionStepLength
962  if (MSGlobals::gSemiImplicitEulerUpdate && actionStepLengthSet && !integrationMethodSet) {
963  WRITE_MESSAGE("Integration method was set to 'ballistic', since a default action step length was specified.");
965  }
966  double givenDefaultActionStepLength = oc.getFloat("default.action-step-length");
968 
969  const std::string defaultEmergencyDecelOption = OptionsCont::getOptions().getString("default.emergencydecel");
970  if (defaultEmergencyDecelOption == "default") {
972  } else if (defaultEmergencyDecelOption == "decel") {
974  } else {
975  // value already checked in checkOptions()
976  MSGlobals::gDefaultEmergencyDecel = StringUtils::toDouble(defaultEmergencyDecelOption);
977  }
978  MSGlobals::gNumSimThreads = oc.getInt("threads");
979  MSGlobals::gNumThreads = MAX2(MSGlobals::gNumSimThreads, oc.getInt("device.rerouting.threads"));
980 
981  MSGlobals::gEmergencyDecelWarningThreshold = oc.getFloat("emergencydecel.warning-threshold");
982  MSGlobals::gMinorPenalty = oc.getFloat("weights.minor-penalty");
983 
984  MSGlobals::gModelParkingManoeuver = oc.getBool("parking.maneuver");
985 
986  MSGlobals::gStopTolerance = oc.getFloat("ride.stop-tolerance");
987  MSGlobals::gTLSYellowMinDecel = oc.getFloat("tls.yellow.min-decel");
988  MSGlobals::gUseStopEnded = oc.getBool("use-stop-ended");
989 
990 #ifdef _DEBUG
991  if (oc.isSet("movereminder-output")) {
992  MSBaseVehicle::initMoveReminderOutput(oc);
993  }
994 #endif
995 }
996 
997 
998 /****************************************************************************/
#define WRITE_MESSAGE(msg)
Definition: MsgHandler.h:282
#define WRITE_ERROR(msg)
Definition: MsgHandler.h:288
#define WRITE_WARNING(msg)
Definition: MsgHandler.h:280
std::vector< std::string > StringVector
Definition of a vector of strings.
Definition: Option.h:43
bool checkStepLengthMultiple(const SUMOTime t, const std::string &error, SUMOTime deltaT)
check if given SUMOTime is multiple of the step length
Definition: SUMOTime.cpp:123
SUMOTime DELTA_T
Definition: SUMOTime.cpp:37
std::string time2string(SUMOTime t)
convert SUMOTime to string
Definition: SUMOTime.cpp:68
SUMOTime string2time(const std::string &r)
convert string to SUMOTime
Definition: SUMOTime.cpp:45
#define TIME2STEPS(x)
Definition: SUMOTime.h:55
#define STEPS2MS(x)
Definition: SUMOTime.h:57
long long int SUMOTime
Definition: SUMOTime.h:32
const int VTYPEPARS_DEFAULT_EMERGENCYDECEL_DEFAULT
const int VTYPEPARS_DEFAULT_EMERGENCYDECEL_DECEL
T MAX2(T a, T b)
Definition: StdDefs.h:80
std::string toString(const T &t, std::streamsize accuracy=gPrecision)
Definition: ToString.h:46
static void initGlobalOptions(const OptionsCont &oc)
init global model parameters
static void init()
Static intialization.
static void insertOptions(OptionsCont &oc)
Inserts options for building devices.
Definition: MSDevice.cpp:69
static bool checkOptions(OptionsCont &oc)
check device-specific options
Definition: MSDevice.cpp:93
static void buildStreams()
Builds the streams used possibly by the simulation.
Definition: MSFrame.cpp:688
static void setMSGlobals(OptionsCont &oc)
Sets the global microsim-options.
Definition: MSFrame.cpp:922
static void fillOptions()
Inserts options used by the simulation into the OptionsCont-singleton.
Definition: MSFrame.cpp:60
static bool checkOptions()
Checks the set options.
Definition: MSFrame.cpp:730
static bool gOverheadWireCurrentLimits
Definition: MSGlobals.h:115
static double gStopTolerance
The tolerance to apply when matching waiting persons and vehicles.
Definition: MSGlobals.h:151
static SUMOTime gTimeToTeleportDisconnected
Definition: MSGlobals.h:63
static bool gModelParkingManoeuver
whether parking simulation includes manoeuver time and any associated lane blocking
Definition: MSGlobals.h:145
static bool gUseMesoSim
Definition: MSGlobals.h:94
static double gMinorPenalty
time penalty for passing a minor link when routing
Definition: MSGlobals.h:142
static SUMOTime gTimeToGridlockHighways
Definition: MSGlobals.h:60
static bool gCheckRoutes
Definition: MSGlobals.h:82
static double gWeightsSeparateTurns
Whether turning specific weights are estimated (and how much)
Definition: MSGlobals.h:160
static bool gOverheadWireRecuperation
Definition: MSGlobals.h:112
static bool gRemoveGridlocked
Definition: MSGlobals.h:66
static double gDefaultEmergencyDecel
encoding of the string-option default.emergencydecel
Definition: MSGlobals.h:118
static double gTLSYellowMinDecel
The minimum deceleration at a yellow traffic light (only overruled by emergencyDecel)
Definition: MSGlobals.h:154
static bool gOverheadWireSolver
Definition: MSGlobals.h:109
static double gLateralResolution
Definition: MSGlobals.h:88
static bool gSemiImplicitEulerUpdate
Definition: MSGlobals.h:53
static SUMOTime gTimeToImpatience
Definition: MSGlobals.h:69
static bool gStateLoaded
Information whether a state has been loaded.
Definition: MSGlobals.h:91
static bool gCheck4Accidents
Definition: MSGlobals.h:79
static int gNumSimThreads
how many threads to use for simulation
Definition: MSGlobals.h:133
static bool gOmitEmptyEdgesOnDump
Information whether empty edges shall be written on dump.
Definition: MSGlobals.h:49
static SUMOTime gIgnoreJunctionBlocker
Definition: MSGlobals.h:76
static bool gSublane
whether sublane simulation is enabled (sublane model or continuous lanechanging)
Definition: MSGlobals.h:148
static SUMOTime gLaneChangeDuration
Definition: MSGlobals.h:85
static bool gMesoLimitedJunctionControl
Definition: MSGlobals.h:97
static bool gUseStopEnded
whether the simulation should replay previous stop times
Definition: MSGlobals.h:121
static SUMOTime gActionStepLength
default value for the interval between two action points for MSVehicle (defaults to DELTA_T)
Definition: MSGlobals.h:106
static SUMOTime gWaitingTimeMemory
length of memory for waiting times (in millisecs)
Definition: MSGlobals.h:103
static double gEmergencyDecelWarningThreshold
treshold for warning about strong deceleration
Definition: MSGlobals.h:139
static bool gUsingInternalLanes
Information whether the simulation regards internal lanes.
Definition: MSGlobals.h:72
static int gNumThreads
how many threads to use
Definition: MSGlobals.h:136
static SUMOTime gTimeToGridlock
Definition: MSGlobals.h:57
static void initCollisionOptions(const OptionsCont &oc)
Definition: MSLane.cpp:3916
static void init()
Static intialization.
Definition: MSStopOut.cpp:43
An integer-option.
Definition: Option.h:329
A storage for options typed value containers)
Definition: OptionsCont.h:89
void addDescription(const std::string &name, const std::string &subtopic, const std::string &description)
Adds a description for an option.
void doRegister(const std::string &name, Option *v)
Adds an option under the given name.
Definition: OptionsCont.cpp:75
bool isSet(const std::string &name, bool failOnNonExistant=true) const
Returns the information whether the named option is set.
double getFloat(const std::string &name) const
Returns the double-value of the named option (only for Option_Float)
bool set(const std::string &name, const std::string &value)
Sets the given value for the named option.
int getInt(const std::string &name) const
Returns the int-value of the named option (only for Option_Integer)
std::string getString(const std::string &name) const
Returns the string-value of the named option (only for Option_String)
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 isDefault(const std::string &name) const
Returns the information whether the named option has still the default value.
void addOptionSubTopic(const std::string &topic)
Adds an option subtopic.
bool getBool(const std::string &name) const
Returns the boolean-value of the named option (only for Option_Bool)
const StringVector & getStringVector(const std::string &name) const
Returns the list of string-value of the named option (only for Option_StringVector)
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.
static OptionsCont & getOptions()
Retrieves the options.
Definition: OptionsCont.cpp:58
bool isUsableFileList(const std::string &name) const
Checks whether the named option is usable as a file list (with at least a single file)
void addCallExample(const std::string &example, const std::string &desc)
Add a call example.
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 void insertRandOptions()
Initialises the given options container with random number options.
Definition: RandHelper.cpp:43
static SUMOTime processActionStepLength(double given)
Checks and converts given value for the action step length from seconds to miliseconds assuring it be...
static StringBijection< SumoXMLTag > CarFollowModels
car following models
static double toDouble(const std::string &sData)
converts a string into the double value described by it by calling the char-type converter
static void addConfigurationOptions(OptionsCont &oc)
Adds configuration options to the given container.
Definition: SystemFrame.cpp:38
static void addReportOptions(OptionsCont &oc)
Adds reporting options to the given container.
Definition: SystemFrame.cpp:63
static bool checkOptions()
checks shared options and sets StdDefs