Eclipse SUMO - Simulation of Urban MObility
netgen_main.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-2022 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/****************************************************************************/
21// Main for NETGENERATE
22/****************************************************************************/
23#include <config.h>
24
25#ifdef HAVE_VERSION_H
26#include <version.h>
27#endif
28
29#include <iostream>
30#include <fstream>
31#include <string>
32#include <ctime>
33#include <netgen/NGNet.h>
35#include <netgen/NGFrame.h>
37#include <netbuild/NBFrame.h>
38#include <netwrite/NWFrame.h>
51#include <utils/xml/XMLSubSys.h>
53
54
55// ===========================================================================
56// method definitions
57// ===========================================================================
58void
61 oc.addCallExample("-c <CONFIGURATION>", "create net from given configuration");
62 oc.addCallExample("--grid [grid-network options] -o <OUTPUTFILE>", "create grid net");
63 oc.addCallExample("--spider [spider-network options] -o <OUTPUTFILE>", "create spider net");
64 oc.addCallExample("--rand [random-network options] -o <OUTPUTFILE>", "create random net");
65
66 oc.setAdditionalHelpMessage(" Either \"--grid\", \"--spider\" or \"--rand\" must be supplied.\n In dependance to these switches other options are used.");
67
68 // insert options sub-topics
69 SystemFrame::addConfigurationOptions(oc); // this subtopic is filled here, too
70 oc.addOptionSubTopic("Grid Network");
71 oc.addOptionSubTopic("Spider Network");
72 oc.addOptionSubTopic("Random Network");
73 oc.addOptionSubTopic("Input");
74 oc.addOptionSubTopic("Output");
75 oc.addOptionSubTopic("Processing");
76 oc.addOptionSubTopic("Building Defaults");
77 oc.addOptionSubTopic("TLS Building");
78 oc.addOptionSubTopic("Edge Removal");
79 oc.addOptionSubTopic("Unregulated Nodes");
80 oc.addOptionSubTopic("Junctions");
81 oc.addOptionSubTopic("Pedestrian");
82 oc.addOptionSubTopic("Bicycle");
83 SystemFrame::addReportOptions(oc); // this subtopic is filled here, too
84
88 oc.doRegister("default-junction-type", 'j', new Option_String());
89 oc.addSynonyme("default-junction-type", "junctions");
90 oc.addDescription("default-junction-type", "Building Defaults", "[traffic_light|priority|right_before_left|left_before_right|traffic_light_right_on_red|priority_stop|allway_stop|...] Determines junction type (see wiki/Networks/PlainXML#Node_types)");
92
93 oc.doRegister("tls.discard-simple", new Option_Bool(false));
94 oc.addDescription("tls.discard-simple", "TLS Building", "Does not instatiate traffic lights at geometry-like nodes");
95}
96
97
98bool
100 bool ok = NGFrame::checkOptions();
101 ok &= NBFrame::checkOptions();
102 ok &= NWFrame::checkOptions();
104 return ok;
105}
106
107
108NGNet*
111
112 const double laneWidth = oc.isDefault("default.lanewidth") ? SUMO_const_laneWidth : oc.getFloat("default.lanewidth");
113 double minLength = (oc.getInt("default.lanenumber") + oc.getInt("turn-lanes")) * 2 * laneWidth + oc.getFloat("default.junctions.radius") * 2 + POSITION_EPS;
114 // spider-net
115 if (oc.getBool("spider")) {
116 // check values
117 bool hadError = false;
118 if (oc.getInt("spider.arm-number") < 3) {
119 WRITE_ERROR(TL("Spider networks need at least 3 arms."));
120 hadError = true;
121 }
122 if (oc.getInt("spider.arm-number") > 4 && oc.isDefault("spider.omit-center")) {
123 WRITE_WARNING(TL("Spider networks with many arms should use option ommit-center"));
124 }
125 if (oc.getInt("spider.circle-number") < 1) {
126 WRITE_ERROR(TL("Spider networks need at least one circle."));
127 hadError = true;
128 }
129 minLength = MAX2(minLength, laneWidth * 2 * MAX2(oc.getInt("spider.arm-number"), 3) / (2 * M_PI));
130 if (oc.getFloat("spider.space-radius") < POSITION_EPS) {
131 WRITE_ERROR("The radius of spider networks must be at least " + toString(POSITION_EPS));
132 hadError = true;
133 } else if (oc.getFloat("spider.space-radius") < minLength) {
134 WRITE_WARNING("The radius of spider networks should be at least " + toString(minLength) + " for the given lanenumber, lanewidth and junction radius");
135 }
136 if (hadError) {
137 throw ProcessError();
138 }
139 // build if everything's ok
140 NGNet* net = new NGNet(nb);
141 net->createSpiderWeb(oc.getInt("spider.arm-number"), oc.getInt("spider.circle-number"),
142 oc.getFloat("spider.space-radius"), !oc.getBool("spider.omit-center"));
143 return net;
144 }
145 // grid-net
146 if (oc.getBool("grid")) {
147 // get options
148 int xNo = oc.getInt("grid.x-number");
149 int yNo = oc.getInt("grid.y-number");
150 double xLength = oc.getFloat("grid.x-length");
151 double yLength = oc.getFloat("grid.y-length");
152 double xAttachLength = oc.getFloat("grid.x-attach-length");
153 double yAttachLength = oc.getFloat("grid.y-attach-length");
154 if (oc.isDefault("grid.x-number") && !oc.isDefault("grid.number")) {
155 xNo = oc.getInt("grid.number");
156 }
157 if (oc.isDefault("grid.y-number") && !oc.isDefault("grid.number")) {
158 yNo = oc.getInt("grid.number");
159 }
160 if (oc.isDefault("grid.x-length") && !oc.isDefault("grid.length")) {
161 xLength = oc.getFloat("grid.length");
162 }
163 if (oc.isDefault("grid.y-length") && !oc.isDefault("grid.length")) {
164 yLength = oc.getFloat("grid.length");
165 }
166 if (oc.isDefault("grid.x-attach-length") && !oc.isDefault("grid.attach-length")) {
167 xAttachLength = oc.getFloat("grid.attach-length");
168 }
169 if (oc.isDefault("grid.y-attach-length") && !oc.isDefault("grid.attach-length")) {
170 yAttachLength = oc.getFloat("grid.attach-length");
171 }
172 // check values
173 bool hadError = false;
174 if (xNo < 1 || yNo < 1 || (xAttachLength == 0 && yAttachLength == 0 && (xNo < 2 && yNo < 2))) {
175 WRITE_ERROR(TL("The number of nodes must be positive and at least 2 in one direction if there are no attachments."));
176 hadError = true;
177 }
178 const double minAttachLength = minLength / 2 + POSITION_EPS / 2;
179 if (xLength < POSITION_EPS || yLength < POSITION_EPS) {
180 WRITE_ERROR("The distance between nodes must be at least " + toString(POSITION_EPS));
181 hadError = true;
182 } else if (xLength < minLength || yLength < minLength) {
183 WRITE_WARNING("The distance between nodes should be at least " + toString(minLength) + " for the given lanenumber, lanewidth and junction radius");
184 }
185 if (xAttachLength != 0.0 && xAttachLength < POSITION_EPS) {
186 WRITE_ERROR("The length of attached streets must be at least " + toString(POSITION_EPS));
187 hadError = true;
188 } else if (xAttachLength != 0.0 && xAttachLength < minAttachLength) {
189 WRITE_WARNING("The length of attached streets should be at least " + toString(minAttachLength) + " for the given lanenumber, lanewidth and junction radius");
190 } else if (yAttachLength != 0.0 && yAttachLength < POSITION_EPS) {
191 WRITE_ERROR("The length of attached streets must be at least " + toString(POSITION_EPS));
192 hadError = true;
193 } else if (yAttachLength != 0.0 && yAttachLength < minAttachLength) {
194 WRITE_WARNING("The length of attached streets should be at least " + toString(minAttachLength) + " for the given lanenumber, lanewidth and junction radius");
195 }
196 if (hadError) {
197 throw ProcessError();
198 }
199 // build if everything's ok
200 NGNet* net = new NGNet(nb);
201 net->createChequerBoard(xNo, yNo, xLength, yLength, xAttachLength, yAttachLength);
202 return net;
203 }
204 // random net
205 RandomDistributor<int> neighborDist;
206 neighborDist.add(1, oc.getFloat("rand.neighbor-dist1"));
207 neighborDist.add(2, oc.getFloat("rand.neighbor-dist2"));
208 neighborDist.add(3, oc.getFloat("rand.neighbor-dist3"));
209 neighborDist.add(4, oc.getFloat("rand.neighbor-dist4"));
210 neighborDist.add(5, oc.getFloat("rand.neighbor-dist5"));
211 neighborDist.add(6, oc.getFloat("rand.neighbor-dist6"));
212 NGNet* net = new NGNet(nb);
213 NGRandomNetBuilder randomNet(*net,
214 DEG2RAD(oc.getFloat("rand.min-angle")),
215 oc.getFloat("rand.min-distance"),
216 oc.getFloat("rand.max-distance"),
217 oc.getFloat("rand.connectivity"),
218 oc.getInt("rand.num-tries"),
219 neighborDist);
220 randomNet.createNet(oc.getInt("rand.iterations"), oc.getBool("rand.grid"));
221 return net;
222}
223
224
225
226int
227main(int argc, char** argv) {
230 // give some application descriptions
231 oc.setApplicationDescription("Synthetic network generator for the microscopic, multi-modal traffic simulation SUMO.");
232 oc.setApplicationName("netgenerate", "Eclipse SUMO netgenerate Version " VERSION_STRING);
233 int ret = 0;
234 try {
235 // initialise the application system (messaging, xml, options)
237 fillOptions();
238 OptionsIO::setArgs(argc, argv);
240 if (oc.processMetaOptions(argc < 2)) {
242 return 0;
243 }
244 XMLSubSys::setValidation(oc.getString("xml-validation"), "never", "never");
246 if (!checkOptions()) {
247 throw ProcessError();
248 }
250 Position(oc.getFloat("offset.x"), oc.getFloat("offset.y")),
251 Boundary(), Boundary());
253 NBNetBuilder nb;
254 nb.applyOptions(oc);
255 if (oc.isSet("type-files")) {
257 NITypeLoader::load(handler, oc.getStringVector("type-files"), "types");
258 }
259 // build the netgen-network description
260 NGNet* net = buildNetwork(nb);
261 // ... and we have to do this...
262 oc.resetWritable();
263 // transfer to the netbuilding structures
264 net->toNB();
265 delete net;
266 // report generated structures
267 WRITE_MESSAGE(TL(" Generation done;"));
268 WRITE_MESSAGE(" " + toString<int>(nb.getNodeCont().size()) + " nodes generated.");
269 WRITE_MESSAGE(" " + toString<int>(nb.getEdgeCont().size()) + " edges generated.");
270 if (oc.getBool("tls.discard-simple")) {
271 nb.getNodeCont().discardTrafficLights(nb.getTLLogicCont(), true, false);
272 int removed = nb.getTLLogicCont().getNumExtracted();
273 if (removed > 0) {
274 WRITE_MESSAGE(" Removed " + toString(removed) + " traffic lights at geometry-like nodes");
275 }
276 }
277 nb.compute(oc);
279 NWFrame::writeNetwork(oc, nb);
280 } catch (const ProcessError& e) {
281 if (std::string(e.what()) != std::string("Process Error") && std::string(e.what()) != std::string("")) {
282 WRITE_ERROR(e.what());
283 }
284 MsgHandler::getErrorInstance()->inform("Quitting (on error).", false);
285 ret = 1;
286#ifndef _DEBUG
287 } catch (const std::exception& e) {
288 if (std::string(e.what()) != std::string("")) {
289 WRITE_ERROR(e.what());
290 }
291 MsgHandler::getErrorInstance()->inform("Quitting (on error).", false);
292 ret = 1;
293 } catch (...) {
294 MsgHandler::getErrorInstance()->inform("Quitting (on unknown error).", false);
295 ret = 1;
296#endif
297 }
299 if (ret == 0) {
300 std::cout << "Success." << std::endl;
301 }
302 return ret;
303}
304
305
306/****************************************************************************/
#define DEG2RAD(x)
Definition: GeomHelper.h:35
#define WRITE_MESSAGE(msg)
Definition: MsgHandler.h:267
#define WRITE_ERROR(msg)
Definition: MsgHandler.h:274
#define WRITE_WARNING(msg)
Definition: MsgHandler.h:265
#define TL(string)
Definition: MsgHandler.h:282
const double SUMO_const_laneWidth
Definition: StdDefs.h:48
T MAX2(T a, T b)
Definition: StdDefs.h:77
std::string toString(const T &t, std::streamsize accuracy=gPrecision)
Definition: ToString.h:46
A class that stores a 2D geometrical boundary.
Definition: Boundary.h:39
static bool init(OptionsCont &oc)
Initialises the processing and the final instance using the given options.
static MsgHandler * getErrorInstance()
Returns the instance to add errors to.
Definition: MsgHandler.cpp:79
virtual void inform(std::string msg, bool addType=true)
adds a new error to the list
Definition: MsgHandler.cpp:116
static void setupI18n(const std::string &locale="")
set up gettext stuff
Definition: MsgHandler.cpp:228
static void initOutputOptions()
init output options
Definition: MsgHandler.cpp:255
int size() const
Returns the number of edges.
Definition: NBEdgeCont.h:289
static bool checkOptions()
Checks set options from the OptionsCont-singleton for being valid.
Definition: NBFrame.cpp:696
static void fillOptions(bool forNetgen)
Inserts options used by the network converter.
Definition: NBFrame.cpp:47
Instance responsible for building networks.
Definition: NBNetBuilder.h:107
NBNodeCont & getNodeCont()
Returns a reference to the node container.
Definition: NBNetBuilder.h:144
NBEdgeCont & getEdgeCont()
Definition: NBNetBuilder.h:139
NBTypeCont & getTypeCont()
Returns a reference to the type container.
Definition: NBNetBuilder.h:149
NBTrafficLightLogicCont & getTLLogicCont()
Returns a reference to the traffic light logics container.
Definition: NBNetBuilder.h:154
void applyOptions(OptionsCont &oc)
Initialises the storage by applying given options.
void compute(OptionsCont &oc, const std::set< std::string > &explicitTurnarounds=std::set< std::string >(), bool mayAddOrRemove=true)
Performs the network building steps.
int size() const
Returns the number of nodes stored in this container.
Definition: NBNodeCont.h:295
void printBuiltNodesStatistics() const
Prints statistics about built nodes.
void discardTrafficLights(NBTrafficLightLogicCont &tlc, bool geometryLike, bool guessSignals)
int getNumExtracted() const
return the number of extracted traffic light definitions
static void fillOptions()
Inserts options used by the network generator.
Definition: NGFrame.cpp:38
static bool checkOptions()
Checks set options from the OptionsCont-singleton for being valid.
Definition: NGFrame.cpp:218
The class storing the generated network.
Definition: NGNet.h:47
void toNB() const
Converts the stored network into its netbuilder-representation.
Definition: NGNet.cpp:234
void createChequerBoard(int numX, int numY, double spaceX, double spaceY, double xAttachLength, double yAttachLength)
Creates a grid network.
Definition: NGNet.cpp:93
void createSpiderWeb(int numRadDiv, int numCircles, double spaceRad, bool hasCenter)
Creates a spider network.
Definition: NGNet.cpp:164
A class that builds random network using an algorithm by Markus Hartinger.
void createNet(int numNodes, bool gridMode)
Builds a NGNet using the set values.
static bool load(SUMOSAXHandler *handler, const std::vector< std::string > &files, const std::string &type, const bool stringParse=false)
Importer for edge type information stored in XML.
static void writeNetwork(const OptionsCont &oc, NBNetBuilder &nb)
Writes the network stored in the given net builder.
Definition: NWFrame.cpp:174
static void fillOptions(bool forNetgen)
Inserts options used by the network writer.
Definition: NWFrame.cpp:48
static bool checkOptions()
Checks set options from the OptionsCont-singleton for being valid.
Definition: NWFrame.cpp:125
A storage for options typed value containers)
Definition: OptionsCont.h:89
void setAdditionalHelpMessage(const std::string &add)
Sets an additional message to be printed at the begin of the help screen.
void addDescription(const std::string &name, const std::string &subtopic, const std::string &description)
Adds a description for an option.
void doRegister(const std::string &name, Option *v)
Adds an option under the given name.
Definition: OptionsCont.cpp:76
bool isSet(const std::string &name, bool failOnNonExistant=true) const
Returns the information whether the named option is set.
double getFloat(const std::string &name) const
Returns the double-value of the named option (only for Option_Float)
int getInt(const std::string &name) const
Returns the int-value of the named option (only for Option_Integer)
void setApplicationName(const std::string &appName, const std::string &fullName)
Sets the application name.
std::string getString(const std::string &name) const
Returns the string-value of the named option (only for Option_String)
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:97
bool isDefault(const std::string &name) const
Returns the information whether the named option has still the default value.
void setApplicationDescription(const std::string &appDesc)
Sets the application description.
void addOptionSubTopic(const std::string &topic)
Adds an option subtopic.
bool getBool(const std::string &name) const
Returns the boolean-value of the named option (only for Option_Bool)
const StringVector & getStringVector(const std::string &name) const
Returns the list of string-value of the named option (only for Option_StringVector)
void resetWritable()
Resets all options to be writeable.
static OptionsCont & getOptions()
Retrieves the options.
Definition: OptionsCont.cpp:59
bool processMetaOptions(bool missingOptions)
Checks for help and configuration output, returns whether we should exit.
void addCallExample(const std::string &example, const std::string &desc)
Add a call example.
static void setArgs(int argc, char **argv)
Stores the command line arguments for later parsing.
Definition: OptionsIO.cpp:58
static void getOptions(const bool commandLineOnly=false)
Parses the command line arguments and loads the configuration.
Definition: OptionsIO.cpp:74
A point in 2D or 3D with translation and scaling methods.
Definition: Position.h:37
static void insertRandOptions()
Initialises the given options container with random number options.
Definition: RandHelper.cpp:58
static void initRandGlobal(SumoRNG *which=nullptr)
Reads the given random number options and initialises the random number generator in accordance.
Definition: RandHelper.cpp:87
bool add(T val, double prob, bool checkDuplicates=true)
Adds a value with an assigned probability to the distribution.
static void close()
Closes all of an applications subsystems.
static void addConfigurationOptions(OptionsCont &oc)
Adds configuration options to the given container.
Definition: SystemFrame.cpp:38
static void addReportOptions(OptionsCont &oc)
Adds reporting options to the given container.
Definition: SystemFrame.cpp:67
static bool checkOptions()
checks shared options and sets StdDefs
static void setValidation(const std::string &validationScheme, const std::string &netValidationScheme, const std::string &routeValidationScheme)
Enables or disables validation.
Definition: XMLSubSys.cpp:65
static void init()
Initialises the xml-subsystem.
Definition: XMLSubSys.cpp:54
bool checkOptions()
Definition: netgen_main.cpp:99
void fillOptions()
Definition: netgen_main.cpp:59
int main(int argc, char **argv)
NGNet * buildNetwork(NBNetBuilder &nb)
#define M_PI
Definition: odrSpiral.cpp:45