Eclipse 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-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/****************************************************************************/
20// Sets and checks options for netwrite
21/****************************************************************************/
22#include <config.h>
23
24#include <string>
32#include "NWFrame.h"
33#include "NWWriter_SUMO.h"
34#include "NWWriter_Amitran.h"
35#include "NWWriter_MATSim.h"
36#include "NWWriter_XML.h"
37#include "NWWriter_OpenDrive.h"
38#include "NWWriter_DlrNavteq.h"
39
40// ===========================================================================
41// static members
42// ===========================================================================
43
44// ===========================================================================
45// method definitions
46// ===========================================================================
47void
48NWFrame::fillOptions(bool forNetgen) {
50 // register options
51 oc.doRegister("output-file", 'o', new Option_FileName());
52 oc.addSynonyme("output-file", "sumo-output");
53 oc.addSynonyme("output-file", "output");
54 oc.addDescription("output-file", "Output", "The generated net will be written to FILE");
55
56 oc.doRegister("plain-output-prefix", 'p', new Option_FileName());
57 oc.addSynonyme("plain-output-prefix", "plain-output");
58 oc.addSynonyme("plain-output-prefix", "plain");
59 oc.addDescription("plain-output-prefix", "Output", "Prefix of files to write plain xml nodes, edges and connections to");
60
61 oc.doRegister("junctions.join-output", new Option_FileName());
62 oc.addDescription("junctions.join-output", "Output",
63 "Writes information about joined junctions to FILE (can be loaded as additional node-file to reproduce joins");
64
65 oc.doRegister("prefix", new Option_String(""));
66 oc.addDescription("prefix", "Output", "Defines a prefix for edge and junction names");
67
68#ifdef PROJ_API_FILE
69 if (!forNetgen) {
70 oc.doRegister("proj.plain-geo", new Option_Bool(false));
71 oc.addDescription("proj.plain-geo", "Projection", "Write geo coordinates in plain-xml");
72 }
73#endif // PROJ_API_FILE
74
75 oc.doRegister("amitran-output", new Option_FileName());
76 oc.addDescription("amitran-output", "Output", "The generated net will be written to FILE using Amitran format");
77
78 oc.doRegister("matsim-output", new Option_FileName());
79 oc.addDescription("matsim-output", "Output", "The generated net will be written to FILE using MATsim format");
80
81 oc.doRegister("opendrive-output", new Option_FileName());
82 oc.addDescription("opendrive-output", "Output", "The generated net will be written to FILE using OpenDRIVE format");
83
84 oc.doRegister("dlr-navteq-output", new Option_FileName());
85 oc.addDescription("dlr-navteq-output", "Output", "The generated net will be written to dlr-navteq files with the given PREFIX");
86
87 oc.doRegister("dlr-navteq.precision", new Option_Integer(2));
88 oc.addDescription("dlr-navteq.precision", "Output", "The network coordinates are written with the specified level of output precision");
89
90 oc.doRegister("output.street-names", new Option_Bool(false));
91 oc.addDescription("output.street-names", "Output", "Street names will be included in the output (if available)");
92
93 oc.doRegister("output.original-names", new Option_Bool(false));
94 oc.addDescription("output.original-names", "Output", "Writes original names, if given, as parameter");
95
96 oc.doRegister("street-sign-output", new Option_FileName());
97 oc.addDescription("street-sign-output", "Output", "Writes street signs as POIs to FILE");
98
99 if (!forNetgen) {
100 oc.doRegister("ptstop-output", new Option_FileName());
101 oc.addDescription("ptstop-output", "Output", "Writes public transport stops to FILE");
102 oc.doRegister("ptline-output", new Option_FileName());
103 oc.addDescription("ptline-output", "Output", "Writes public transport lines to FILE");
104 oc.doRegister("ptline-clean-up", new Option_Bool(false));
105 oc.addDescription("ptline-clean-up", "Output", "Clean-up pt stops that are not served by any line");
106
107 oc.doRegister("parking-output", new Option_FileName());
108 oc.addDescription("parking-output", "Output", "Writes parking areas to FILE");
109
110 oc.doRegister("railway.topology.output", new Option_FileName());
111 oc.addDescription("railway.topology.output", "Output", "Analyze topology of the railway network");
112
113 oc.doRegister("polygon-output", new Option_FileName());
114 oc.addSynonyme("polygon-output", "taz-output");
115 oc.addDescription("polygon-output", "Output", "Write shapes that are embedded in the network input and that are not supported by polyconvert (OpenDRIVE)");
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
124bool
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(TL("OpenDRIVE export needs internal links computation."));
144 ok = false;
145 }
146 if (oc.isSet("opendrive-output") && oc.isDefault("no-internal-links")) {
147 oc.setDefault("no-internal-links", "false");
148 }
149 if (oc.isSet("opendrive-output") && oc.isDefault("rectangular-lane-cut")) {
150 oc.setDefault("rectangular-lane-cut", "true");
151 }
152 if (oc.isSet("opendrive-output") && !oc.getBool("rectangular-lane-cut")) {
153 WRITE_WARNING(TL("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.setDefault("numerical-ids", "true");
157 }
158 if (oc.isSet("dlr-navteq-output") && oc.isDefault("osm.all-attributes")) {
159 oc.setDefault("osm.all-attributes", "true");
160 }
161 if (oc.exists("ptline-output") && oc.isSet("ptline-output") && !oc.isSet("ptstop-output")) {
162 WRITE_ERROR(TL("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(TL("'ptline-clean-up' only works in conjunction with 'ptline-output'. Ignoring invalid option."));
167 }
168
169 return ok;
170}
171
172
173void
175 const long before = PROGRESS_BEGIN_TIME_MESSAGE("Writing network");
181 NWWriter_XML::writeNetwork(oc, oc.isSet("plain-output-prefix") ? oc.getString("plain-output-prefix") : "", nb);
182 PROGRESS_TIME_MESSAGE(before);
183}
184
185
186void
188 dev.writeAttr(SUMO_ATTR_X, pos.x());
189 dev.writeAttr(SUMO_ATTR_Y, pos.y());
190 if (pos.z() != 0) {
191 dev.writeAttr(SUMO_ATTR_Z, pos.z());
192 }
193}
194
195
196/****************************************************************************/
#define WRITE_ERROR(msg)
Definition: MsgHandler.h:274
#define WRITE_WARNING(msg)
Definition: MsgHandler.h:265
#define PROGRESS_BEGIN_TIME_MESSAGE(msg)
Definition: MsgHandler.h:271
#define TL(string)
Definition: MsgHandler.h:282
#define PROGRESS_TIME_MESSAGE(before)
Definition: MsgHandler.h:272
@ SUMO_ATTR_Y
@ SUMO_ATTR_Z
@ SUMO_ATTR_X
static std::string getConfigurationRelative(const std::string &configPath, const std::string &path)
Returns the second path as a relative path to the first file.
Instance responsible for building networks.
Definition: NBNetBuilder.h:107
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 void writePositionLong(const Position &pos, OutputDevice &dev)
Writes the given position to device in long format (one attribute per dimension)
Definition: NWFrame.cpp:187
static bool checkOptions()
Checks set options from the OptionsCont-singleton for being valid.
Definition: NWFrame.cpp:125
static void writeNetwork(const OptionsCont &oc, NBNetBuilder &nb)
Writes the network into a Amitran-file.
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 into a MATSim-file.
static void writeNetwork(const OptionsCont &oc, NBNetBuilder &nb)
Writes the network into a openDRIVE-file.
static void writeNetwork(const OptionsCont &oc, NBNetBuilder &nb)
Writes the network into a SUMO-file.
static void writeNetwork(const OptionsCont &oc, const std::string &prefix, NBNetBuilder &nb)
Writes the network into XML-files (nodes, edges, connections, traffic lights)
An integer-option.
Definition: Option.h:289
A storage for options typed value containers)
Definition: OptionsCont.h:89
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.
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.
bool setDefault(const std::string &name, const std::string &value)
Sets the given value for the named option as new default value.
bool exists(const std::string &name) const
Returns the information whether the named option is known.
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:59
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:61
OutputDevice & writeAttr(const SumoXMLAttr attr, const T &val)
writes a named attribute
Definition: OutputDevice.h:251
A point in 2D or 3D with translation and scaling methods.
Definition: Position.h:37
double x() const
Returns the x-position.
Definition: Position.h:55
double z() const
Returns the z-position.
Definition: Position.h:65
double y() const
Returns the y-position.
Definition: Position.h:60