Eclipse SUMO - Simulation of Urban MObility
NGFrame.cpp
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2011-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 netgen
17 /****************************************************************************/
18 
19 
20 // ===========================================================================
21 // included modules
22 // ===========================================================================
23 #include <config.h>
24 
25 #include <string>
26 #include "NGFrame.h"
27 #include <netbuild/NBNetBuilder.h>
28 #include <utils/options/Option.h>
32 #include <utils/common/ToString.h>
33 
34 
35 // ===========================================================================
36 // method definitions
37 // ===========================================================================
38 void
41  oc.doRegister("type-files", 't', new Option_FileName());
42  oc.addDescription("type-files", "Input", "Read edge-type defs from FILE");
43 
44  oc.doRegister("alphanumerical-ids", new Option_Bool(true));
45  oc.addDescription("alphanumerical-ids", "Output", "The Ids of generated nodes use an alphanumerical code for easier readability when possible");
46 
47  // register processing options
48  oc.doRegister("turn-lanes", new Option_Integer(0));
49  oc.addDescription("turn-lanes", "Processing", "Generate INT left-turn lanes");
50  oc.doRegister("turn-lanes.length", new Option_Float(20));
51  oc.addDescription("turn-lanes.length", "Processing", "Set the length of generated turning lanes to FLOAT");
52 
53  oc.doRegister("perturb-x", new Option_String("0"));
54  oc.addDescription("perturb-x", "Processing", "Apply random spatial pertubation in x direction according the the given distribution");
55  oc.doRegister("perturb-y", new Option_String("0"));
56  oc.addDescription("perturb-y", "Processing", "Apply random spatial pertubation in y direction according the the given distribution");
57  oc.doRegister("perturb-z", new Option_String("0"));
58  oc.addDescription("perturb-z", "Processing", "Apply random spatial pertubation in z direction according the the given distribution");
59 
60 
61  // register grid-net options
62  oc.doRegister("grid", 'g', new Option_Bool(false));
63  oc.addSynonyme("grid", "grid-net", true);
64  oc.addDescription("grid", "Grid Network", "Forces NETGEN to build a grid-like network");
65 
66  oc.doRegister("grid.number", new Option_Integer(5));
67  oc.addSynonyme("grid.number", "grid-number", true);
68  oc.addSynonyme("grid.number", "number");
69  oc.addDescription("grid.number", "Grid Network", "The number of junctions in both dirs");
70 
71  oc.doRegister("grid.length", new Option_Float(100));
72  oc.addSynonyme("grid.length", "grid-length", true);
73  oc.addSynonyme("grid.length", "length");
74  oc.addDescription("grid.length", "Grid Network", "The length of streets in both dirs");
75 
76  oc.doRegister("grid.x-number", new Option_Integer(5));
77  oc.addSynonyme("grid.x-number", "grid-x-number", true);
78  oc.addSynonyme("grid.x-number", "x-no");
79  oc.addDescription("grid.x-number", "Grid Network", "The number of junctions in x-dir; Overrides --grid-number");
80 
81  oc.doRegister("grid.y-number", new Option_Integer(5));
82  oc.addSynonyme("grid.y-number", "grid-y-number", true);
83  oc.addSynonyme("grid.y-number", "y-no");
84  oc.addDescription("grid.y-number", "Grid Network", "The number of junctions in y-dir; Overrides --grid-number");
85 
86  oc.doRegister("grid.x-length", new Option_Float(100));
87  oc.addSynonyme("grid.x-length", "grid-x-length", true);
88  oc.addSynonyme("grid.x-length", "x-length");
89  oc.addDescription("grid.x-length", "Grid Network", "The length of horizontal streets; Overrides --grid-length");
90 
91  oc.doRegister("grid.y-length", new Option_Float(100));
92  oc.addSynonyme("grid.y-length", "grid-y-length", true);
93  oc.addSynonyme("grid.y-length", "y-length");
94  oc.addDescription("grid.y-length", "Grid Network", "The length of vertical streets; Overrides --grid-length");
95 
96  oc.doRegister("grid.attach-length", new Option_Float(0));
97  oc.addSynonyme("grid.attach-length", "attach-length", true);
98  oc.addDescription("grid.attach-length", "Grid Network", "The length of streets attached at the boundary; 0 means no streets are attached");
99 
100  // register spider-net options
101  oc.doRegister("spider", 's', new Option_Bool(false));
102  oc.addSynonyme("spider", "spider-net", true);
103  oc.addDescription("spider", "Spider Network", "Forces NETGEN to build a spider-net-like network");
104 
105  oc.doRegister("spider.arm-number", new Option_Integer(13));
106  oc.addSynonyme("spider.arm-number", "spider-arm-number", true);
107  oc.addSynonyme("spider.arm-number", "arms");
108  oc.addDescription("spider.arm-number", "Spider Network", "The number of axes within the net");
109 
110  oc.doRegister("spider.circle-number", new Option_Integer(20));
111  oc.addSynonyme("spider.circle-number", "spider-circle-number", true);
112  oc.addSynonyme("spider.circle-number", "circles");
113  oc.addDescription("spider.circle-number", "Spider Network", "The number of circles of the net");
114 
115  oc.doRegister("spider.space-radius", new Option_Float(100));
116  oc.addSynonyme("spider.space-radius", "spider-space-rad", true);
117  oc.addSynonyme("spider.space-radius", "radius");
118  oc.addDescription("spider.space-radius", "Spider Network", "The distances between the circles");
119 
120  oc.doRegister("spider.omit-center", new Option_Bool(false));
121  oc.addSynonyme("spider.omit-center", "spider-omit-center", true);
122  oc.addSynonyme("spider.omit-center", "nocenter");
123  oc.addDescription("spider.omit-center", "Spider Network", "Omit the central node of the network");
124 
125 
126  // register random-net options
127  oc.doRegister("rand", 'r', new Option_Bool(false));
128  oc.addSynonyme("rand", "random-net", true);
129  oc.addDescription("rand", "Random Network", "Forces NETGEN to build a random network");
130 
131  oc.doRegister("rand.iterations", new Option_Integer(2000));
132  oc.addSynonyme("rand.iterations", "rand-iterations", true);
133  oc.addSynonyme("rand.iterations", "iterations");
134  oc.addDescription("rand.iterations", "Random Network", "Describes how many times an edge shall be added to the net");
135 
136  oc.doRegister("rand.bidi-probability", new Option_Float(1));
137  oc.addSynonyme("rand.bidi-probability", "rand-bidi-probability", true);
138  oc.addSynonyme("rand.bidi-probability", "bidi");
139  oc.addDescription("rand.bidi-probability", "Random Network", "Defines the probability to build a reverse edge");
140 
141  oc.doRegister("rand.max-distance", new Option_Float(250));
142  oc.addSynonyme("rand.max-distance", "rand-max-distance", true);
143  oc.addSynonyme("rand.max-distance", "max-dist");
144  oc.addDescription("rand.max-distance", "Random Network", "The maximum distance for each edge");
145 
146  oc.doRegister("rand.min-distance", new Option_Float(100));
147  oc.addSynonyme("rand.min-distance", "rand-min-distance", true);
148  oc.addSynonyme("rand.min-distance", "min-dist");
149  oc.addDescription("rand.min-distance", "Random Network", "The minimum distance for each edge");
150 
151  oc.doRegister("rand.min-angle", new Option_Float(45.0));
152  oc.addSynonyme("rand.min-angle", "rand-min-anglee", true);
153  oc.addSynonyme("rand.min-angle", "min-angle");
154  oc.addDescription("rand.min-angle", "Random Network", "The minimum angle for each pair of (bidirectional) roads in DEGREES");
155 
156  oc.doRegister("rand.num-tries", new Option_Integer(50));
157  oc.addSynonyme("rand.num-tries", "rand-num-tries", true);
158  oc.addSynonyme("rand.num-tries", "num-tries");
159  oc.addDescription("rand.num-tries", "Random Network", "The number of tries for creating each node");
160 
161  oc.doRegister("rand.connectivity", new Option_Float((double) 0.95));
162  oc.addSynonyme("rand.connectivity", "rand-connectivity", true);
163  oc.addSynonyme("rand.connectivity", "connectivity");
164  oc.addDescription("rand.connectivity", "Random Network", "Probability for roads to continue at each node");
165 
166  oc.doRegister("rand.neighbor-dist1", new Option_Float(0));
167  oc.addSynonyme("rand.neighbor-dist1", "rand-neighbor-dist1", true);
168  oc.addSynonyme("rand.neighbor-dist1", "dist1");
169  oc.addDescription("rand.neighbor-dist1", "Random Network", "Probability for a node having exactly 1 neighbor");
170 
171  oc.doRegister("rand.neighbor-dist2", new Option_Float(0));
172  oc.addSynonyme("rand.neighbor-dist2", "rand-neighbor-dist2", true);
173  oc.addSynonyme("rand.neighbor-dist2", "dist2");
174  oc.addDescription("rand.neighbor-dist2", "Random Network", "Probability for a node having exactly 2 neighbors");
175 
176  oc.doRegister("rand.neighbor-dist3", new Option_Float(10));
177  oc.addSynonyme("rand.neighbor-dist3", "rand-neighbor-dist3", true);
178  oc.addSynonyme("rand.neighbor-dist3", "dist3");
179  oc.addDescription("rand.neighbor-dist3", "Random Network", "Probability for a node having exactly 3 neighbors");
180 
181  oc.doRegister("rand.neighbor-dist4", new Option_Float(10));
182  oc.addSynonyme("rand.neighbor-dist4", "rand-neighbor-dist4", true);
183  oc.addSynonyme("rand.neighbor-dist4", "dist4");
184  oc.addDescription("rand.neighbor-dist4", "Random Network", "Probability for a node having exactly 4 neighbors");
185 
186  oc.doRegister("rand.neighbor-dist5", new Option_Float(2));
187  oc.addSynonyme("rand.neighbor-dist5", "rand-neighbor-dist5", true);
188  oc.addSynonyme("rand.neighbor-dist5", "dist5");
189  oc.addDescription("rand.neighbor-dist5", "Random Network", "Probability for a node having exactly 5 neighbors");
190 
191  oc.doRegister("rand.neighbor-dist6", new Option_Float(1));
192  oc.addSynonyme("rand.neighbor-dist6", "rand-neighbor-dist6", true);
193  oc.addSynonyme("rand.neighbor-dist6", "dist6");
194  oc.addDescription("rand.neighbor-dist6", "Random Network", "Probability for a node having exactly 6 neighbors");
195 
196  oc.doRegister("rand.random-lanenumber", new Option_Bool(false));
197  oc.addDescription("rand.random-lanenumber", "Random Network", "Draw lane numbers randomly from [1,default.lanenumber]");
198 
199  oc.doRegister("rand.random-priority", new Option_Bool(false));
200  oc.addDescription("rand.random-priority", "Random Network", "Draw edge priority randomly from [1,default.priority]");
201 
202  oc.doRegister("rand.grid", new Option_Bool(false));
203  oc.addDescription("rand.grid", "Random Network", "Place nodes on a regular grid with spacing rand.min-distance");
204 }
205 
206 
207 bool
210  bool ok = true;
211  // check whether exactly one type of a network to build was wished
212  int no = 0;
213  if (oc.getBool("spider")) {
214  no++;
215  }
216  if (oc.getBool("grid")) {
217  no++;
218  }
219  if (oc.getBool("rand")) {
220  no++;
221  }
222  if (no == 0) {
223  WRITE_ERROR("You have to specify the type of network to generate.");
224  ok = false;
225  }
226  if (no > 1) {
227  WRITE_ERROR("You may specify only one type of network to generate at once.");
228  ok = false;
229  }
230  // check whether the junction type to use is properly set
231  if (oc.isSet("default-junction-type")) {
232  std::string type = oc.getString("default-junction-type");
233  if (type != toString(NODETYPE_TRAFFIC_LIGHT) &&
236  type != toString(NODETYPE_PRIORITY) &&
237  type != toString(NODETYPE_PRIORITY_STOP) &&
238  type != toString(NODETYPE_ALLWAY_STOP) &&
239  type != toString(NODETYPE_ZIPPER) &&
240  type != toString(NODETYPE_NOJUNCTION) &&
241  type != toString(NODETYPE_RAIL_SIGNAL) &&
242  type != toString(NODETYPE_RAIL_CROSSING) &&
244  WRITE_ERROR("Only the following junction types are known: " +
248  toString(NODETYPE_PRIORITY) + ", " +
251  toString(NODETYPE_ZIPPER) + ", " +
252  toString(NODETYPE_NOJUNCTION) + ", " +
256  ok = false;
257  }
258  }
259  return ok;
260 }
261 
262 
263 /****************************************************************************/
264 
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
NODETYPE_PRIORITY
@ NODETYPE_PRIORITY
Definition: SUMOXMLDefinitions.h:1061
NODETYPE_TRAFFIC_LIGHT_RIGHT_ON_RED
@ NODETYPE_TRAFFIC_LIGHT_RIGHT_ON_RED
Definition: SUMOXMLDefinitions.h:1058
ToString.h
NODETYPE_ZIPPER
@ NODETYPE_ZIPPER
Definition: SUMOXMLDefinitions.h:1065
Option_Bool
Definition: Option.h:538
OptionsCont.h
MsgHandler.h
NGFrame::fillOptions
static void fillOptions()
Inserts options used by the network generator.
Definition: NGFrame.cpp:39
OptionsCont::getString
std::string getString(const std::string &name) const
Returns the string-value of the named option (only for Option_String)
Definition: OptionsCont.cpp:201
OptionsCont::getBool
bool getBool(const std::string &name) const
Returns the boolean-value of the named option (only for Option_Bool)
Definition: OptionsCont.cpp:222
OptionsCont::getOptions
static OptionsCont & getOptions()
Retrieves the options.
Definition: OptionsCont.cpp:57
NODETYPE_ALLWAY_STOP
@ NODETYPE_ALLWAY_STOP
Definition: SUMOXMLDefinitions.h:1064
NODETYPE_RAIL_SIGNAL
@ NODETYPE_RAIL_SIGNAL
Definition: SUMOXMLDefinitions.h:1059
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
NODETYPE_PRIORITY_STOP
@ NODETYPE_PRIORITY_STOP
Definition: SUMOXMLDefinitions.h:1062
SystemFrame.h
NODETYPE_TRAFFIC_LIGHT_NOJUNCTION
@ NODETYPE_TRAFFIC_LIGHT_NOJUNCTION
Definition: SUMOXMLDefinitions.h:1057
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
NBNetBuilder.h
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
OptionsCont
A storage for options typed value containers)
Definition: OptionsCont.h:89
NODETYPE_RAIL_CROSSING
@ NODETYPE_RAIL_CROSSING
Definition: SUMOXMLDefinitions.h:1060
NODETYPE_RIGHT_BEFORE_LEFT
@ NODETYPE_RIGHT_BEFORE_LEFT
Definition: SUMOXMLDefinitions.h:1063
NGFrame.h
toString
std::string toString(const T &t, std::streamsize accuracy=gPrecision)
Definition: ToString.h:47
Option.h
Option_Float
Definition: Option.h:470
config.h
Option_FileName
Definition: Option.h:783
NGFrame::checkOptions
static bool checkOptions()
Checks set options from the OptionsCont-singleton for being valid.
Definition: NGFrame.cpp:208
Option_Integer
An integer-option.
Definition: Option.h:331
WRITE_ERROR
#define WRITE_ERROR(msg)
Definition: MsgHandler.h:283
NODETYPE_NOJUNCTION
@ NODETYPE_NOJUNCTION
Definition: SUMOXMLDefinitions.h:1067
NODETYPE_TRAFFIC_LIGHT
@ NODETYPE_TRAFFIC_LIGHT
Definition: SUMOXMLDefinitions.h:1056