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-2017 German Aerospace Center (DLR) and others.
4 /****************************************************************************/
5 //
6 // This program and the accompanying materials
7 // are made available under the terms of the Eclipse Public License v2.0
8 // which accompanies this distribution, and is available at
9 // http://www.eclipse.org/legal/epl-v20.html
10 //
11 /****************************************************************************/
19 // Sets and checks options for netgen
20 /****************************************************************************/
21 
22 
23 // ===========================================================================
24 // included modules
25 // ===========================================================================
26 #ifdef _MSC_VER
27 #include <windows_config.h>
28 #else
29 #include <config.h>
30 #endif
31 
32 #include <string>
33 #include "NGFrame.h"
34 #include <netbuild/NBNetBuilder.h>
35 #include <utils/options/Option.h>
39 #include <utils/common/ToString.h>
40 
41 
42 // ===========================================================================
43 // method definitions
44 // ===========================================================================
45 void
48  // register grid-net options
49  oc.doRegister("grid", 'g', new Option_Bool(false));
50  oc.addSynonyme("grid", "grid-net", true);
51  oc.addDescription("grid", "Grid Network", "Forces NETGEN to build a grid-like network");
52 
53  oc.doRegister("grid.number", new Option_Integer(5));
54  oc.addSynonyme("grid.number", "grid-number", true);
55  oc.addSynonyme("grid.number", "number");
56  oc.addDescription("grid.number", "Grid Network", "The number of junctions in both dirs");
57 
58  oc.doRegister("grid.length", new Option_Float(100));
59  oc.addSynonyme("grid.length", "grid-length", true);
60  oc.addSynonyme("grid.length", "length");
61  oc.addDescription("grid.length", "Grid Network", "The length of streets in both dirs");
62 
63  oc.doRegister("grid.x-number", new Option_Integer(5));
64  oc.addSynonyme("grid.x-number", "grid-x-number", true);
65  oc.addSynonyme("grid.x-number", "x-no");
66  oc.addDescription("grid.x-number", "Grid Network", "The number of junctions in x-dir; Overrides --grid-number");
67 
68  oc.doRegister("grid.y-number", new Option_Integer(5));
69  oc.addSynonyme("grid.y-number", "grid-y-number", true);
70  oc.addSynonyme("grid.y-number", "y-no");
71  oc.addDescription("grid.y-number", "Grid Network", "The number of junctions in y-dir; Overrides --grid-number");
72 
73  oc.doRegister("grid.x-length", new Option_Float(100));
74  oc.addSynonyme("grid.x-length", "grid-x-length", true);
75  oc.addSynonyme("grid.x-length", "x-length");
76  oc.addDescription("grid.x-length", "Grid Network", "The length of horizontal streets; Overrides --grid-length");
77 
78  oc.doRegister("grid.y-length", new Option_Float(100));
79  oc.addSynonyme("grid.y-length", "grid-y-length", true);
80  oc.addSynonyme("grid.y-length", "y-length");
81  oc.addDescription("grid.y-length", "Grid Network", "The length of vertical streets; Overrides --grid-length");
82 
83  oc.doRegister("grid.attach-length", new Option_Float(0));
84  oc.addSynonyme("grid.attach-length", "attach-length", true);
85  oc.addDescription("grid.attach-length", "Grid Network", "The length of streets attached at the boundary; 0 means no streets are attached");
86 
87  oc.doRegister("grid.alphanumerical-ids", new Option_Bool(false));
88  oc.addDescription("grid.alphanumerical-ids", "Grid Network", "The Ids of generated nodes use letters for the X axis");
89 
90  // register spider-net options
91  oc.doRegister("spider", 's', new Option_Bool(false));
92  oc.addSynonyme("spider", "spider-net", true);
93  oc.addDescription("spider", "Spider Network", "Forces NETGEN to build a spider-net-like network");
94 
95  oc.doRegister("spider.arm-number", new Option_Integer(13));
96  oc.addSynonyme("spider.arm-number", "spider-arm-number", true);
97  oc.addSynonyme("spider.arm-number", "arms");
98  oc.addDescription("spider.arm-number", "Spider Network", "The number of axes within the net");
99 
100  oc.doRegister("spider.circle-number", new Option_Integer(20));
101  oc.addSynonyme("spider.circle-number", "spider-circle-number", true);
102  oc.addSynonyme("spider.circle-number", "circles");
103  oc.addDescription("spider.circle-number", "Spider Network", "The number of circles of the net");
104 
105  oc.doRegister("spider.space-radius", new Option_Float(100));
106  oc.addSynonyme("spider.space-radius", "spider-space-rad", true);
107  oc.addSynonyme("spider.space-radius", "radius");
108  oc.addDescription("spider.space-radius", "Spider Network", "The distances between the circles");
109 
110  oc.doRegister("spider.omit-center", new Option_Bool(false));
111  oc.addSynonyme("spider.omit-center", "spider-omit-center", true);
112  oc.addSynonyme("spider.omit-center", "nocenter");
113  oc.addDescription("spider.omit-center", "Spider Network", "Omit the central node of the network");
114 
115 
116  // register random-net options
117  oc.doRegister("rand", 'r', new Option_Bool(false));
118  oc.addSynonyme("rand", "random-net", true);
119  oc.addDescription("rand", "Random Network", "Forces NETGEN to build a random network");
120 
121  oc.doRegister("rand.iterations", new Option_Integer(2000));
122  oc.addSynonyme("rand.iterations", "rand-iterations", true);
123  oc.addSynonyme("rand.iterations", "iterations");
124  oc.addDescription("rand.iterations", "Random Network", "Describes how many times an edge shall be added to the net");
125 
126  oc.doRegister("rand.bidi-probability", new Option_Float(1));
127  oc.addSynonyme("rand.bidi-probability", "rand-bidi-probability", true);
128  oc.addSynonyme("rand.bidi-probability", "bidi");
129  oc.addDescription("rand.bidi-probability", "Random Network", "Defines the probability to build a reverse edge");
130 
131  oc.doRegister("rand.max-distance", new Option_Float(250));
132  oc.addSynonyme("rand.max-distance", "rand-max-distance", true);
133  oc.addSynonyme("rand.max-distance", "max-dist");
134  oc.addDescription("rand.max-distance", "Random Network", "The maximum distance for each edge");
135 
136  oc.doRegister("rand.min-distance", new Option_Float(100));
137  oc.addSynonyme("rand.min-distance", "rand-min-distance", true);
138  oc.addSynonyme("rand.min-distance", "min-dist");
139  oc.addDescription("rand.min-distance", "Random Network", "The minimum distance for each edge");
140 
141  oc.doRegister("rand.min-angle", new Option_Float(DEG2RAD(45.0)));
142  oc.addSynonyme("rand.min-angle", "rand-min-anglee", true);
143  oc.addSynonyme("rand.min-angle", "min-angle");
144  oc.addDescription("rand.min-angle", "Random Network", "The minimum angle for each pair of (bidirectional) roads");
145 
146  oc.doRegister("rand.num-tries", new Option_Integer(50));
147  oc.addSynonyme("rand.num-tries", "rand-num-tries", true);
148  oc.addSynonyme("rand.num-tries", "num-tries");
149  oc.addDescription("rand.num-tries", "Random Network", "The number of tries for creating each node");
150 
151  oc.doRegister("rand.connectivity", new Option_Float((double) 0.95));
152  oc.addSynonyme("rand.connectivity", "rand-connectivity", true);
153  oc.addSynonyme("rand.connectivity", "connectivity");
154  oc.addDescription("rand.connectivity", "Random Network", "Probability for roads to continue at each node");
155 
156  oc.doRegister("rand.neighbor-dist1", new Option_Float(0));
157  oc.addSynonyme("rand.neighbor-dist1", "rand-neighbor-dist1", true);
158  oc.addSynonyme("rand.neighbor-dist1", "dist1");
159  oc.addDescription("rand.neighbor-dist1", "Random Network", "Probability for a node having exactly 1 neighbor");
160 
161  oc.doRegister("rand.neighbor-dist2", new Option_Float(0));
162  oc.addSynonyme("rand.neighbor-dist2", "rand-neighbor-dist2", true);
163  oc.addSynonyme("rand.neighbor-dist2", "dist2");
164  oc.addDescription("rand.neighbor-dist2", "Random Network", "Probability for a node having exactly 2 neighbors");
165 
166  oc.doRegister("rand.neighbor-dist3", new Option_Float(10));
167  oc.addSynonyme("rand.neighbor-dist3", "rand-neighbor-dist3", true);
168  oc.addSynonyme("rand.neighbor-dist3", "dist3");
169  oc.addDescription("rand.neighbor-dist3", "Random Network", "Probability for a node having exactly 3 neighbors");
170 
171  oc.doRegister("rand.neighbor-dist4", new Option_Float(10));
172  oc.addSynonyme("rand.neighbor-dist4", "rand-neighbor-dist4", true);
173  oc.addSynonyme("rand.neighbor-dist4", "dist4");
174  oc.addDescription("rand.neighbor-dist4", "Random Network", "Probability for a node having exactly 4 neighbors");
175 
176  oc.doRegister("rand.neighbor-dist5", new Option_Float(2));
177  oc.addSynonyme("rand.neighbor-dist5", "rand-neighbor-dist5", true);
178  oc.addSynonyme("rand.neighbor-dist5", "dist5");
179  oc.addDescription("rand.neighbor-dist5", "Random Network", "Probability for a node having exactly 5 neighbors");
180 
181  oc.doRegister("rand.neighbor-dist6", new Option_Float(1));
182  oc.addSynonyme("rand.neighbor-dist6", "rand-neighbor-dist6", true);
183  oc.addSynonyme("rand.neighbor-dist6", "dist6");
184  oc.addDescription("rand.neighbor-dist6", "Random Network", "Probability for a node having exactly 6 neighbors");
185 }
186 
187 
188 bool
191  bool ok = true;
192  // check whether exactly one type of a network to build was wished
193  int no = 0;
194  if (oc.getBool("spider")) {
195  no++;
196  }
197  if (oc.getBool("grid")) {
198  no++;
199  }
200  if (oc.getBool("rand")) {
201  no++;
202  }
203  if (no == 0) {
204  WRITE_ERROR("You have to specify the type of network to generate.");
205  ok = false;
206  }
207  if (no > 1) {
208  WRITE_ERROR("You may specify only one type of network to generate at once.");
209  ok = false;
210  }
211  // check whether the junction type to use is properly set
212  if (oc.isSet("default-junction-type")) {
213  std::string type = oc.getString("default-junction-type");
214  if (type != toString(NODETYPE_TRAFFIC_LIGHT) &&
217  type != toString(NODETYPE_PRIORITY) &&
218  type != toString(NODETYPE_PRIORITY_STOP) &&
219  type != toString(NODETYPE_ALLWAY_STOP) &&
220  type != toString(NODETYPE_ZIPPER) &&
221  type != toString(NODETYPE_NOJUNCTION) &&
222  type != toString(NODETYPE_RAIL_SIGNAL) &&
223  type != toString(NODETYPE_RAIL_CROSSING) &&
225  WRITE_ERROR("Only the following junction types are known: " +
229  toString(NODETYPE_PRIORITY) + ", " +
232  toString(NODETYPE_ZIPPER) + ", " +
233  toString(NODETYPE_NOJUNCTION) + ", " +
237  ok = false;
238  }
239  }
240  return ok;
241 }
242 
243 
244 /****************************************************************************/
245 
void doRegister(const std::string &name, Option *v)
Adds an option under the given name.
Definition: OptionsCont.cpp:81
bool getBool(const std::string &name) const
Returns the boolean-value of the named option (only for Option_Bool)
static OptionsCont & getOptions()
Retrieves the options.
Definition: OptionsCont.cpp:64
void addSynonyme(const std::string &name1, const std::string &name2, bool isDeprecated=false)
Adds a synonyme for an options name (any order)
bool isSet(const std::string &name, bool failOnNonExistant=true) const
Returns the information whether the named option is set.
std::string toString(const T &t, std::streamsize accuracy=gPrecision)
Definition: ToString.h:55
std::string getString(const std::string &name) const
Returns the string-value of the named option (only for Option_String)
static bool checkOptions()
Checks set options from the OptionsCont-singleton for being valid.
Definition: NGFrame.cpp:189
#define DEG2RAD(x)
Definition: GeomHelper.h:44
#define WRITE_ERROR(msg)
Definition: MsgHandler.h:205
An integer-option.
Definition: Option.h:312
A storage for options typed value containers)
Definition: OptionsCont.h:98
static void fillOptions()
Inserts options used by the network generator.
Definition: NGFrame.cpp:46
void addDescription(const std::string &name, const std::string &subtopic, const std::string &description)
Adds a description for an option.