Eclipse SUMO - Simulation of Urban MObility
Loading...
Searching...
No Matches
emissionsMap_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) 2013-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/****************************************************************************/
19// Main for an emissions map writer
20/****************************************************************************/
21#include <config.h>
22
23#ifdef HAVE_VERSION_H
24#include <version.h>
25#endif
26
27#include <iostream>
28#include <string>
29#include <ctime>
30#include <memory>
41#include <utils/xml/XMLSubSys.h>
44#include "VTypesHandler.h"
45
46
47// ===========================================================================
48// functions
49// ===========================================================================
50void single(const OptionsCont& oc, const std::string& of, const std::string& className, SUMOEmissionClass c,
51 double vMin, double vMax, double vStep,
52 double aMin, double aMax, double aStep,
53 double sMin, double sMax, double sStep,
54 bool verbose) {
55 if (verbose) {
56 WRITE_MESSAGEF(TL("Writing map of '%' into '%'."), className, of);
57 }
58 std::ofstream o(of.c_str());
59 if (!o.good()) {
60 throw ProcessError(TLF("Could not open file '%' for writing.", of));
61 }
62
63 std::unique_ptr<EnergyParams> energyParams;
64 std::map<std::string, SUMOVTypeParameter*> vTypes;
65 if (oc.isSet("vtype") || oc.isSet("additional-files")) {
66 if (!oc.isSet("additional-files")) {
67 throw ProcessError(TL("Option --vtype requires option --additional-files for loading vehicle types"));
68 }
69 if (!oc.isUsableFileList("additional-files")) {
70 throw ProcessError();
71 }
72 for (const std::string& file : oc.getStringVector("additional-files")) {
73 VTypesHandler typesHandler(file, vTypes);
74 if (!XMLSubSys::runParser(typesHandler, file)) {
75 throw ProcessError(TLF("Loading of % failed.", file));
76 }
77 }
78 if (!oc.isSet("vtype") && vTypes.size() != 1) {
79 throw ProcessError(TL("Vehicle type is not unique."));
80 }
81 const auto vTypeIt = oc.isSet("vtype") ? vTypes.find(oc.getString("vtype")) : vTypes.begin();
82 if (vTypeIt == vTypes.end()) {
83 throw ProcessError(TLF("Vehicle type '%' is not defined.", oc.getString("vtype")));
84 }
85 if (oc.isDefault("emission-class")) {
86 c = vTypeIt->second->emissionClass;
87 }
88 energyParams = std::unique_ptr<EnergyParams>(new EnergyParams(vTypeIt->second));
89 } else {
90 energyParams = std::unique_ptr<EnergyParams>(new EnergyParams());
91 }
92 for (double v = vMin; v <= vMax; v += vStep) {
93 for (double a = aMin; a <= aMax; a += aStep) {
94 for (double s = sMin; s <= sMax; s += sStep) {
95 const PollutantsInterface::Emissions result = PollutantsInterface::computeAll(c, v, a, s, energyParams.get());
96 o << v << ";" << a << ";" << s << ";" << "CO" << ";" << result.CO << std::endl;
97 o << v << ";" << a << ";" << s << ";" << "CO2" << ";" << result.CO2 << std::endl;
98 o << v << ";" << a << ";" << s << ";" << "HC" << ";" << result.HC << std::endl;
99 o << v << ";" << a << ";" << s << ";" << "PMx" << ";" << result.PMx << std::endl;
100 o << v << ";" << a << ";" << s << ";" << "NOx" << ";" << result.NOx << std::endl;
101 o << v << ";" << a << ";" << s << ";" << "fuel" << ";" << result.fuel << std::endl;
102 o << v << ";" << a << ";" << s << ";" << "electricity" << ";" << result.electricity << std::endl;
103 }
104 }
105 }
106}
107
108
109
110
111int
112main(int argc, char** argv) {
114 oc.setApplicationDescription(TL("Builds and writes an emissions map for SUMO's emission models."));
115 oc.setApplicationName("emissionsMap", "Eclipse SUMO emissionsMap Version " VERSION_STRING);
116 // add options
118 oc.addOptionSubTopic("Input");
119 oc.addOptionSubTopic("Processing");
120 oc.doRegister("iterate", 'i', new Option_Bool(false));
121 oc.addDescription("iterate", "Processing", TL("If set, maps for all available emissions are written."));
122
123 oc.doRegister("emission-class", 'e', new Option_String());
124 oc.addDescription("emission-class", "Processing", TL("Defines the name of the emission class to generate the map for."));
125
126 oc.doRegister("additional-files", new Option_FileName());
127 oc.addDescription("additional-files", "Input", TL("Load emission parameters (vTypes) from FILE(s)"));
128
129 oc.doRegister("vtype", new Option_String());
130 oc.addDescription("vtype", "Input", TL("Defines the vehicle type to use for emission parameters."));
131
132 oc.doRegister("v-min", new Option_Float(0.));
133 oc.addDescription("v-min", "Processing", TL("Defines the minimum velocity boundary of the map to generate (in m/s)."));
134 oc.doRegister("v-max", new Option_Float(50.));
135 oc.addDescription("v-max", "Processing", TL("Defines the maximum velocity boundary of the map to generate (in m/s)."));
136 oc.doRegister("v-step", new Option_Float(2.));
137 oc.addDescription("v-step", "Processing", TL("Defines the velocity step size (in m/s)."));
138 oc.doRegister("a-min", new Option_Float(-4.));
139 oc.addDescription("a-min", "Processing", TL("Defines the minimum acceleration boundary of the map to generate (in m/s^2)."));
140 oc.doRegister("a-max", new Option_Float(4.));
141 oc.addDescription("a-max", "Processing", TL("Defines the maximum acceleration boundary of the map to generate (in m/s^2)."));
142 oc.doRegister("a-step", new Option_Float(.5));
143 oc.addDescription("a-step", "Processing", TL("Defines the acceleration step size (in m/s^2)."));
144 oc.doRegister("s-min", new Option_Float(-10.));
145 oc.addDescription("s-min", "Processing", TL("Defines the minimum slope boundary of the map to generate (in deg)."));
146 oc.doRegister("s-max", new Option_Float(10.));
147 oc.addDescription("s-max", "Processing", TL("Defines the maximum slope boundary of the map to generate (in deg)."));
148 oc.doRegister("s-step", new Option_Float(1.));
149 oc.addDescription("s-step", "Processing", TL("Defines the slope step size (in deg)."));
150
151 oc.addOptionSubTopic("Output");
152 oc.doRegister("output-file", 'o', new Option_String());
153 oc.addSynonyme("output", "output-file");
154 oc.addDescription("output", "Output", TL("Defines the file (or the path if --iterate was set) to write the map(s) into."));
155
156 oc.addOptionSubTopic("Emissions");
157 oc.doRegister("emissions.volumetric-fuel", new Option_Bool(false));
158 oc.addDescription("emissions.volumetric-fuel", "Emissions", TL("Return fuel consumption values in (legacy) unit l instead of mg"));
159
160 oc.doRegister("phemlight-path", new Option_FileName(StringVector({ "./PHEMlight/" })));
161 oc.addDescription("phemlight-path", "Emissions", TL("Determines where to load PHEMlight definitions from"));
162
163 oc.doRegister("phemlight-year", new Option_Integer(0));
164 oc.addDescription("phemlight-year", "Emissions", TL("Enable fleet age modelling with the given reference year in PHEMlight5"));
165
166 oc.doRegister("phemlight-temperature", new Option_Float(INVALID_DOUBLE));
167 oc.addDescription("phemlight-temperature", "Emissions", TL("Set ambient temperature to correct NOx emissions in PHEMlight5"));
168
170
171 // run
172 int ret = 0;
173 try {
174 // initialise the application system (messaging, xml, options)
176 OptionsIO::setArgs(argc, argv);
178 if (oc.processMetaOptions(argc < 2)) {
180 return 0;
181 }
182
183 double vMin = oc.getFloat("v-min");
184 double vMax = oc.getFloat("v-max");
185 double vStep = oc.getFloat("v-step");
186 double aMin = oc.getFloat("a-min");
187 double aMax = oc.getFloat("a-max");
188 double aStep = oc.getFloat("a-step");
189 double sMin = oc.getFloat("s-min");
190 double sMax = oc.getFloat("s-max");
191 double sStep = oc.getFloat("s-step");
192 if (!oc.getBool("iterate")) {
193 if (!oc.isSet("emission-class")) {
194 throw ProcessError(TL("The emission class (-e) must be given."));
195 }
196 if (!oc.isSet("output-file")) {
197 throw ProcessError(TL("The output file (-o) must be given."));
198 }
200 single(oc, oc.getString("output-file"), oc.getString("emission-class"),
201 c, vMin, vMax, vStep, aMin, aMax, aStep, sMin, sMax, sStep, oc.getBool("verbose"));
202 } else {
203 if (!oc.isSet("output-file")) {
204 oc.set("output-file", "./");
205 }
206 const std::vector<SUMOEmissionClass> classes = PollutantsInterface::getAllClasses();
207 for (std::vector<SUMOEmissionClass>::const_iterator ci = classes.begin(); ci != classes.end(); ++ci) {
208 SUMOEmissionClass c = *ci;
209 single(oc, oc.getString("output-file") + PollutantsInterface::getName(c) + ".csv",
211 c, vMin, vMax, vStep, aMin, aMax, aStep, sMin, sMax, sStep, oc.getBool("verbose"));
212 }
213 }
214 } catch (InvalidArgument& e) {
216 MsgHandler::getErrorInstance()->inform("Quitting (on error).", false);
217 ret = 1;
218 } catch (ProcessError& e) {
219 if (std::string(e.what()) != std::string("Process Error") && std::string(e.what()) != std::string("")) {
221 }
222 MsgHandler::getErrorInstance()->inform("Quitting (on error).", false);
223 ret = 1;
224#ifndef _DEBUG
225 } catch (...) {
226 MsgHandler::getErrorInstance()->inform("Quitting (on unknown error).", false);
227 ret = 1;
228#endif
229 }
231 if (ret == 0) {
232 std::cout << "Success." << std::endl;
233 }
234 return ret;
235}
236
237
238/****************************************************************************/
#define WRITE_MESSAGEF(...)
Definition MsgHandler.h:298
#define TL(string)
Definition MsgHandler.h:315
#define TLF(string,...)
Definition MsgHandler.h:317
std::vector< std::string > StringVector
Definition of a vector of strings.
Definition Option.h:42
int SUMOEmissionClass
const double INVALID_DOUBLE
invalid double
Definition StdDefs.h:64
An upper class for objects with additional parameters.
static MsgHandler * getErrorInstance()
Returns the instance to add errors to.
virtual void inform(std::string msg, bool addType=true)
adds a new error to the list
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.
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)
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)
bool isDefault(const std::string &name) const
Returns the information whether the named option has still the default value.
void doRegister(const std::string &name, Option *o)
Adds an option under the given name.
void setApplicationDescription(const std::string &appDesc)
Sets the application description.
bool set(const std::string &name, const std::string &value, const bool append=false)
Sets the given value for the named option.
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)
static OptionsCont & getOptions()
Retrieves the options.
bool processMetaOptions(bool missingOptions)
Checks for help and configuration output, returns whether we should exit.
bool isUsableFileList(const std::string &name) const
Checks whether the named option is usable as a file list (with at least a single file)
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 std::string getName(const SUMOEmissionClass c)
Checks whether the string describes a known vehicle class.
static const std::vector< SUMOEmissionClass > getAllClasses()
Checks whether the string describes a known vehicle class.
static Emissions computeAll(const SUMOEmissionClass c, const double v, const double a, const double slope, const EnergyParams *param)
Returns the amount of all emitted pollutants given the vehicle type and state (in mg/s or ml/s for fu...
static SUMOEmissionClass getClassByName(const std::string &eClass, const SUMOVehicleClass vc=SVC_IGNORING)
Checks whether the string describes a known vehicle class.
static void close()
Closes all of an applications subsystems.
static void addConfigurationOptions(OptionsCont &oc)
Adds configuration options to the given container.
static void addReportOptions(OptionsCont &oc)
Adds reporting options to the given container.
An XML-Handler for amitran and netstate trajectories.
static void init()
Initialises the xml-subsystem.
Definition XMLSubSys.cpp:56
static bool runParser(GenericSAXHandler &handler, const std::string &file, const bool isNet=false, const bool isRoute=false, const bool isExternal=false, const bool catchExceptions=true)
Runs the given handler on the given file; returns if everything's ok.
int main(int argc, char **argv)
void single(const OptionsCont &oc, const std::string &of, const std::string &className, SUMOEmissionClass c, double vMin, double vMax, double vStep, double aMin, double aMax, double aStep, double sMin, double sMax, double sStep, bool verbose)
Storage for collected values of all emission types.