SUMO - Simulation of Urban MObility
NWFrame.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-2018 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 /****************************************************************************/
17 // Sets and checks options for netwrite
18 /****************************************************************************/
19 
20 
21 // ===========================================================================
22 // included modules
23 // ===========================================================================
24 #include <config.h>
25 
26 #include <string>
27 #include <utils/options/Option.h>
31 #include <utils/common/SysUtils.h>
33 #include <netbuild/NBNetBuilder.h>
34 #include "NWFrame.h"
35 #include "NWWriter_SUMO.h"
36 #include "NWWriter_Amitran.h"
37 #include "NWWriter_MATSim.h"
38 #include "NWWriter_XML.h"
39 #include "NWWriter_OpenDrive.h"
40 #include "NWWriter_DlrNavteq.h"
41 
42 // ===========================================================================
43 // static members
44 // ===========================================================================
45 const std::string NWFrame::MAJOR_VERSION = "1.1";
46 
47 
48 // ===========================================================================
49 // method definitions
50 // ===========================================================================
51 void
52 NWFrame::fillOptions(bool forNetgen) {
54  // register options
55  oc.doRegister("output-file", 'o', new Option_FileName());
56  oc.addSynonyme("output-file", "sumo-output");
57  oc.addSynonyme("output-file", "output");
58  oc.addDescription("output-file", "Output", "The generated net will be written to FILE");
59 
60  oc.doRegister("plain-output-prefix", new Option_FileName());
61  oc.addSynonyme("plain-output-prefix", "plain-output");
62  oc.addSynonyme("plain-output-prefix", "plain");
63  oc.addDescription("plain-output-prefix", "Output", "Prefix of files to write plain xml nodes, edges and connections to");
64 
65  oc.doRegister("junctions.join-output", new Option_FileName());
66  oc.addDescription("junctions.join-output", "Output",
67  "Writes information about joined junctions to FILE (can be loaded as additional node-file to reproduce joins");
68 
69  oc.doRegister("prefix", new Option_String(""));
70  oc.addDescription("prefix", "Output", "Defines a prefix for edge and junction names");
71 
72 #ifdef HAVE_PROJ
73  if (!forNetgen) {
74  oc.doRegister("proj.plain-geo", new Option_Bool(false));
75  oc.addDescription("proj.plain-geo", "Projection", "Write geo coordinates in plain-xml");
76  }
77 #endif // HAVE_PROJ
78 
79  oc.doRegister("amitran-output", new Option_FileName());
80  oc.addDescription("amitran-output", "Output", "The generated net will be written to FILE using Amitran format");
81 
82  oc.doRegister("matsim-output", new Option_FileName());
83  oc.addDescription("matsim-output", "Output", "The generated net will be written to FILE using MATsim format");
84 
85  oc.doRegister("opendrive-output", new Option_FileName());
86  oc.addDescription("opendrive-output", "Output", "The generated net will be written to FILE using OpenDRIVE format");
87 
88  oc.doRegister("dlr-navteq-output", new Option_FileName());
89  oc.addDescription("dlr-navteq-output", "Output", "The generated net will be written to dlr-navteq files with the given PREFIX");
90 
91  oc.doRegister("dlr-navteq.precision", new Option_Integer(2));
92  oc.addDescription("dlr-navteq.precision", "Output", "The network coordinates are written with the specified level of output precision");
93 
94  oc.doRegister("output.street-names", new Option_Bool(false));
95  oc.addDescription("output.street-names", "Output", "Street names will be included in the output (if available)");
96 
97  oc.doRegister("output.original-names", new Option_Bool(false));
98  oc.addDescription("output.original-names", "Output", "Writes original names, if given, as parameter");
99 
100  oc.doRegister("street-sign-output", new Option_FileName());
101  oc.addDescription("street-sign-output", "Output", "Writes street signs as POIs to FILE");
102 
103  if (!forNetgen) {
104  oc.doRegister("ptstop-output", new Option_FileName());
105  oc.addDescription("ptstop-output", "Output", "Writes public transport stops to FILE");
106  oc.doRegister("ptline-output", new Option_FileName());
107  oc.addDescription("ptline-output", "Output", "Writes public transport lines to FILE");
108  oc.doRegister("ptline-clean-up", new Option_Bool(false));
109  oc.addDescription("ptline-clean-up", "Output", "Clean-up pt stops that are not served by any line");
110 
111  oc.doRegister("parking-output", new Option_FileName());
112  oc.addDescription("parking-output", "Output", "Writes parking areas to FILE");
113 
114  oc.doRegister("railway.topology.output", new Option_FileName());
115  oc.addDescription("railway.topology.output", "Output", "Analyse topology of the railway network");
116  }
117 
118  // register opendrive options
119  oc.doRegister("opendrive-output.straight-threshold", new Option_Float(0.00000001)); // matching the angular output precision in NWWriter_OpenDrive
120  oc.addDescription("opendrive-output.straight-threshold", "Output", "Builds parameterized curves whenever the angular change between straight segments exceeds FLOAT degrees");
121 }
122 
123 
124 bool
127  bool ok = true;
128  // check whether the output is valid and can be build
129  if (!oc.isSet("output-file")
130  && !oc.isSet("plain-output-prefix")
131  && !oc.isSet("amitran-output")
132  && !oc.isSet("matsim-output")
133  && !oc.isSet("opendrive-output")
134  && !oc.isSet("dlr-navteq-output")) {
135  std::string net = "net.net.xml";
136  if (oc.isSet("configuration-file")) {
137  net = FileHelpers::getConfigurationRelative(oc.getString("configuration-file"), net);
138  }
139  oc.setDefault("output-file", net);
140  }
141  // some outputs need internal lanes
142  if (oc.isSet("opendrive-output") && oc.getBool("no-internal-links")) {
143  WRITE_ERROR("OpenDRIVE export needs internal links computation.");
144  ok = false;
145  }
146  if (oc.isSet("opendrive-output") && oc.isDefault("no-internal-links")) {
147  oc.set("no-internal-links", "false");
148  }
149  if (oc.isSet("opendrive-output") && oc.isDefault("rectangular-lane-cut")) {
150  oc.set("rectangular-lane-cut", "true");
151  }
152  if (oc.isSet("opendrive-output") && !oc.getBool("rectangular-lane-cut")) {
153  WRITE_WARNING("OpenDRIVE cannot represent oblique lane cuts and should use option 'rectangular-lane-cut'.");
154  }
155  if (oc.isSet("dlr-navteq-output") && oc.isDefault("numerical-ids")) {
156  oc.set("numerical-ids", "true");
157  }
158  if (oc.isSet("dlr-navteq-output") && oc.isDefault("osm.all-attributes")) {
159  oc.set("osm.all-attributes", "true");
160  }
161  if (oc.exists("ptline-output") && oc.isSet("ptline-output") && !oc.isSet("ptstop-output")) {
162  WRITE_ERROR("public transport lines output requires 'ptstop-output' to be set");
163  ok = false;
164  }
165  if (oc.exists("ptline-clean-up") && oc.getBool("ptline-clean-up") && !oc.isSet("ptline-output")) {
166  WRITE_WARNING("'ptline-clean-up' only works in conjunction with 'ptline-output'. Ignoring invalid option.");
167  }
168 
169  return ok;
170 }
171 
172 
173 void
175  long before = SysUtils::getCurrentMillis();
176  PROGRESS_BEGIN_MESSAGE("Writing network");
183  PROGRESS_TIME_MESSAGE(before);
184 }
185 
186 
187 void
189  dev.writeAttr(SUMO_ATTR_X, pos.x());
190  dev.writeAttr(SUMO_ATTR_Y, pos.y());
191  if (pos.z() != 0) {
192  dev.writeAttr(SUMO_ATTR_Z, pos.z());
193  }
194 }
195 
196 /****************************************************************************/
197 
void doRegister(const std::string &name, Option *v)
Adds an option under the given name.
Definition: OptionsCont.cpp:75
OutputDevice & writeAttr(const SumoXMLAttr attr, const T &val)
writes a named attribute
Definition: OutputDevice.h:256
static bool checkOptions()
Checks set options from the OptionsCont-singleton for being valid.
Definition: NWFrame.cpp:125
static std::string getConfigurationRelative(const std::string &configPath, const std::string &path)
Returns the second path as a relative path to the first file.
Definition: FileHelpers.cpp:75
static void writeNetwork(const OptionsCont &oc, NBNetBuilder &nb)
Writes the network into a Amitran-file.
double z() const
Returns the z-position.
Definition: Position.h:67
double y() const
Returns the y-position.
Definition: Position.h:62
double x() const
Returns the x-position.
Definition: Position.h:57
bool getBool(const std::string &name) const
Returns the boolean-value of the named option (only for Option_Bool)
bool isDefault(const std::string &name) const
Returns the information whether the named option has still the default value.
#define WRITE_WARNING(msg)
Definition: MsgHandler.h:241
static OptionsCont & getOptions()
Retrieves the options.
Definition: OptionsCont.cpp:58
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:96
bool isSet(const std::string &name, bool failOnNonExistant=true) const
Returns the information whether the named option is set.
#define PROGRESS_TIME_MESSAGE(before)
Definition: MsgHandler.h:245
static void writeNetwork(const OptionsCont &oc, NBNetBuilder &nb)
Writes the network into a SUMO-file.
static void writeNetwork(const OptionsCont &oc, NBNetBuilder &nb)
Writes the network into a openDRIVE-file.
bool setDefault(const std::string &name, const std::string &value)
Sets the given value for the named option as new default value.
A point in 2D or 3D with translation and scaling methods.
Definition: Position.h:39
std::string getString(const std::string &name) const
Returns the string-value of the named option (only for Option_String)
bool exists(const std::string &name) const
Returns the information whether the named option is known.
#define PROGRESS_BEGIN_MESSAGE(msg)
Definition: MsgHandler.h:243
static void writeNetwork(const OptionsCont &oc, NBNetBuilder &nb)
Writes the network into XML-files (nodes, edges, connections, traffic lights)
static void writePositionLong(const Position &pos, OutputDevice &dev)
Writes the given position to device in long format (one attribute per dimension)
Definition: NWFrame.cpp:188
static void writeNetwork(const OptionsCont &oc, NBNetBuilder &nb)
Writes the network into XML-files (nodes, edges, connections, traffic lights)
static void writeNetwork(const OptionsCont &oc, NBNetBuilder &nb)
Writes the network stored in the given net builder.
Definition: NWFrame.cpp:174
#define WRITE_ERROR(msg)
Definition: MsgHandler.h:247
bool set(const std::string &name, const std::string &value)
Sets the given value for the named option.
An integer-option.
Definition: Option.h:333
Instance responsible for building networks.
Definition: NBNetBuilder.h:109
A storage for options typed value containers)
Definition: OptionsCont.h:92
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:64
void addDescription(const std::string &name, const std::string &subtopic, const std::string &description)
Adds a description for an option.
static void fillOptions(bool forNetgen)
Inserts options used by the network writer.
Definition: NWFrame.cpp:52
static long getCurrentMillis()
Returns the current time in milliseconds.
Definition: SysUtils.cpp:39
static const std::string MAJOR_VERSION
The version number for written files.
Definition: NWFrame.h:62
static void writeNetwork(const OptionsCont &oc, NBNetBuilder &nb)
Writes the network into a MATSim-file.