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-2018 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials
5 // are made available under the terms of the Eclipse Public License v2.0
6 // which accompanies this distribution, and is available at
7 // http://www.eclipse.org/legal/epl-v20.html
8 // SPDX-License-Identifier: EPL-2.0
9 /****************************************************************************/
21 // Sets and checks options for microsim; inits global outputs and settings
22 /****************************************************************************/
23 
24 
25 // ===========================================================================
26 // included modules
27 // ===========================================================================
28 #include <config.h>
29 
30 #include <iostream>
31 #include <iomanip>
32 #include <fstream>
33 #include <ctime>
35 #include <utils/options/Option.h>
38 #include <utils/common/ToString.h>
43 #include <microsim/MSBaseVehicle.h>
44 #include <microsim/MSJunction.h>
45 #include <microsim/MSRoute.h>
46 #include <microsim/MSNet.h>
47 #include <microsim/MSGlobals.h>
53 #include "MSFrame.h"
55 
56 
57 // ===========================================================================
58 // method definitions
59 // ===========================================================================
60 void
63  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");
64  oc.addCallExample("-c munich_config.cfg", "start with a configuration file");
65  oc.addCallExample("--help", "print help");
66 
67  // insert options sub-topics
68  SystemFrame::addConfigurationOptions(oc); // fill this subtopic, too
69  oc.addOptionSubTopic("Input");
70  oc.addOptionSubTopic("Output");
71  oc.addOptionSubTopic("Time");
72  oc.addOptionSubTopic("Processing");
73  oc.addOptionSubTopic("Routing");
74  SystemFrame::addReportOptions(oc); // fill this subtopic, too
75 
76 
77  // register configuration options
78  // register input options
79  oc.doRegister("net-file", 'n', new Option_FileName());
80  oc.addSynonyme("net-file", "net");
81  oc.addDescription("net-file", "Input", "Load road network description from FILE");
82  oc.addXMLDefault("net-file", "net");
83 
84  oc.doRegister("route-files", 'r', new Option_FileName());
85  oc.addSynonyme("route-files", "routes");
86  oc.addDescription("route-files", "Input", "Load routes descriptions from FILE(s)");
87 
88  oc.doRegister("additional-files", 'a', new Option_FileName());
89  oc.addSynonyme("additional-files", "additional");
90  oc.addDescription("additional-files", "Input", "Load further descriptions from FILE(s)");
91 
92  oc.doRegister("weight-files", 'w', new Option_FileName());
93  oc.addSynonyme("weight-files", "weights");
94  oc.addDescription("weight-files", "Input", "Load edge/lane weights for online rerouting from FILE");
95  oc.doRegister("weight-attribute", 'x', new Option_String("traveltime"));
96  oc.addSynonyme("weight-attribute", "measure", true);
97  oc.addDescription("weight-attribute", "Input", "Name of the xml attribute which gives the edge weight");
98 
99  oc.doRegister("load-state", new Option_FileName());
100  oc.addDescription("load-state", "Input", "Loads a network state from FILE");
101  oc.doRegister("load-state.offset", new Option_String("0", "TIME"));
102  oc.addDescription("load-state.offset", "Input", "Shifts all times loaded from a saved state by the given offset");
103  oc.doRegister("load-state.remove-vehicles", new Option_String(""));
104  oc.addDescription("load-state.remove-vehicles", "Input", "Removes vehicles with the given IDs from the loaded state");
105 
106  // register output options
107  oc.doRegister("netstate-dump", new Option_FileName());
108  oc.addSynonyme("netstate-dump", "ndump");
109  oc.addSynonyme("netstate-dump", "netstate");
110  oc.addSynonyme("netstate-dump", "netstate-output");
111  oc.addDescription("netstate-dump", "Output", "Save complete network states into FILE");
112  oc.doRegister("netstate-dump.empty-edges", new Option_Bool(false));
113  oc.addSynonyme("netstate-dump.empty-edges", "netstate.empty-edges");
114  oc.addSynonyme("netstate-dump.empty-edges", "netstate-output.empty-edges");
115  oc.addSynonyme("netstate-dump.empty-edges", "dump-empty-edges", true);
116  oc.addDescription("netstate-dump.empty-edges", "Output", "Write also empty edges completely when dumping");
117  oc.doRegister("netstate-dump.precision", new Option_Integer(2));
118  oc.addSynonyme("netstate-dump.precision", "netstate.precision");
119  oc.addSynonyme("netstate-dump.precision", "netstate-output.precision");
120  oc.addSynonyme("netstate-dump.precision", "dump-precision", true);
121  oc.addDescription("netstate-dump.precision", "Output", "Write positions and speeds with the given precision (default 2)");
122 
123 
124  oc.doRegister("emission-output", new Option_FileName());
125  oc.addDescription("emission-output", "Output", "Save the emission values of each vehicle");
126  oc.doRegister("emission-output.precision", new Option_Integer(2));
127  oc.addDescription("emission-output.precision", "Output", "Write emission values with the given precision (default 2)");
128 
129  oc.doRegister("battery-output", new Option_FileName());
130  oc.addDescription("battery-output", "Output", "Save the battery values of each vehicle");
131  oc.doRegister("battery-output.precision", new Option_Integer(2));
132  oc.addDescription("battery-output.precision", "Output", "Write battery values with the given precision (default 2)");
133 
134  oc.doRegister("chargingstations-output", new Option_FileName());
135  oc.addDescription("chargingstations-output", "Output", "Write data of charging stations");
136 
137  oc.doRegister("fcd-output", new Option_FileName());
138  oc.addDescription("fcd-output", "Output", "Save the Floating Car Data");
139  oc.doRegister("fcd-output.geo", new Option_Bool(false));
140  oc.addDescription("fcd-output.geo", "Output", "Save the Floating Car Data using geo-coordinates (lon/lat)");
141  oc.doRegister("fcd-output.signals", new Option_Bool(false));
142  oc.addDescription("fcd-output.signals", "Output", "Add the vehicle signal state to the FCD output (brake lights etc.)");
143  oc.doRegister("fcd-output.filter-edges.input-file", new Option_FileName());
144  oc.addDescription("fcd-output.filter-edges.input-file", "Output", "Restrict fcd output to the edge selection from the given input file");
145 
146 
147  oc.doRegister("full-output", new Option_FileName());
148  oc.addDescription("full-output", "Output", "Save a lot of information for each timestep (very redundant)");
149  oc.doRegister("queue-output", new Option_FileName());
150  oc.addDescription("queue-output", "Output", "Save the vehicle queues at the junctions (experimental)");
151  oc.doRegister("vtk-output", new Option_FileName());
152  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)");
153  oc.doRegister("amitran-output", new Option_FileName());
154  oc.addDescription("amitran-output", "Output", "Save the vehicle trajectories in the Amitran format");
155 
156 
157  oc.doRegister("summary-output", new Option_FileName());
158  oc.addSynonyme("summary-output", "summary");
159  oc.addDescription("summary-output", "Output", "Save aggregated vehicle departure info into FILE");
160 
161  oc.doRegister("tripinfo-output", new Option_FileName());
162  oc.addSynonyme("tripinfo-output", "tripinfo");
163  oc.addDescription("tripinfo-output", "Output", "Save single vehicle trip info into FILE");
164 
165  oc.doRegister("tripinfo-output.write-unfinished", new Option_Bool(false));
166  oc.addDescription("tripinfo-output.write-unfinished", "Output", "Write tripinfo output for vehicles which have not arrived at simulation end");
167 
168  oc.doRegister("vehroute-output", new Option_FileName());
169  oc.addSynonyme("vehroute-output", "vehroutes");
170  oc.addDescription("vehroute-output", "Output", "Save single vehicle route info into FILE");
171 
172  oc.doRegister("vehroute-output.exit-times", new Option_Bool(false));
173  oc.addSynonyme("vehroute-output.exit-times", "vehroutes.exit-times");
174  oc.addDescription("vehroute-output.exit-times", "Output", "Write the exit times for all edges");
175 
176  oc.doRegister("vehroute-output.last-route", new Option_Bool(false));
177  oc.addSynonyme("vehroute-output.last-route", "vehroutes.last-route");
178  oc.addDescription("vehroute-output.last-route", "Output", "Write the last route only");
179 
180  oc.doRegister("vehroute-output.sorted", new Option_Bool(false));
181  oc.addSynonyme("vehroute-output.sorted", "vehroutes.sorted");
182  oc.addDescription("vehroute-output.sorted", "Output", "Sorts the output by departure time");
183 
184  oc.doRegister("vehroute-output.dua", new Option_Bool(false));
185  oc.addSynonyme("vehroute-output.dua", "vehroutes.dua");
186  oc.addDescription("vehroute-output.dua", "Output", "Write the output in the duarouter alternatives style");
187 
188  oc.doRegister("vehroute-output.cost", new Option_Bool(false));
189  oc.addDescription("vehroute-output.cost", "Output", "Write costs for all routes");
190 
191  oc.doRegister("vehroute-output.intended-depart", new Option_Bool(false));
192  oc.addSynonyme("vehroute-output.intended-depart", "vehroutes.intended-depart");
193  oc.addDescription("vehroute-output.intended-depart", "Output", "Write the output with the intended instead of the real departure time");
194 
195  oc.doRegister("vehroute-output.route-length", new Option_Bool(false));
196  oc.addSynonyme("vehroute-output.route-length", "vehroutes.route-length");
197  oc.addDescription("vehroute-output.route-length", "Output", "Include total route length in the output");
198 
199  oc.doRegister("vehroute-output.write-unfinished", new Option_Bool(false));
200  oc.addDescription("vehroute-output.write-unfinished", "Output", "Write vehroute output for vehicles which have not arrived at simulation end");
201 
202  oc.doRegister("vehroute-output.skip-ptlines", new Option_Bool(false));
203  oc.addDescription("vehroute-output.skip-ptlines", "Output", "Skip vehroute output for public transport vehicles");
204 
205  oc.doRegister("link-output", new Option_FileName());
206  oc.addDescription("link-output", "Output", "Save links states into FILE");
207 
208  oc.doRegister("bt-output", new Option_FileName());
209  oc.addDescription("bt-output", "Output", "Save bluetooth visibilities into FILE (in conjunction with device.btreceiver and device.btsender)");
210 
211  oc.doRegister("lanechange-output", new Option_FileName());
212  oc.addDescription("lanechange-output", "Output", "Record lane changes and their motivations for all vehicles into FILE");
213 
214  oc.doRegister("lanechange-output.started", new Option_Bool(false));
215  oc.addDescription("lanechange-output.started", "Output", "Record start of lane change manoeuvres");
216 
217  oc.doRegister("lanechange-output.ended", new Option_Bool(false));
218  oc.addDescription("lanechange-output.ended", "Output", "Record end of lane change manoeuvres");
219 
220  oc.doRegister("stop-output", new Option_FileName());
221  oc.addDescription("stop-output", "Output", "Record stops and loading/unloading of passenger and containers for all vehicles into FILE");
222 
223 #ifdef _DEBUG
224  oc.doRegister("movereminder-output", new Option_FileName());
225  oc.addDescription("movereminder-output", "Output", "Save movereminder states of selected vehicles into FILE");
226  oc.doRegister("movereminder-output.vehicles", new Option_String());
227  oc.addDescription("movereminder-output.vehicles", "Output", "List of vehicle ids which shall save their movereminder states");
228 #endif
229 
230  oc.doRegister("save-state.times", new Option_IntVector(IntVector()));
231  oc.addDescription("save-state.times", "Output", "Use INT[] as times at which a network state written");
232  oc.doRegister("save-state.period", new Option_String("-1", "TIME"));
233  oc.addDescription("save-state.period", "Output", "save state repeatedly after TIME period");
234  oc.doRegister("save-state.prefix", new Option_FileName("state"));
235  oc.addDescription("save-state.prefix", "Output", "Prefix for network states");
236  oc.doRegister("save-state.suffix", new Option_String(".sbx"));
237  oc.addDescription("save-state.suffix", "Output", "Suffix for network states (.sbx or .xml)");
238  oc.doRegister("save-state.files", new Option_FileName());//
239  oc.addDescription("save-state.files", "Output", "Files for network states");
240 
241  // register the simulation settings
242  oc.doRegister("begin", 'b', new Option_String("0", "TIME"));
243  oc.addDescription("begin", "Time", "Defines the begin time in seconds; The simulation starts at this time");
244 
245  oc.doRegister("end", 'e', new Option_String("-1", "TIME"));
246  oc.addDescription("end", "Time", "Defines the end time in seconds; The simulation ends at this time");
247 
248  oc.doRegister("step-length", new Option_String("1", "TIME"));
249  oc.addDescription("step-length", "Time", "Defines the step duration in seconds");
250 
251  oc.doRegister("step-method.ballistic", new Option_Bool(false));
252  oc.addDescription("step-method.ballistic", "Processing", "Whether to use ballistic method for the positional update of vehicles (default is a semi-implicit Euler method).");
253 
254  oc.doRegister("lateral-resolution", new Option_Float(-1));
255  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");
256 
257  // register the processing options
258  oc.doRegister("route-steps", 's', new Option_String("200", "TIME"));
259  oc.addDescription("route-steps", "Processing", "Load routes for the next number of seconds ahead");
260 
261  oc.doRegister("no-internal-links", new Option_Bool(false));
262  oc.addDescription("no-internal-links", "Processing", "Disable (junction) internal links");
263 
264  oc.doRegister("ignore-junction-blocker", new Option_String("-1", "TIME"));
265  oc.addDescription("ignore-junction-blocker", "Processing", "Ignore vehicles which block the junction after they have been standing for SECONDS (-1 means never ignore)");
266 
267  oc.doRegister("ignore-route-errors", new Option_Bool(false));
268  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.");
269 
270  oc.doRegister("ignore-accidents", new Option_Bool(false));
271  oc.addDescription("ignore-accidents", "Processing", "Do not check whether accidents occur");
272 
273  oc.doRegister("collision.action", new Option_String("teleport"));
274  oc.addDescription("collision.action", "Processing", "How to deal with collisions: [none,warn,teleport,remove]");
275 
276  oc.doRegister("collision.stoptime", new Option_String("0", "TIME"));
277  oc.addDescription("collision.stoptime", "Processing", "Let vehicle stop for TIME before performing collision.action (except for action 'none')");
278 
279  oc.doRegister("collision.check-junctions", new Option_Bool(false));
280  oc.addDescription("collision.check-junctions", "Processing", "Enables collisions checks on junctions");
281 
282  oc.doRegister("collision.mingap-factor", new Option_Float(-1));
283  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");
284 
285  oc.doRegister("max-num-vehicles", new Option_Integer(-1));
286  oc.addDescription("max-num-vehicles", "Processing", "Delay vehicle insertion to stay within the given maximum number");
287 
288  oc.doRegister("max-num-teleports", new Option_Integer(-1));
289  oc.addDescription("max-num-teleports", "Processing", "Abort the simulation if the given maximum number of teleports is exceeded");
290 
291  oc.doRegister("scale", new Option_Float(1.));
292  oc.addDescription("scale", "Processing", "Scale demand by the given factor (by discarding or duplicating vehicles)");
293 
294  oc.doRegister("time-to-teleport", new Option_String("300", "TIME"));
295  oc.addDescription("time-to-teleport", "Processing", "Specify how long a vehicle may wait until being teleported, defaults to 300, non-positive values disable teleporting");
296 
297  oc.doRegister("time-to-teleport.highways", new Option_String("0", "TIME"));
298  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");
299 
300  oc.doRegister("waiting-time-memory", new Option_String("100", "TIME"));
301  oc.addDescription("waiting-time-memory", "Processing", "Length of time interval, over which accumulated waiting time is taken into account (default is 100s.)");
302 
303  oc.doRegister("max-depart-delay", new Option_String("-1", "TIME"));
304  oc.addDescription("max-depart-delay", "Processing", "How long vehicles wait for departure before being skipped, defaults to -1 which means vehicles are never skipped");
305 
306  oc.doRegister("sloppy-insert", new Option_Bool(false));
307  oc.addDescription("sloppy-insert", "Processing", "Whether insertion on an edge shall not be repeated in same step once failed");
308 
309  oc.doRegister("eager-insert", new Option_Bool(false));
310  oc.addDescription("eager-insert", "Processing", "Whether each vehicle is checked separately for insertion on an edge");
311 
312  oc.doRegister("random-depart-offset", new Option_String("0", "TIME"));
313  oc.addDescription("random-depart-offset", "Processing", "Each vehicle receives a random offset to its depart value drawn uniformly from [0, TIME]");
314 
315  oc.doRegister("lanechange.duration", new Option_String("0", "TIME"));
316  oc.addDescription("lanechange.duration", "Processing", "Duration of a lane change maneuver (default 0)");
317 
318  oc.doRegister("lanechange.overtake-right", new Option_Bool(false));
319  oc.addDescription("lanechange.overtake-right", "Processing", "Whether overtaking on the right on motorways is permitted");
320 
321  oc.doRegister("tls.all-off", new Option_Bool(false));
322  oc.addDescription("tls.all-off", "Processing", "Switches off all traffic lights.");
323 
324  oc.doRegister("time-to-impatience", new Option_String("300", "TIME"));
325  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");
326 
327  oc.doRegister("default.action-step-length", new Option_Float(0.0));
328  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.");
329 
330  oc.doRegister("default.carfollowmodel", new Option_String("Krauss"));
331  oc.addDescription("default.carfollowmodel", "Processing", "Select default car following model (Krauss, IDM, ...)");
332  oc.addSynonyme("default.carfollowmodel", "carfollow.model", false);
333 
334  oc.doRegister("default.speeddev", new Option_Float(-1));
335  oc.addDescription("default.speeddev", "Processing", "Select default speed deviation. A negative value implies vClass specific defaults (0.1 for the default passenger class");
336 
337  oc.doRegister("default.emergencydecel", new Option_String("default"));
338  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");
339 
340  oc.doRegister("emergencydecel.warning-threshold", new Option_Float(1));
341  oc.addDescription("emergencydecel.warning-threshold", "Processing", "Sets the fraction of emergency decel capability that must be used to trigger a warning.");
342 
343  // pedestrian model
344  oc.doRegister("pedestrian.model", new Option_String("striping"));
345  oc.addDescription("pedestrian.model", "Processing", "Select among pedestrian models ['nonInteracting', 'striping', 'remote']");
346 
347  oc.doRegister("pedestrian.striping.stripe-width", new Option_Float(0.64));
348  oc.addDescription("pedestrian.striping.stripe-width", "Processing", "Width of parallel stripes for segmenting a sidewalk (meters) for use with model 'striping'");
349 
350  oc.doRegister("pedestrian.striping.dawdling", new Option_Float(0.2));
351  oc.addDescription("pedestrian.striping.dawdling", "Processing", "factor for random slow-downs [0,1] for use with model 'striping'");
352 
353  oc.doRegister("pedestrian.striping.jamtime", new Option_String("300", "TIME"));
354  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)");
355 
356  oc.doRegister("pedestrian.remote.address", new Option_String("localhost:9000"));
357  oc.addDescription("pedestrian.remote.address", "Processing", "The address (host:port) of the external simulation");
358 
359  // generic routing options
360  oc.doRegister("routing-algorithm", new Option_String("dijkstra"));
361  oc.addDescription("routing-algorithm", "Routing",
362  "Select among routing algorithms ['dijkstra', 'astar', 'CH', 'CHWrapper']");
363  oc.doRegister("weights.random-factor", new Option_Float(1.));
364  oc.addDescription("weights.random-factor", "Routing", "Edge weights for routing are dynamically disturbed by a random factor drawn uniformly from [1,FLOAT)");
365 
366  oc.doRegister("astar.all-distances", new Option_FileName());
367  oc.addDescription("astar.all-distances", "Routing", "Initialize lookup table for astar from the given file (generated by marouter --all-pairs-output)");
368 
369  oc.doRegister("astar.landmark-distances", new Option_FileName());
370  oc.addDescription("astar.landmark-distances", "Routing", "Initialize lookup table for astar ALT-variant from the given file");
371 
372  oc.doRegister("persontrip.walkfactor", new Option_Float(double(0.75)));
373  oc.addDescription("persontrip.walkfactor", "Routing", "Use FLOAT as a factor on pedestrian maximum speed during intermodal routing");
374 
375  oc.doRegister("persontrip.transfer.car-walk", new Option_String("parkingAreas"));
376  oc.addDescription("persontrip.transfer.car-walk", "Routing", "Where are mode changes from car to walking allowed (possible values: 'parkingAreas', 'ptStops', 'allJunctions' and combinations)");
377 
378  // devices
379  oc.addOptionSubTopic("Emissions");
380  oc.doRegister("phemlight-path", new Option_FileName("./PHEMlight/"));
381  oc.addDescription("phemlight-path", "Emissions", "Determines where to load PHEMlight definitions from.");
382 
383  oc.addOptionSubTopic("Communication");
384  oc.addOptionSubTopic("Battery");
386 
387  // register report options
388  oc.doRegister("duration-log.disable", new Option_Bool(false));
389  oc.addSynonyme("duration-log.disable", "no-duration-log", false);
390  oc.addDescription("duration-log.disable", "Report", "Disable performance reports for individual simulation steps");
391 
392  oc.doRegister("duration-log.statistics", new Option_Bool(false));
393  oc.addDescription("duration-log.statistics", "Report", "Enable statistics on vehicle trips");
394 
395  oc.doRegister("no-step-log", new Option_Bool(false));
396  oc.addDescription("no-step-log", "Report", "Disable console output of current simulation step");
397 
398  //remote port 0 if not used
399  oc.addOptionSubTopic("TraCI Server");
400  oc.doRegister("remote-port", new Option_Integer(0));
401  oc.addDescription("remote-port", "TraCI Server", "Enables TraCI Server if set");
402  oc.doRegister("num-clients", new Option_Integer(1));
403  oc.addDescription("num-clients", "TraCI Server", "Expected number of connecting clients");
404 #ifdef HAVE_PYTHON
405  oc.doRegister("python-script", new Option_String());
406  oc.addDescription("python-script", "TraCI Server", "Runs TraCI script with embedded python");
407 #endif
408  //
409  oc.addOptionSubTopic("Mesoscopic");
410  oc.doRegister("mesosim", new Option_Bool(false));
411  oc.addDescription("mesosim", "Mesoscopic", "Enables mesoscopic simulation");
412  oc.doRegister("meso-edgelength", new Option_Float(98.0f));
413  oc.addDescription("meso-edgelength", "Mesoscopic", "Length of an edge segment in mesoscopic simulation");
414  oc.doRegister("meso-tauff", new Option_String("1.13", "TIME"));
415  oc.addDescription("meso-tauff", "Mesoscopic", "Factor for calculating the net free-free headway time");
416  oc.doRegister("meso-taufj", new Option_String("1.13", "TIME"));
417  oc.addDescription("meso-taufj", "Mesoscopic", "Factor for calculating the net free-jam headway time");
418  oc.doRegister("meso-taujf", new Option_String("1.73", "TIME"));
419  oc.addDescription("meso-taujf", "Mesoscopic", "Factor for calculating the jam-free headway time");
420  oc.doRegister("meso-taujj", new Option_String("1.4", "TIME"));
421  oc.addDescription("meso-taujj", "Mesoscopic", "Factor for calculating the jam-jam headway time");
422  oc.doRegister("meso-jam-threshold", new Option_Float(-1));
423  oc.addDescription("meso-jam-threshold", "Mesoscopic",
424  "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)");
425  oc.doRegister("meso-multi-queue", new Option_Bool(true));
426  oc.addDescription("meso-multi-queue", "Mesoscopic", "Enable multiple queues at edge ends");
427  oc.doRegister("meso-junction-control", new Option_Bool(false));
428  oc.addDescription("meso-junction-control", "Mesoscopic", "Enable mesoscopic traffic light and priority junction handling");
429  oc.doRegister("meso-junction-control.limited", new Option_Bool(false));
430  oc.addDescription("meso-junction-control.limited", "Mesoscopic",
431  "Enable mesoscopic traffic light and priority junction handling for saturated links. This prevents faulty traffic lights from hindering flow in low-traffic situations");
432  oc.doRegister("meso-tls-penalty", new Option_Float(0));
433  oc.addDescription("meso-tls-penalty", "Mesoscopic",
434  "Apply scaled time penalties when driving across tls controlled junctions based on green split instead of checking actual phases");
435  oc.doRegister("meso-minor-penalty", new Option_String("0", "TIME"));
436  oc.addDescription("meso-minor-penalty", "Mesoscopic",
437  "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.");
438  oc.doRegister("meso-overtaking", new Option_Bool(false));
439  oc.addDescription("meso-overtaking", "Mesoscopic", "Enable mesoscopic overtaking");
440  oc.doRegister("meso-recheck", new Option_String("0", "TIME"));
441  oc.addDescription("meso-recheck", "Mesoscopic", "Time interval for rechecking insertion into the next segment after failure");
442 
443  // add rand options
445 
446  // add GUI options
447  // the reason that we include them in vanilla sumo as well is to make reusing config files easy
448  oc.addOptionSubTopic("GUI Only");
449  oc.doRegister("gui-settings-file", 'g', new Option_FileName());
450  oc.addDescription("gui-settings-file", "GUI Only", "Load visualisation settings from FILE");
451 
452  oc.doRegister("quit-on-end", 'Q', new Option_Bool(false));
453  oc.addDescription("quit-on-end", "GUI Only", "Quits the GUI when the simulation stops");
454 
455  oc.doRegister("game", 'G', new Option_Bool(false));
456  oc.addDescription("game", "GUI Only", "Start the GUI in gaming mode");
457 
458  oc.doRegister("start", 'S', new Option_Bool(false));
459  oc.addDescription("start", "GUI Only", "Start the simulation after loading");
460 
461  oc.doRegister("breakpoints", new Option_String());
462  oc.addDescription("breakpoints", "GUI Only", "Use TIME[] as times when the simulation should halt");
463 
464  oc.doRegister("demo", 'D', new Option_Bool(false));
465  oc.addDescription("demo", "GUI Only", "Restart the simulation after ending (demo mode)");
466 
467  oc.doRegister("disable-textures", 'T', new Option_Bool(false));
468  oc.addDescription("disable-textures", "GUI Only", "Do not load background pictures");
469 
470  oc.doRegister("registry-viewport", new Option_Bool(false));
471  oc.addDescription("registry-viewport", "GUI Only", "Load current viewport from registry");
472 
473  oc.doRegister("window-size", new Option_String());
474  oc.addDescription("window-size", "GUI Only", "Create initial window with the given x,y size");
475 
476  oc.doRegister("window-pos", new Option_String());
477  oc.addDescription("window-pos", "GUI Only", "Create initial window at the given x,y position");
478 
479  oc.doRegister("tracker-interval", new Option_Float(1.0));
480  oc.addDescription("tracker-interval", "GUI Only", "The aggregation period for value tracker windows");
481 
482 #ifdef HAVE_OSG
483  oc.doRegister("osg-view", new Option_Bool(false));
484  oc.addDescription("osg-view", "GUI Only", "Start with an OpenSceneGraph view instead of the regular 2D view");
485 #endif
486 
487  // gui testing
488  oc.doRegister("gui-testing", new Option_Bool(false));
489  oc.addDescription("gui-testing", "GUI Only", "Enable ovelay for screen recognition");
490 
491  // gui testing - debug
492  oc.doRegister("gui-testing-debug", new Option_Bool(false));
493  oc.addDescription("gui-testing-debug", "GUI Only", "Enable output messages during GUI-Testing");
494 }
495 
496 
497 void
499  // standard outputs
500  OutputDevice::createDeviceByOption("netstate-dump", "netstate", "netstate_file.xsd");
501  OutputDevice::createDeviceByOption("summary-output", "summary", "summary_file.xsd");
502  OutputDevice::createDeviceByOption("tripinfo-output", "tripinfos", "tripinfo_file.xsd");
503 
504  //extended
505  OutputDevice::createDeviceByOption("fcd-output", "fcd-export", "fcd_file.xsd");
506  OutputDevice::createDeviceByOption("emission-output", "emission-export", "emission_file.xsd");
507  OutputDevice::createDeviceByOption("battery-output", "battery-export");
508  OutputDevice::createDeviceByOption("chargingstations-output", "chargingstations-export");
509  OutputDevice::createDeviceByOption("full-output", "full-export", "full_file.xsd");
510  OutputDevice::createDeviceByOption("queue-output", "queue-export", "queue_file.xsd");
511  OutputDevice::createDeviceByOption("amitran-output", "trajectories", "amitran/trajectories.xsd\" timeStepSize=\"" + toString(STEPS2MS(DELTA_T)));
512 
513  //OutputDevice::createDeviceByOption("vtk-output", "vtk-export");
514  OutputDevice::createDeviceByOption("link-output", "link-output");
515  OutputDevice::createDeviceByOption("bt-output", "bt-output");
516  OutputDevice::createDeviceByOption("lanechange-output", "lanechanges");
517  OutputDevice::createDeviceByOption("stop-output", "stops", "stopinfo_file.xsd");
518 
519 #ifdef _DEBUG
520  OutputDevice::createDeviceByOption("movereminder-output", "movereminder-output");
521 #endif
522 
524  MSStopOut::init();
525 }
526 
527 
528 bool
531  bool ok = true;
532  if (!oc.isSet("net-file")) {
533  WRITE_ERROR("No network file (-n) specified.");
534  ok = false;
535  }
536  if (oc.getFloat("scale") < 0.) {
537  WRITE_ERROR("Invalid scaling factor.");
538  ok = false;
539  }
540  if (oc.getBool("vehroute-output.exit-times") && !oc.isSet("vehroute-output")) {
541  WRITE_ERROR("A vehroute-output file is needed for exit times.");
542  ok = false;
543  }
544  if (oc.isSet("gui-settings-file") &&
545  oc.getString("gui-settings-file") != "" &&
546  !oc.isUsableFileList("gui-settings-file")) {
547  ok = false;
548  }
549  if (oc.getBool("demo") && oc.isDefault("start")) {
550  oc.set("start", "true");
551  }
552  if (oc.getBool("demo") && oc.getBool("quit-on-end")) {
553  WRITE_ERROR("You can either restart or quit on end.");
554  ok = false;
555  }
556  if (oc.getBool("meso-junction-control.limited") && !oc.getBool("meso-junction-control")) {
557  oc.set("meso-junction-control", "true");
558  }
559  if (oc.getBool("mesosim") && oc.isDefault("pedestrian.model")) {
560  oc.set("pedestrian.model", "nonInteracting");
561  }
562  const SUMOTime begin = string2time(oc.getString("begin"));
563  const SUMOTime end = string2time(oc.getString("end"));
564  if (begin < 0) {
565  WRITE_ERROR("The begin time should not be negative.");
566  ok = false;
567  }
568  if (end != string2time("-1")) {
569  if (end < begin) {
570  WRITE_ERROR("The end time should be after the begin time.");
571  ok = false;
572  }
573  }
574  if (string2time(oc.getString("step-length")) <= 0) {
575  WRITE_ERROR("the minimum step-length is 0.001");
576  ok = false;
577  }
578 #ifdef _DEBUG
579  if (oc.isSet("movereminder-output.vehicles") && !oc.isSet("movereminder-output")) {
580  WRITE_ERROR("option movereminder-output.vehicles requires option movereminder-output to be set");
581  ok = false;
582  }
583 #endif
584  if (oc.getBool("sloppy-insert")) {
585  WRITE_WARNING("The option 'sloppy-insert' is deprecated, because it is now activated by default, see the new option 'eager-insert'.");
586  }
587  if (string2time(oc.getString("lanechange.duration")) > 0 && oc.getFloat("lateral-resolution") > 0) {
588  WRITE_ERROR("Only one of the options 'lanechange.duration' or 'lateral-resolution' may be given.");
589  }
590  if (oc.getBool("ignore-accidents")) {
591  WRITE_WARNING("The option 'ignore-accidents' is deprecated. Use 'collision.action none' instead.");
592  }
593 #ifdef HAVE_PYTHON
594  if (oc.isSet("python-script")) {
595  WRITE_WARNING("The option 'python-script' is deprecated. Use libsumo or TraCI instead.");
596  }
597 #endif
598  if (oc.getBool("duration-log.statistics") && oc.isDefault("verbose")) {
599  oc.set("verbose", "true");
600  }
601  if (oc.isDefault("precision") && string2time(oc.getString("step-length")) < 10) {
602  oc.set("precision", "3");
603  }
604  if (oc.isDefault("tracker-interval") && !oc.isDefault("step-length")) {
605  oc.set("tracker-interval", oc.getString("step-length"));
606  }
607  if (oc.getInt("precision") > 2) {
608  if (oc.isDefault("netstate-dump.precision")) {
609  oc.set("netstate-dump.precision", toString(oc.getInt("precision")));
610  }
611  if (oc.isDefault("emission-output.precision")) {
612  oc.set("emission-output.precision", toString(oc.getInt("precision")));
613  }
614  if (oc.isDefault("battery-output.precision")) {
615  oc.set("battery-output.precision", toString(oc.getInt("precision")));
616  }
617  }
618  if (!SUMOXMLDefinitions::CarFollowModels.hasString(oc.getString("carfollow.model"))) {
619  WRITE_ERROR("Unknown model '" + oc.getString("carfollow.model") + "' for option 'carfollow.model'.");
620  ok = false;
621  }
622  if (oc.isSet("default.emergencydecel")) {
623  const std::string val = oc.getString("default.emergencydecel");
624  if (val != "default" && val != "decel") {
625  try {
627  } catch (NumberFormatException&) {
628  WRITE_ERROR("Invalid value '" + val + "' for option 'default.emergencydecel'. Must be a FLOAT or 'default' or 'decel'");
629  ok = false;
630  }
631  }
632  }
633  for (const std::string& val : oc.getStringVector("breakpoints")) {
634  try {
635  string2time(val);
636  } catch (ProcessError& e) {
637  WRITE_ERROR("Invalid time '" + val + "' for option 'breakpoints'." + e.what());
638  ok = false;
639  }
640  };
641 
642  ok &= MSDevice::checkOptions(oc);
644 
645  return ok;
646 }
647 
648 
649 void
651  // pre-initialise the network
652  // set whether empty edges shall be printed on dump
653  MSGlobals::gOmitEmptyEdgesOnDump = !oc.getBool("netstate-dump.empty-edges");
654  // set whether internal lanes shall be used
655  MSGlobals::gUsingInternalLanes = !oc.getBool("no-internal-links");
656  MSGlobals::gIgnoreJunctionBlocker = string2time(oc.getString("ignore-junction-blocker")) < 0 ?
657  std::numeric_limits<SUMOTime>::max() : string2time(oc.getString("ignore-junction-blocker"));
658  // set the grid lock time
659  MSGlobals::gTimeToGridlock = string2time(oc.getString("time-to-teleport")) < 0 ? 0 : string2time(oc.getString("time-to-teleport"));
660  MSGlobals::gTimeToImpatience = string2time(oc.getString("time-to-impatience"));
661  MSGlobals::gTimeToGridlockHighways = string2time(oc.getString("time-to-teleport.highways")) < 0 ? 0 : string2time(oc.getString("time-to-teleport.highways"));
662  MSGlobals::gCheck4Accidents = !oc.getBool("ignore-accidents");
663  MSGlobals::gCheckRoutes = !oc.getBool("ignore-route-errors");
664  MSGlobals::gLaneChangeDuration = string2time(oc.getString("lanechange.duration"));
665  MSGlobals::gLateralResolution = oc.getFloat("lateral-resolution");
666  MSGlobals::gStateLoaded = oc.isSet("load-state");
667  MSGlobals::gUseMesoSim = oc.getBool("mesosim");
668  MSGlobals::gMesoLimitedJunctionControl = oc.getBool("meso-junction-control.limited");
669  MSGlobals::gMesoOvertaking = oc.getBool("meso-overtaking");
670  MSGlobals::gMesoTLSPenalty = oc.getFloat("meso-tls-penalty");
671  MSGlobals::gMesoMinorPenalty = string2time(oc.getString("meso-minor-penalty"));
674  }
675  MSGlobals::gWaitingTimeMemory = string2time(oc.getString("waiting-time-memory"));
678 
679  DELTA_T = string2time(oc.getString("step-length"));
680 
681 
682  bool integrationMethodSet = !oc.isDefault("step-method.ballistic");
683  bool actionStepLengthSet = !oc.isDefault("default.action-step-length");
684  MSGlobals::gSemiImplicitEulerUpdate = !oc.getBool("step-method.ballistic");
685  // Init default value for gActionStepLength
686  if (MSGlobals::gSemiImplicitEulerUpdate && actionStepLengthSet && !integrationMethodSet) {
687  WRITE_MESSAGE("Integration method was set to 'ballistic', since a default action step length was specified.");
689  }
690  double givenDefaultActionStepLength = oc.getFloat("default.action-step-length");
692 
693  const std::string defaultEmergencyDecelOption = OptionsCont::getOptions().getString("default.emergencydecel");
694  if (defaultEmergencyDecelOption == "default") {
696  } else if (defaultEmergencyDecelOption == "decel") {
698  } else {
699  // value already checked in checkOptions()
700  MSGlobals::gDefaultEmergencyDecel = StringUtils::toDouble(defaultEmergencyDecelOption);
701  }
702 
703  MSGlobals::gEmergencyDecelWarningThreshold = oc.getFloat("emergencydecel.warning-threshold");
704 
705 #ifdef _DEBUG
706  if (oc.isSet("movereminder-output")) {
707  MSBaseVehicle::initMoveReminderOutput(oc);
708  }
709 #endif
710 }
711 
712 
713 
714 /****************************************************************************/
715 
static bool gOmitEmptyEdgesOnDump
Information whether empty edges shall be written on dump.
Definition: MSGlobals.h:52
void doRegister(const std::string &name, Option *v)
Adds an option under the given name.
Definition: OptionsCont.cpp:75
static double gLateralResolution
Definition: MSGlobals.h:85
static StringBijection< SumoXMLTag > CarFollowModels
car following models
static void insertRandOptions()
Initialises the given options container with random number options.
Definition: RandHelper.cpp:43
long long int SUMOTime
Definition: SUMOTime.h:36
static void init()
Static intialization.
Definition: MSStopOut.cpp:41
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:65
static double gMesoTLSPenalty
Definition: MSGlobals.h:100
static void buildStreams()
Builds the streams used possibly by the simulation.
Definition: MSFrame.cpp:498
void addCallExample(const std::string &example, const std::string &desc)
Add a call example.
const int VTYPEPARS_DEFAULT_EMERGENCYDECEL_DECEL
static bool gStateLoaded
Information whether a state has been loaded.
Definition: MSGlobals.h:88
static double gEmergencyDecelWarningThreshold
treshold for warning about strong deceleration
Definition: MSGlobals.h:124
static SUMOTime processActionStepLength(double given)
Checks and converts given value for the action step length from seconds to miliseconds assuring it be...
SUMOTime DELTA_T
Definition: SUMOTime.cpp:35
static void initCollisionOptions(const OptionsCont &oc)
Definition: MSLane.cpp:3451
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:97
static void addConfigurationOptions(OptionsCont &oc)
Adds configuration options to the given container.
Definition: SystemFrame.cpp:40
#define WRITE_WARNING(msg)
Definition: MsgHandler.h:241
static OptionsCont & getOptions()
Retrieves the options.
Definition: OptionsCont.cpp:58
static bool gCheck4Accidents
Definition: MSGlobals.h:76
static void fillOptions()
Inserts options used by the simulation into the OptionsCont-singleton.
Definition: MSFrame.cpp:61
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
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:66
std::string toString(const T &t, std::streamsize accuracy=gPrecision)
Definition: ToString.h:49
std::vector< int > IntVector
Definition of a vector of ints.
Definition: Option.h:41
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:79
static double toDouble(const std::string &sData)
converts a string into the double value described by it by calling the char-type converter ...
std::string getString(const std::string &name) const
Returns the string-value of the named option (only for Option_String)
static double gDefaultEmergencyDecel
encoding of the string-option default.emergencydecel
Definition: MSGlobals.h:115
SUMOTime string2time(const std::string &r)
Definition: SUMOTime.cpp:42
static SUMOTime gMesoMinorPenalty
Definition: MSGlobals.h:103
std::vector< std::string > getStringVector(const std::string &name) const
Returns the list of string-vector-value of the named option (only for Option_String) ...
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:69
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:82
static bool checkOptions()
Checks the set options.
Definition: MSFrame.cpp:529
#define WRITE_ERROR(msg)
Definition: MsgHandler.h:247
static SUMOTime gActionStepLength
default value for the interval between two action points for MSVehicle (defaults to DELTA_T) ...
Definition: MSGlobals.h:112
static SUMOTime gTimeToGridlockHighways
Definition: MSGlobals.h:63
bool set(const std::string &name, const std::string &value)
Sets the given value for the named option.
An integer-option.
Definition: Option.h:333
void addXMLDefault(const std::string &name, const std::string &xmlRoot="")
Adds an XML root element to handle by default. The special root "" denotes the default handler...
A storage for options typed value containers)
Definition: OptionsCont.h:92
const int VTYPEPARS_DEFAULT_EMERGENCYDECEL_DEFAULT
static SUMOTime gTimeToGridlock
Definition: MSGlobals.h:60
static void insertOptions(OptionsCont &oc)
Inserts options for building devices.
Definition: MSDevice.cpp:66
static SUMOTime gWaitingTimeMemory
length of memory for waiting times (in millisecs)
Definition: MSGlobals.h:109
static SUMOTime gIgnoreJunctionBlocker
Definition: MSGlobals.h:73
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:56
static void setMSGlobals(OptionsCont &oc)
Sets the global microsim-options.
Definition: MSFrame.cpp:650
void addDescription(const std::string &name, const std::string &subtopic, const std::string &description)
Adds a description for an option.
#define WRITE_MESSAGE(msg)
Definition: MsgHandler.h:242
static SUMOTime gLaneChangeDuration
Definition: MSGlobals.h:82
static bool gUseMesoSim
Definition: MSGlobals.h:91
static bool gMesoLimitedJunctionControl
Definition: MSGlobals.h:94
#define STEPS2MS(x)
Definition: SUMOTime.h:62