Line data Source code
1 : /****************************************************************************/
2 : // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
3 : // Copyright (C) 2001-2024 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 : /****************************************************************************/
14 : /// @file RODUAFrame.cpp
15 : /// @author Daniel Krajzewicz
16 : /// @author Jakob Erdmann
17 : /// @author Michael Behrisch
18 : /// @date Sept 2002
19 : ///
20 : // Sets and checks options for dua-routing
21 : /****************************************************************************/
22 : #include <config.h>
23 :
24 : #include <iostream>
25 : #include <fstream>
26 : #include <ctime>
27 : #include <utils/options/OptionsCont.h>
28 : #include <utils/options/Option.h>
29 : #include <utils/common/MsgHandler.h>
30 : #include <utils/common/UtilExceptions.h>
31 : #include <utils/common/ToString.h>
32 : #include "RODUAFrame.h"
33 : #include <router/ROFrame.h>
34 : #include <utils/common/RandHelper.h>
35 : #include <utils/common/SystemFrame.h>
36 : #include <utils/vehicle/SUMOVehicleParameter.h>
37 :
38 :
39 : // ===========================================================================
40 : // method definitions
41 : // ===========================================================================
42 : void
43 9358 : RODUAFrame::fillOptions() {
44 9358 : OptionsCont& oc = OptionsCont::getOptions();
45 18716 : oc.addCallExample("-c <CONFIGURATION>", "run routing with options from file");
46 :
47 : // insert options sub-topics
48 9358 : SystemFrame::addConfigurationOptions(oc); // fill this subtopic, too
49 9358 : oc.addOptionSubTopic("Input");
50 9358 : oc.addOptionSubTopic("Output");
51 9358 : oc.addOptionSubTopic("Processing");
52 9358 : oc.addOptionSubTopic("Defaults");
53 9358 : oc.addOptionSubTopic("Time");
54 :
55 : // insert options
56 9358 : ROFrame::fillOptions(oc, true);
57 9358 : addImportOptions();
58 9358 : addDUAOptions();
59 : // add rand options
60 9358 : RandHelper::insertRandOptions(oc);
61 9358 : }
62 :
63 :
64 : void
65 9358 : RODUAFrame::addImportOptions() {
66 9358 : OptionsCont& oc = OptionsCont::getOptions();
67 9358 : oc.doRegister("alternatives-output", new Option_FileName());
68 18716 : oc.addSynonyme("alternatives-output", "alternatives");
69 18716 : oc.addDescription("alternatives-output", "Output", TL("Write generated route alternatives to FILE"));
70 :
71 9358 : oc.doRegister("intermodal-network-output", new Option_FileName());
72 18716 : oc.addDescription("intermodal-network-output", "Output", TL("Write edge splits and connectivity to FILE"));
73 :
74 9358 : oc.doRegister("intermodal-weight-output", new Option_FileName());
75 18716 : oc.addDescription("intermodal-weight-output", "Output", TL("Write intermodal edges with lengths and travel times to FILE"));
76 :
77 9358 : oc.doRegister("write-trips", new Option_Bool(false));
78 18716 : oc.addDescription("write-trips", "Output", TL("Write trips instead of vehicles (for validating trip input)"));
79 :
80 9358 : oc.doRegister("write-trips.geo", new Option_Bool(false));
81 18716 : oc.addDescription("write-trips.geo", "Output", TL("Write trips with geo-coordinates"));
82 :
83 9358 : oc.doRegister("write-trips.junctions", new Option_Bool(false));
84 18716 : oc.addDescription("write-trips.junctions", "Output", TL("Write trips with fromJunction and toJunction"));
85 :
86 9358 : oc.doRegister("write-costs", new Option_Bool(false));
87 18716 : oc.addDescription("write-costs", "Output", TL("Include the cost attribute in route output"));
88 :
89 : // register further processing options
90 : // ! The subtopic "Processing" must be initialised earlier !
91 9358 : oc.doRegister("weights.random-factor", new Option_Float(1.));
92 18716 : oc.addDescription("weights.random-factor", "Processing", TL("Edge weights for routing are dynamically disturbed by a random factor drawn uniformly from [1,FLOAT)"));
93 :
94 18716 : oc.doRegister("weight-period", new Option_String("3600", "TIME"));
95 18716 : oc.addDescription("weight-period", "Processing", TL("Aggregation period for the given weight files; triggers rebuilding of Contraction Hierarchy"));
96 :
97 9358 : oc.doRegister("weights.priority-factor", new Option_Float(0));
98 18716 : oc.addDescription("weights.priority-factor", "Processing", TL("Consider edge priorities in addition to travel times, weighted by factor"));
99 :
100 9358 : oc.doRegister("astar.all-distances", new Option_FileName());
101 18716 : oc.addDescription("astar.all-distances", "Processing", TL("Initialize lookup table for astar from the given file (generated by marouter --all-pairs-output)"));
102 :
103 9358 : oc.doRegister("astar.landmark-distances", new Option_FileName());
104 18716 : oc.addDescription("astar.landmark-distances", "Processing", TL("Initialize lookup table for astar ALT-variant from the given file"));
105 :
106 9358 : oc.doRegister("astar.save-landmark-distances", new Option_FileName());
107 18716 : oc.addDescription("astar.save-landmark-distances", "Processing", TL("Save lookup table for astar ALT-variant to the given file"));
108 9358 : }
109 :
110 :
111 : void
112 9358 : RODUAFrame::addDUAOptions() {
113 9358 : OptionsCont& oc = OptionsCont::getOptions();
114 : // register Gawron's DUE-settings
115 9358 : oc.doRegister("gawron.beta", new Option_Float(double(0.9)));
116 18716 : oc.addSynonyme("gawron.beta", "gBeta", true);
117 18716 : oc.addDescription("gawron.beta", "Processing", TL("Use FLOAT as Gawron's beta"));
118 :
119 9358 : oc.doRegister("gawron.a", new Option_Float(double(0.5)));
120 18716 : oc.addSynonyme("gawron.a", "gA", true);
121 18716 : oc.addDescription("gawron.a", "Processing", TL("Use FLOAT as Gawron's a"));
122 :
123 9358 : oc.doRegister("exit-times", new Option_Bool(false));
124 18716 : oc.addDescription("exit-times", "Output", TL("Write exit times (weights) for each edge"));
125 :
126 9358 : oc.doRegister("route-length", new Option_Bool(false));
127 18716 : oc.addDescription("route-length", "Output", TL("Include total route length in the output"));
128 :
129 9358 : oc.doRegister("keep-all-routes", new Option_Bool(false));
130 18716 : oc.addDescription("keep-all-routes", "Processing", TL("Save routes with near zero probability"));
131 :
132 9358 : oc.doRegister("skip-new-routes", new Option_Bool(false));
133 18716 : oc.addDescription("skip-new-routes", "Processing", TL("Only reuse routes from input, do not calculate new ones"));
134 :
135 9358 : oc.doRegister("keep-route-probability", new Option_Float(0));
136 18716 : oc.addDescription("keep-route-probability", "Processing", TL("The probability of keeping the old route"));
137 :
138 9358 : oc.doRegister("ptline-routing", new Option_Bool(false));
139 18716 : oc.addDescription("ptline-routing", "Processing", TL("Route all public transport input"));
140 :
141 18716 : oc.doRegister("route-choice-method", new Option_String("gawron"));
142 18716 : oc.addDescription("route-choice-method", "Processing", TL("Choose a route choice method: gawron, logit, or lohse"));
143 :
144 9358 : oc.doRegister("logit", new Option_Bool(false)); // deprecated
145 18716 : oc.addDescription("logit", "Processing", TL("Use c-logit model (deprecated in favor of --route-choice-method logit)"));
146 :
147 9358 : oc.doRegister("logit.beta", new Option_Float(double(-1)));
148 18716 : oc.addSynonyme("logit.beta", "lBeta", true);
149 18716 : oc.addDescription("logit.beta", "Processing", TL("Use FLOAT as logit's beta"));
150 :
151 9358 : oc.doRegister("logit.gamma", new Option_Float(double(1)));
152 18716 : oc.addSynonyme("logit.gamma", "lGamma", true);
153 18716 : oc.addDescription("logit.gamma", "Processing", TL("Use FLOAT as logit's gamma"));
154 :
155 9358 : oc.doRegister("logit.theta", new Option_Float(double(-1)));
156 18716 : oc.addSynonyme("logit.theta", "lTheta", true);
157 18716 : oc.addDescription("logit.theta", "Processing", TL("Use FLOAT as logit's theta (negative values mean auto-estimation)"));
158 :
159 9358 : oc.doRegister("persontrip.walkfactor", new Option_Float(double(0.75)));
160 18716 : oc.addDescription("persontrip.walkfactor", "Processing", TL("Use FLOAT as a factor on pedestrian maximum speed during intermodal routing"));
161 :
162 9358 : oc.doRegister("persontrip.walk-opposite-factor", new Option_Float(1.0));
163 18716 : oc.addDescription("persontrip.walk-opposite-factor", "Processing", TL("Use FLOAT as a factor on walking speed against vehicle traffic direction"));
164 :
165 37432 : oc.doRegister("persontrip.transfer.car-walk", new Option_StringVector(StringVector({ "parkingAreas" })));
166 18716 : oc.addDescription("persontrip.transfer.car-walk", "Processing",
167 : "Where are mode changes from car to walking allowed (possible values: 'parkingAreas', 'ptStops', 'allJunctions' and combinations)");
168 :
169 9358 : oc.doRegister("persontrip.transfer.taxi-walk", new Option_StringVector());
170 18716 : oc.addDescription("persontrip.transfer.taxi-walk", "Processing", TL("Where taxis can drop off customers ('allJunctions, 'ptStops')"));
171 :
172 9358 : oc.doRegister("persontrip.transfer.walk-taxi", new Option_StringVector());
173 18716 : oc.addDescription("persontrip.transfer.walk-taxi", "Processing", TL("Where taxis can pick up customers ('allJunctions, 'ptStops')"));
174 :
175 18716 : oc.doRegister("persontrip.taxi.waiting-time", new Option_String("300", "TIME"));
176 18716 : oc.addDescription("persontrip.taxi.waiting-time", "Processing", TL("Estimated time for taxi pickup"));
177 :
178 9358 : oc.doRegister("railway.max-train-length", new Option_Float(1000.0));
179 18716 : oc.addDescription("railway.max-train-length", "Processing", TL("Use FLOAT as a maximum train length when initializing the railway router"));
180 28074 : }
181 :
182 :
183 : bool
184 9114 : RODUAFrame::checkOptions() {
185 9114 : OptionsCont& oc = OptionsCont::getOptions();
186 9114 : bool ok = ROFrame::checkOptions(oc);
187 :
188 9114 : SUMOVehicleParameter p;
189 : std::string error;
190 9170 : if (oc.isSet("departlane") && !SUMOVehicleParameter::parseDepartLane(oc.getString("departlane"), "option", "departlane", p.departLane, p.departLaneProcedure, error)) {
191 12 : WRITE_ERROR(error);
192 : ok = false;
193 : }
194 9170 : if (oc.isSet("departpos") && !SUMOVehicleParameter::parseDepartPos(oc.getString("departpos"), "option", "departpos", p.departPos, p.departPosProcedure, error)) {
195 12 : WRITE_ERROR(error);
196 : ok = false;
197 : }
198 9170 : if (oc.isSet("departspeed") && !SUMOVehicleParameter::parseDepartSpeed(oc.getString("departspeed"), "option", "departspeed", p.departSpeed, p.departSpeedProcedure, error)) {
199 12 : WRITE_ERROR(error);
200 : ok = false;
201 : }
202 9170 : if (oc.isSet("arrivallane") && !SUMOVehicleParameter::parseArrivalLane(oc.getString("arrivallane"), "option", "arrivallane", p.arrivalLane, p.arrivalLaneProcedure, error)) {
203 12 : WRITE_ERROR(error);
204 : ok = false;
205 : }
206 9170 : if (oc.isSet("arrivalpos") && !SUMOVehicleParameter::parseArrivalPos(oc.getString("arrivalpos"), "option", "arrivalpos", p.arrivalPos, p.arrivalPosProcedure, error)) {
207 12 : WRITE_ERROR(error);
208 : ok = false;
209 : }
210 9170 : if (oc.isSet("arrivalspeed") && !SUMOVehicleParameter::parseArrivalSpeed(oc.getString("arrivalspeed"), "option", "arrivalspeed", p.arrivalSpeed, p.arrivalSpeedProcedure, error)) {
211 12 : WRITE_ERROR(error);
212 : ok = false;
213 : }
214 :
215 14184 : if (oc.getString("routing-algorithm") != "dijkstra" && oc.getString("weight-attribute") != "traveltime") {
216 9 : WRITE_ERRORF(TL("Routing algorithm '%' does not support weight-attribute '%'."), oc.getString("routing-algorithm"), oc.getString("weight-attribute"));
217 3 : return false;
218 : }
219 9161 : if (oc.getBool("bulk-routing") && (oc.getString("routing-algorithm") == "CH" || oc.getString("routing-algorithm") == "CHWrapper")) {
220 12 : WRITE_ERRORF(TL("Routing algorithm '%' does not support bulk routing."), oc.getString("routing-algorithm"));
221 6 : return false;
222 : }
223 30874 : if (oc.isDefault("routing-algorithm") && (oc.isSet("astar.all-distances") || oc.isSet("astar.landmark-distances") || oc.isSet("astar.save-landmark-distances"))) {
224 10 : oc.setDefault("routing-algorithm", "astar");
225 : }
226 :
227 9267 : if (oc.getString("route-choice-method") != "gawron" && oc.getString("route-choice-method") != "logit") {
228 0 : WRITE_ERRORF(TL("Invalid route choice method '%'."), oc.getString("route-choice-method"));
229 0 : return false;
230 : }
231 18210 : if (oc.getBool("logit")) {
232 0 : WRITE_WARNING(TL("The --logit option is deprecated, please use --route-choice-method logit."));
233 0 : oc.set("route-choice-method", "logit");
234 : }
235 :
236 18236 : if (oc.isSet("output-file") && !oc.isSet("alternatives-output")) {
237 18126 : const std::string& filename = oc.getString("output-file");
238 9063 : const int len = (int)filename.length();
239 18125 : if (len > 4 && filename.substr(len - 4) == ".xml") {
240 36224 : oc.setDefault("alternatives-output", filename.substr(0, len - 4) + ".alt.xml");
241 13 : } else if (len > 4 && filename.substr(len - 3) == ".gz") {
242 24 : oc.setDefault("alternatives-output", filename.substr(0, len - 3) + ".alt.gz");
243 : } else {
244 2 : WRITE_WARNING(TL("Cannot derive file name for alternatives output, skipping it."));
245 : }
246 : }
247 18210 : if (oc.getBool("write-trips.junctions")) {
248 30 : if (oc.isDefault("write-trips")) {
249 8 : oc.setDefault("write-trips", "true");
250 22 : } else if (!oc.getBool("write-trips")) {
251 0 : WRITE_WARNING(TL("Option --write-trips.junctions takes no affect when --write-trips is disabled."));
252 : }
253 : }
254 : return ok;
255 9114 : }
256 :
257 :
258 : /****************************************************************************/
|
