Eclipse SUMO - Simulation of Urban MObility
ROFrame.cpp
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2001-2019 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 /****************************************************************************/
16 // Sets and checks options for routing
17 /****************************************************************************/
18 
19 
20 // ===========================================================================
21 // included modules
22 // ===========================================================================
23 #include <config.h>
24 
25 #include <iostream>
26 #include <ctime>
27 #include <stdlib.h>
29 #include <utils/options/Option.h>
33 #include <utils/common/ToString.h>
34 #include <utils/common/SUMOTime.h>
35 #include "ROFrame.h"
36 
37 
38 // ===========================================================================
39 // method definitions
40 // ===========================================================================
41 void
43  // register options
44  // register I/O options
45  oc.doRegister("output-file", 'o', new Option_FileName());
46  oc.addSynonyme("output-file", "output");
47  oc.addDescription("output-file", "Output", "Write generated routes to FILE");
48 
49  oc.doRegister("vtype-output", new Option_FileName());
50  oc.addSynonyme("vtype-output", "vtype");
51  oc.addDescription("vtype-output", "Output", "Write used vehicle types into separate FILE");
52 
53  oc.doRegister("keep-vtype-distributions", new Option_Bool(false));
54  oc.addDescription("keep-vtype-distributions", "Output", "Keep vTypeDistribution ids when writing vehicles and their types");
55 
56  oc.doRegister("net-file", 'n', new Option_FileName());
57  oc.addSynonyme("net-file", "net");
58  oc.addDescription("net-file", "Input", "Use FILE as SUMO-network to route on");
59 
60  oc.doRegister("additional-files", 'a', new Option_FileName());
61  oc.addSynonyme("additional-files", "d", true);
62  oc.addSynonyme("additional-files", "additional");
63  oc.addSynonyme("additional-files", "taz-files");
64  oc.addSynonyme("additional-files", "districts", true);
65  oc.addDescription("additional-files", "Input", "Read additional network data (districts, bus stops) from FILE(s)");
66 
67  oc.doRegister("route-files", 'r', new Option_FileName());
68  oc.addSynonyme("route-files", "flow-files", true);
69  oc.addSynonyme("route-files", "flows", true);
70  oc.addSynonyme("route-files", "f", true);
71  oc.addSynonyme("route-files", "alternative-files", true);
72  oc.addSynonyme("route-files", "alternatives-files", true);
73  oc.addSynonyme("route-files", "trip-files", true);
74  oc.addSynonyme("route-files", "trips", true);
75  oc.addDescription("route-files", "Input", "Read sumo routes, alternatives, flows, and trips from FILE(s)");
76 
77  oc.doRegister("phemlight-path", new Option_FileName(StringVector({ "./PHEMlight/" })));
78  oc.addDescription("phemlight-path", "Input", "Determines where to load PHEMlight definitions from.");
79 
80  // register the time settings
81  oc.doRegister("begin", 'b', new Option_String("0", "TIME"));
82  oc.addDescription("begin", "Time", "Defines the begin time; Previous trips will be discarded");
83 
84  oc.doRegister("end", 'e', new Option_String(SUMOTIME_MAXSTRING, "TIME"));
85  oc.addDescription("end", "Time", "Defines the end time; Later trips will be discarded; Defaults to the maximum time that SUMO can represent");
86 
87  // register the processing options
88  oc.doRegister("ignore-errors", new Option_Bool(false));
89  oc.addSynonyme("ignore-errors", "continue-on-unbuild", true);
90  oc.addDescription("ignore-errors", "Report", "Continue if a route could not be build");
91 
92  oc.doRegister("unsorted-input", new Option_Bool(false));
93  oc.addSynonyme("unsorted-input", "unsorted");
94  oc.addDescription("unsorted-input", "Processing", "Assume input is unsorted");
95 
96  oc.doRegister("route-steps", 's', new Option_String("200", "TIME"));
97  oc.addDescription("route-steps", "Processing", "Load routes for the next number of seconds ahead");
98 
99  oc.doRegister("no-internal-links", new Option_Bool(false));
100  oc.addDescription("no-internal-links", "Processing", "Disable (junction) internal links");
101 
102  oc.doRegister("randomize-flows", new Option_Bool(false));
103  oc.addDescription("randomize-flows", "Processing", "generate random departure times for flow input");
104 
105  oc.doRegister("max-alternatives", new Option_Integer(5));
106  oc.addDescription("max-alternatives", "Processing", "Prune the number of alternatives to INT");
107 
108  oc.doRegister("remove-loops", new Option_Bool(false));
109  oc.addDescription("remove-loops", "Processing", "Remove loops within the route; Remove turnarounds at start and end of the route");
110 
111  oc.doRegister("repair", new Option_Bool(false));
112  oc.addDescription("repair", "Processing", "Tries to correct a false route");
113 
114  oc.doRegister("repair.from", new Option_Bool(false));
115  oc.addDescription("repair.from", "Processing", "Tries to correct an invalid starting edge by using the first usable edge instead");
116 
117  oc.doRegister("repair.to", new Option_Bool(false));
118  oc.addDescription("repair.to", "Processing", "Tries to correct an invalid destination edge by using the last usable edge instead");
119 
120  oc.doRegister("weights.interpolate", new Option_Bool(false));
121  oc.addSynonyme("weights.interpolate", "interpolate", true);
122  oc.addDescription("weights.interpolate", "Processing", "Interpolate edge weights at interval boundaries");
123 
124  oc.doRegister("weights.minor-penalty", new Option_Float(1.5));
125  oc.addDescription("weights.minor-penalty", "Processing", "Apply the given time penalty when computing routing costs for minor-link internal lanes");
126 
127  oc.doRegister("with-taz", new Option_Bool(false));
128  oc.addDescription("with-taz", "Processing", "Use origin and destination zones (districts) for in- and output");
129 
130  oc.doRegister("bulk-routing", new Option_Bool(false));
131  oc.addDescription("bulk-routing", "Processing", "Aggregate routing queries with the same origin");
132 
133  oc.doRegister("routing-threads", new Option_Integer(0));
134  oc.addDescription("routing-threads", "Processing", "The number of parallel execution threads used for routing");
135 
136  oc.doRegister("restriction-params", new Option_StringVector());
137  oc.addDescription("restriction-params", "Processing", "Comma separated list of param keys to compare for additional restrictions");
138 
139  // register defaults options
140  oc.doRegister("departlane", new Option_String());
141  oc.addDescription("departlane", "Defaults", "Assigns a default depart lane");
142 
143  oc.doRegister("departpos", new Option_String());
144  oc.addDescription("departpos", "Defaults", "Assigns a default depart position");
145 
146  oc.doRegister("departspeed", new Option_String());
147  oc.addDescription("departspeed", "Defaults", "Assigns a default depart speed");
148 
149  oc.doRegister("arrivallane", new Option_String());
150  oc.addDescription("arrivallane", "Defaults", "Assigns a default arrival lane");
151 
152  oc.doRegister("arrivalpos", new Option_String());
153  oc.addDescription("arrivalpos", "Defaults", "Assigns a default arrival position");
154 
155  oc.doRegister("arrivalspeed", new Option_String());
156  oc.addDescription("arrivalspeed", "Defaults", "Assigns a default arrival speed");
157 
158  oc.doRegister("defaults-override", new Option_Bool(false));
159  oc.addDescription("defaults-override", "Defaults", "Defaults will override given values");
160 
161 
162  // register report options
163  oc.doRegister("stats-period", new Option_Integer(-1));
164  oc.addDescription("stats-period", "Report", "Defines how often statistics shall be printed");
165 
166  oc.doRegister("no-step-log", new Option_Bool(false));
167  oc.addDescription("no-step-log", "Report", "Disable console output of route parsing step");
168 }
169 
170 
171 bool
173  // check whether the output is valid and can be build
174  if (!oc.isSet("output-file")) {
175  WRITE_ERROR("No output specified.");
176  return false;
177  }
178  //
179  if (oc.getInt("max-alternatives") < 2) {
180  WRITE_ERROR("At least two alternatives should be enabled.");
181  return false;
182  }
183 #ifndef HAVE_FOX
184  if (oc.getInt("routing-threads") > 1) {
185  WRITE_ERROR("Parallel routing is only possible when compiled with Fox.");
186  return false;
187  }
188 #endif
189  return true;
190 }
191 
192 
193 
194 /****************************************************************************/
195 
OptionsCont::isSet
bool isSet(const std::string &name, bool failOnNonExistant=true) const
Returns the information whether the named option is set.
Definition: OptionsCont.cpp:135
OptionsCont::getInt
int getInt(const std::string &name) const
Returns the int-value of the named option (only for Option_Integer)
Definition: OptionsCont.cpp:215
ToString.h
SUMOTime.h
Option_Bool
Definition: Option.h:538
OptionsCont.h
MsgHandler.h
ROFrame.h
OptionsCont::addDescription
void addDescription(const std::string &name, const std::string &subtopic, const std::string &description)
Adds a description for an option.
Definition: OptionsCont.cpp:469
StringVector
std::vector< std::string > StringVector
Definition of a vector of strings.
Definition: Option.h:45
OptionsCont::addSynonyme
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:95
OptionsCont::doRegister
void doRegister(const std::string &name, Option *v)
Adds an option under the given name.
Definition: OptionsCont.cpp:74
Option_String
Definition: Option.h:399
UtilExceptions.h
OptionsCont
A storage for options typed value containers)
Definition: OptionsCont.h:89
ROFrame::checkOptions
static bool checkOptions(OptionsCont &oc)
Checks whether options are valid.
Definition: ROFrame.cpp:172
Option_StringVector
Definition: Option.h:720
Option.h
Option_Float
Definition: Option.h:470
SUMOTIME_MAXSTRING
#define SUMOTIME_MAXSTRING
Definition: SUMOTime.h:37
ROFrame::fillOptions
static void fillOptions(OptionsCont &oc)
Inserts options used by routing applications into the OptionsCont-singleton.
Definition: ROFrame.cpp:42
config.h
Option_FileName
Definition: Option.h:783
RandHelper.h
Option_Integer
An integer-option.
Definition: Option.h:331
WRITE_ERROR
#define WRITE_ERROR(msg)
Definition: MsgHandler.h:283