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-2019 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 
46 // ===========================================================================
47 // method definitions
48 // ===========================================================================
49 void
50 NWFrame::fillOptions(bool forNetgen) {
52  // register options
53  oc.doRegister("output-file", 'o', new Option_FileName());
54  oc.addSynonyme("output-file", "sumo-output");
55  oc.addSynonyme("output-file", "output");
56  oc.addDescription("output-file", "Output", "The generated net will be written to FILE");
57 
58  oc.doRegister("plain-output-prefix", new Option_FileName());
59  oc.addSynonyme("plain-output-prefix", "plain-output");
60  oc.addSynonyme("plain-output-prefix", "plain");
61  oc.addDescription("plain-output-prefix", "Output", "Prefix of files to write plain xml nodes, edges and connections to");
62 
63  oc.doRegister("junctions.join-output", new Option_FileName());
64  oc.addDescription("junctions.join-output", "Output",
65  "Writes information about joined junctions to FILE (can be loaded as additional node-file to reproduce joins");
66 
67  oc.doRegister("prefix", new Option_String(""));
68  oc.addDescription("prefix", "Output", "Defines a prefix for edge and junction names");
69 
70 #ifdef PROJ_API_FILE
71  if (!forNetgen) {
72  oc.doRegister("proj.plain-geo", new Option_Bool(false));
73  oc.addDescription("proj.plain-geo", "Projection", "Write geo coordinates in plain-xml");
74  }
75 #endif // PROJ_API_FILE
76 
77  oc.doRegister("amitran-output", new Option_FileName());
78  oc.addDescription("amitran-output", "Output", "The generated net will be written to FILE using Amitran format");
79 
80  oc.doRegister("matsim-output", new Option_FileName());
81  oc.addDescription("matsim-output", "Output", "The generated net will be written to FILE using MATsim format");
82 
83  oc.doRegister("opendrive-output", new Option_FileName());
84  oc.addDescription("opendrive-output", "Output", "The generated net will be written to FILE using OpenDRIVE format");
85 
86  oc.doRegister("dlr-navteq-output", new Option_FileName());
87  oc.addDescription("dlr-navteq-output", "Output", "The generated net will be written to dlr-navteq files with the given PREFIX");
88 
89  oc.doRegister("dlr-navteq.precision", new Option_Integer(2));
90  oc.addDescription("dlr-navteq.precision", "Output", "The network coordinates are written with the specified level of output precision");
91 
92  oc.doRegister("output.street-names", new Option_Bool(false));
93  oc.addDescription("output.street-names", "Output", "Street names will be included in the output (if available)");
94 
95  oc.doRegister("output.original-names", new Option_Bool(false));
96  oc.addDescription("output.original-names", "Output", "Writes original names, if given, as parameter");
97 
98  oc.doRegister("street-sign-output", new Option_FileName());
99  oc.addDescription("street-sign-output", "Output", "Writes street signs as POIs to FILE");
100 
101  if (!forNetgen) {
102  oc.doRegister("ptstop-output", new Option_FileName());
103  oc.addDescription("ptstop-output", "Output", "Writes public transport stops to FILE");
104  oc.doRegister("ptline-output", new Option_FileName());
105  oc.addDescription("ptline-output", "Output", "Writes public transport lines to FILE");
106  oc.doRegister("ptline-clean-up", new Option_Bool(false));
107  oc.addDescription("ptline-clean-up", "Output", "Clean-up pt stops that are not served by any line");
108 
109  oc.doRegister("parking-output", new Option_FileName());
110  oc.addDescription("parking-output", "Output", "Writes parking areas to FILE");
111 
112  oc.doRegister("railway.topology.output", new Option_FileName());
113  oc.addDescription("railway.topology.output", "Output", "Analyse topology of the railway network");
114 
115  oc.doRegister("polygon-output", new Option_FileName());
116  oc.addDescription("polygon-output", "Output", "Write shapes that are embedded in the network input and that are not supported by polyconvert (OpenDRIVE)");
117  }
118 
119  // register opendrive options
120  oc.doRegister("opendrive-output.straight-threshold", new Option_Float(0.00000001)); // matching the angular output precision in NWWriter_OpenDrive
121  oc.addDescription("opendrive-output.straight-threshold", "Output", "Builds parameterized curves whenever the angular change between straight segments exceeds FLOAT degrees");
122 }
123 
124 
125 bool
128  bool ok = true;
129  // check whether the output is valid and can be build
130  if (!oc.isSet("output-file")
131  && !oc.isSet("plain-output-prefix")
132  && !oc.isSet("amitran-output")
133  && !oc.isSet("matsim-output")
134  && !oc.isSet("opendrive-output")
135  && !oc.isSet("dlr-navteq-output")) {
136  std::string net = "net.net.xml";
137  if (oc.isSet("configuration-file")) {
138  net = FileHelpers::getConfigurationRelative(oc.getString("configuration-file"), net);
139  }
140  oc.setDefault("output-file", net);
141  }
142  // some outputs need internal lanes
143  if (oc.isSet("opendrive-output") && oc.getBool("no-internal-links")) {
144  WRITE_ERROR("OpenDRIVE export needs internal links computation.");
145  ok = false;
146  }
147  if (oc.isSet("opendrive-output") && oc.isDefault("no-internal-links")) {
148  oc.set("no-internal-links", "false");
149  }
150  if (oc.isSet("opendrive-output") && oc.isDefault("rectangular-lane-cut")) {
151  oc.set("rectangular-lane-cut", "true");
152  }
153  if (oc.isSet("opendrive-output") && !oc.getBool("rectangular-lane-cut")) {
154  WRITE_WARNING("OpenDRIVE cannot represent oblique lane cuts and should use option 'rectangular-lane-cut'.");
155  }
156  if (oc.isSet("dlr-navteq-output") && oc.isDefault("numerical-ids")) {
157  oc.set("numerical-ids", "true");
158  }
159  if (oc.isSet("dlr-navteq-output") && oc.isDefault("osm.all-attributes")) {
160  oc.set("osm.all-attributes", "true");
161  }
162  if (oc.exists("ptline-output") && oc.isSet("ptline-output") && !oc.isSet("ptstop-output")) {
163  WRITE_ERROR("public transport lines output requires 'ptstop-output' to be set");
164  ok = false;
165  }
166  if (oc.exists("ptline-clean-up") && oc.getBool("ptline-clean-up") && !oc.isSet("ptline-output")) {
167  WRITE_WARNING("'ptline-clean-up' only works in conjunction with 'ptline-output'. Ignoring invalid option.");
168  }
169 
170  return ok;
171 }
172 
173 
174 void
176  long before = SysUtils::getCurrentMillis();
177  PROGRESS_BEGIN_MESSAGE("Writing network");
184  PROGRESS_TIME_MESSAGE(before);
185 }
186 
187 
188 void
190  dev.writeAttr(SUMO_ATTR_X, pos.x());
191  dev.writeAttr(SUMO_ATTR_Y, pos.y());
192  if (pos.z() != 0) {
193  dev.writeAttr(SUMO_ATTR_Z, pos.z());
194  }
195 }
196 
197 /****************************************************************************/
198 
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:126
static std::string getConfigurationRelative(const std::string &configPath, const std::string &path)
Returns the second path as a relative path to the first file.
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:239
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:243
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:241
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:189
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:175
#define WRITE_ERROR(msg)
Definition: MsgHandler.h:245
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:110
A storage for options typed value containers)
Definition: OptionsCont.h:90
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:50
static long getCurrentMillis()
Returns the current time in milliseconds.
Definition: SysUtils.cpp:39
static void writeNetwork(const OptionsCont &oc, NBNetBuilder &nb)
Writes the network into a MATSim-file.