Eclipse SUMO - Simulation of Urban MObility
netconvert_main.cpp
Go to the documentation of this file.
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 /****************************************************************************/
20 // Main for NETCONVERT
21 /****************************************************************************/
22 #include <config.h>
23 
24 #ifdef HAVE_VERSION_H
25 #include <version.h>
26 #endif
27 
28 #include <iostream>
29 #include <string>
30 #include <netimport/NIFrame.h>
31 #include <netimport/NILoader.h>
32 #include <netbuild/NBFrame.h>
33 #include <netbuild/NBNetBuilder.h>
34 #include <netwrite/NWFrame.h>
42 #include <utils/xml/XMLSubSys.h>
45 
46 
47 // ===========================================================================
48 // method definitions
49 // ===========================================================================
50 void
53  oc.addCallExample("-c <CONFIGURATION>", "generate net with options read from file");
54  oc.addCallExample("-n ./nodes.xml -e ./edges.xml -v -t ./owntypes.xml",
55  "generate net with given nodes, edges, and edge types doing verbose output");
56 
57  // insert options sub-topics
58  SystemFrame::addConfigurationOptions(oc); // this subtopic is filled here, too
59  oc.addOptionSubTopic("Input");
60  oc.addOptionSubTopic("Output");
62  oc.addOptionSubTopic("Processing");
63  oc.addOptionSubTopic("Building Defaults");
64  oc.addOptionSubTopic("TLS Building");
65  oc.addOptionSubTopic("Ramp Guessing");
66  oc.addOptionSubTopic("Edge Removal");
67  oc.addOptionSubTopic("Unregulated Nodes");
68  oc.addOptionSubTopic("Junctions");
69  oc.addOptionSubTopic("Pedestrian");
70  oc.addOptionSubTopic("Bicycle");
71  oc.addOptionSubTopic("Railway");
72  oc.addOptionSubTopic("Formats");
73 
75  NBFrame::fillOptions(oc, false);
76  NWFrame::fillOptions(oc, false);
78 }
79 
80 
81 bool
84  bool ok = NIFrame::checkOptions(oc);
85  ok &= NBFrame::checkOptions(oc);
86  ok &= NWFrame::checkOptions(oc);
87  ok &= SystemFrame::checkOptions(oc);
88  return ok;
89 }
90 
91 
92 /* -------------------------------------------------------------------------
93  * main
94  * ----------------------------------------------------------------------- */
95 int
96 main(int argc, char** argv) {
98  oc.setApplicationDescription(TL("Network importer / builder for the microscopic, multi-modal traffic simulation SUMO."));
99  oc.setApplicationName("netconvert", "Eclipse SUMO netconvert Version " VERSION_STRING);
100  int ret = 0;
101  try {
102  XMLSubSys::init();
103  fillOptions();
104  OptionsIO::setArgs(argc, argv);
106  if (oc.processMetaOptions(argc < 2)) {
108  return 0;
109  }
110  if (oc.isSet("edge-files") && !oc.isSet("type-files") && oc.isDefault("ignore-errors.edge-type")) {
111  oc.setDefault("ignore-errors.edge-type", "true");
112  }
113  XMLSubSys::setValidation(oc.getString("xml-validation"), oc.getString("xml-validation.net"), "never");
114  if (oc.isDefault("aggregate-warnings")) {
115  oc.setDefault("aggregate-warnings", "5");
116  }
118  if (!checkOptions()) {
119  throw ProcessError();
120  }
122  // build the projection
123  if (!GeoConvHelper::init(oc)) {
124  throw ProcessError(TL("Could not build projection!"));
125  }
126  NBNetBuilder nb;
127  nb.applyOptions(oc);
128  // load data
129  NILoader nl(nb);
130  nl.load(oc);
131  // flush aggregated errors and optionally ignore them
132  MsgHandler::getErrorInstance()->clear(oc.getBool("ignore-errors"));
133  // check whether any errors occurred
134  if (MsgHandler::getErrorInstance()->wasInformed()) {
135  throw ProcessError();
136  }
137  nb.compute(oc);
138  // check whether any errors occurred
139  if (MsgHandler::getErrorInstance()->wasInformed()) {
140  throw ProcessError();
141  }
142  // report
144  NWFrame::writeNetwork(oc, nb);
145  } catch (const ProcessError& e) {
148  if (std::string(e.what()) != std::string("Process Error") && std::string(e.what()) != std::string("")) {
149  WRITE_ERROR(e.what());
150  }
151  MsgHandler::getErrorInstance()->inform("Quitting (on error).", false);
152  ret = 1;
153 #ifndef _DEBUG
154  } catch (const std::exception& e) {
157  if (std::string(e.what()) != std::string("")) {
158  WRITE_ERROR(e.what());
159  }
160  MsgHandler::getErrorInstance()->inform("Quitting (on error).", false);
161  ret = 1;
162  } catch (...) {
165  MsgHandler::getErrorInstance()->inform("Quitting (on unknown error).", false);
166  ret = 1;
167 #endif
168  }
171  // report about ending
172  if (ret == 0) {
173  std::cout << "Success." << std::endl;
174  }
175  return ret;
176 }
177 
178 
179 /****************************************************************************/
#define WRITE_ERROR(msg)
Definition: MsgHandler.h:304
#define TL(string)
Definition: MsgHandler.h:315
static void clear()
delete all stored distributions
static void addProjectionOptions(OptionsCont &oc)
Adds projection options to the given container.
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:92
virtual void inform(std::string msg, bool addType=true)
adds a new error to the list
Definition: MsgHandler.cpp:154
static void initOutputOptions()
init output options
Definition: MsgHandler.cpp:316
static MsgHandler * getWarningInstance()
Returns the instance to add warnings to.
Definition: MsgHandler.cpp:79
virtual void clear(bool resetInformed=true)
Clears information whether an error occurred previously and print aggregated message summary.
Definition: MsgHandler.cpp:213
static void fillOptions(OptionsCont &oc, bool forNetgen)
Inserts options used by the network converter.
Definition: NBFrame.cpp:48
static bool checkOptions(OptionsCont &oc)
Checks set options from the OptionsCont-singleton for being valid.
Definition: NBFrame.cpp:732
Instance responsible for building networks.
Definition: NBNetBuilder.h:107
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.
NBNodeCont & getNodeCont()
Returns a reference to the node container.
Definition: NBNetBuilder.h:144
void printBuiltNodesStatistics() const
Prints statistics about built nodes.
static bool checkOptions(OptionsCont &oc)
Checks set options for being valid.
Definition: NIFrame.cpp:391
static void fillOptions(OptionsCont &oc, bool forNetedit=false)
Inserts options used by the network importer and network building modules.
Definition: NIFrame.cpp:48
Perfoms network import.
Definition: NILoader.h:48
void load(OptionsCont &oc)
Definition: NILoader.cpp:70
static void fillOptions(OptionsCont &oc, bool forNetgen)
Inserts options used by the network writer.
Definition: NWFrame.cpp:49
static void writeNetwork(const OptionsCont &oc, NBNetBuilder &nb)
Writes the network stored in the given net builder.
Definition: NWFrame.cpp:188
static bool checkOptions(OptionsCont &oc)
Checks set options for being valid.
Definition: NWFrame.cpp:139
A storage for options typed value containers)
Definition: OptionsCont.h:89
bool isSet(const std::string &name, bool failOnNonExistant=true) const
Returns the information whether the named option is set.
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)
bool isDefault(const std::string &name) const
Returns the information whether the named option has still the default value.
bool setDefault(const std::string &name, const std::string &value)
Sets the given value for the named option as new 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)
static OptionsCont & getOptions()
Retrieves the options.
Definition: OptionsCont.cpp:60
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
static void insertRandOptions(OptionsCont &oc)
Initialises the given options container with random number options.
Definition: RandHelper.cpp:59
static void initRandGlobal(SumoRNG *which=nullptr)
Reads the given random number options and initialises the random number generator in accordance.
Definition: RandHelper.cpp:87
static void close()
Closes all of an applications subsystems.
static bool checkOptions(OptionsCont &oc)
checks shared options and sets StdDefs
static void addConfigurationOptions(OptionsCont &oc)
Adds configuration options to the given container.
Definition: SystemFrame.cpp:38
static void setValidation(const std::string &validationScheme, const std::string &netValidationScheme, const std::string &routeValidationScheme)
Enables or disables validation.
Definition: XMLSubSys.cpp:66
static void init()
Initialises the xml-subsystem.
Definition: XMLSubSys.cpp:55
bool checkOptions()
void fillOptions()
int main(int argc, char **argv)