Line data Source code
1 : /****************************************************************************/
2 : // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
3 : // Copyright (C) 2002-2026 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 : /****************************************************************************/
14 : /// @file ROVehicle.cpp
15 : /// @author Daniel Krajzewicz
16 : /// @author Axel Wegener
17 : /// @author Michael Behrisch
18 : /// @author Jakob Erdmann
19 : /// @date Sept 2002
20 : ///
21 : // A vehicle as used by router
22 : /****************************************************************************/
23 : #include <config.h>
24 :
25 : #include <string>
26 : #include <iostream>
27 : #include <utils/common/StringUtils.h>
28 : #include <utils/common/ToString.h>
29 : #include <utils/common/MsgHandler.h>
30 : #include <utils/geom/GeoConvHelper.h>
31 : #include <utils/vehicle/SUMOVTypeParameter.h>
32 : #include <utils/options/OptionsCont.h>
33 : #include <utils/iodevices/OutputDevice.h>
34 : #include "RORouteDef.h"
35 : #include "RORoute.h"
36 : #include "ROHelper.h"
37 : #include "RONet.h"
38 : #include "ROLane.h"
39 : #include "ROVehicle.h"
40 :
41 : #define INVALID_STOP_POS -1
42 :
43 : // ===========================================================================
44 : // static members
45 : // ===========================================================================
46 : std::map<ConstROEdgeVector, std::string> ROVehicle::mySavedRoutes;
47 :
48 : // ===========================================================================
49 : // method definitions
50 : // ===========================================================================
51 304338 : ROVehicle::ROVehicle(const SUMOVehicleParameter& pars,
52 : RORouteDef* route, const SUMOVTypeParameter* type,
53 304338 : const RONet* net, MsgHandler* errorHandler):
54 : RORoutable(pars, type),
55 304338 : myRoute(route),
56 304338 : myJumpTime(-1) {
57 : getParameter().stops.clear();
58 912666 : if (route != nullptr && route->getFirstRoute() != nullptr) {
59 606693 : for (StopParVector::const_iterator s = route->getFirstRoute()->getStops().begin(); s != route->getFirstRoute()->getStops().end(); ++s) {
60 415 : addStop(*s, net, errorHandler);
61 : }
62 : }
63 305008 : for (StopParVector::const_iterator s = pars.stops.begin(); s != pars.stops.end(); ++s) {
64 670 : addStop(*s, net, errorHandler);
65 : }
66 304338 : }
67 :
68 :
69 : void
70 1085 : ROVehicle::addStop(const SUMOVehicleParameter::Stop& stopPar, const RONet* net, MsgHandler* errorHandler) {
71 1085 : const ROEdge* stopEdge = net->getEdge(stopPar.edge);
72 : assert(stopEdge != 0); // was checked when parsing the stop
73 1085 : if (stopEdge->prohibits(this)) {
74 0 : if (errorHandler != nullptr) {
75 0 : errorHandler->informf(TL("Stop edge '%' does not allow vehicle '%'."), stopEdge->getID(), getID());
76 : }
77 : return;
78 : }
79 : // where to insert the stop
80 : StopParVector::iterator iter = getParameter().stops.begin();
81 1085 : if (stopPar.index == STOP_INDEX_END || stopPar.index >= static_cast<int>(getParameter().stops.size())) {
82 : if (getParameter().stops.size() > 0) {
83 : iter = getParameter().stops.end();
84 : }
85 : } else {
86 0 : if (stopPar.index == STOP_INDEX_FIT) {
87 : iter = getParameter().stops.end();
88 : } else {
89 : iter += stopPar.index;
90 : }
91 : }
92 1085 : getParameter().stops.insert(iter, stopPar);
93 1085 : if (stopPar.jump >= 0) {
94 30 : if (stopEdge->isInternal()) {
95 0 : if (errorHandler != nullptr) {
96 0 : errorHandler->informf(TL("Jumps are not supported from internal stop edge '%'."), stopEdge->getID());
97 : }
98 : } else {
99 30 : if (myJumpTime < 0) {
100 25 : myJumpTime = 0;
101 : }
102 30 : myJumpTime += stopPar.jump;
103 : }
104 : }
105 : }
106 :
107 :
108 608579 : ROVehicle::~ROVehicle() {}
109 :
110 :
111 : const ROEdge*
112 742 : ROVehicle:: getDepartEdge() const {
113 742 : return myRoute->getFirstRoute()->getFirst();
114 : }
115 :
116 :
117 : void
118 302861 : ROVehicle::computeRoute(const RORouterProvider& provider,
119 : const bool removeLoops, MsgHandler* errorHandler) {
120 : SUMOAbstractRouter<ROEdge, ROVehicle>& router = provider.getVehicleRouter(getVClass());
121 : RORouteDef* const routeDef = getRouteDefinition();
122 : // check if the route definition is valid
123 302861 : if (routeDef == nullptr) {
124 0 : errorHandler->informf(TL("The vehicle '%' has no valid route."), getID());
125 0 : myRoutingSuccess = false;
126 19361 : return;
127 : }
128 302861 : routeDef->validateAlternatives(this, errorHandler);
129 302861 : if (routeDef->getFirstRoute() == nullptr) {
130 : // everything is invalid and no new routes will be computed
131 6 : myRoutingSuccess = false;
132 6 : return;
133 : }
134 302855 : std::shared_ptr<RORoute> current = routeDef->buildCurrentRoute(router, getDepartureTime(), *this);
135 302855 : if (current == nullptr || current->size() == 0) {
136 19345 : if (current == nullptr || !routeDef->discardSilent()) {
137 34840 : errorHandler->informf(TL("The vehicle '%' has no valid route."), getID());
138 : }
139 19345 : myRoutingSuccess = false;
140 19345 : return;
141 : }
142 : // check whether we have to evaluate the route for not containing loops
143 283510 : if (removeLoops) {
144 6231 : const ROEdge* requiredStart = (getParameter().departPosProcedure == DepartPosDefinition::GIVEN
145 6231 : || getParameter().departLaneProcedure == DepartLaneDefinition::GIVEN ? current->getEdgeVector().front() : 0);
146 6231 : const ROEdge* requiredEnd = (getParameter().arrivalPosProcedure == ArrivalPosDefinition::GIVEN
147 6231 : || getParameter().arrivalLaneProcedure == ArrivalLaneDefinition::GIVEN ? current->getEdgeVector().back() : 0);
148 : ConstROEdgeVector mandatory;
149 6266 : for (auto m : getMandatoryEdges(requiredStart, requiredEnd)) {
150 35 : mandatory.push_back(m.edge);
151 6231 : }
152 6231 : current->recheckForLoops(mandatory);
153 : // check whether the route is still valid
154 6231 : if (current->size() == 0) {
155 0 : errorHandler->informf(TL("The vehicle '%' has no valid route (after removing loops)."), getID());
156 0 : myRoutingSuccess = false;
157 : return;
158 : }
159 6231 : }
160 283510 : if (RONet::getInstance()->getMaxTraveltime() > 0) {
161 15 : double costs = router.recomputeCosts(current->getEdgeVector(), this, getDepartureTime());
162 15 : if (costs > RONet::getInstance()->getMaxTraveltime()) {
163 30 : errorHandler->informf(TL("The vehicle '%' has no valid route (traveltime % exceeds max-traveltime)."), getID(), time2string(TIME2STEPS(costs)));
164 10 : myRoutingSuccess = false;
165 10 : return;
166 : }
167 : }
168 : // add built route
169 567000 : std::shared_ptr<RORoute> replaced = routeDef->addAlternative(router, this, current, getDepartureTime(), errorHandler);
170 283480 : if (replaced != nullptr) {
171 157750 : if (getParameter().departEdge > 0) {
172 32 : updateIndex(replaced, current, getParameterMutable().departEdge);
173 : }
174 157750 : if (getParameter().arrivalEdge >= 0) {
175 16 : updateIndex(replaced, current, getParameterMutable().arrivalEdge);
176 : }
177 : }
178 283480 : myRoutingSuccess = true;
179 : }
180 :
181 :
182 : void
183 16 : ROVehicle::updateIndex(const std::shared_ptr<RORoute> replaced, const std::shared_ptr<RORoute> current, int& attr) {
184 : const ConstROEdgeVector& oldRoute = replaced->getEdgeVector();
185 16 : if ((int)oldRoute.size() > attr) {
186 16 : const ROEdge* old = oldRoute[attr];
187 : int skips = 0;
188 84 : for (int i = 0; i < attr; i++) {
189 68 : if (oldRoute[i] == old) {
190 0 : skips++;
191 : }
192 : }
193 : int i = 0;
194 160 : for (const ROEdge* cand : current->getEdgeVector()) {
195 144 : if (cand == old) {
196 16 : if (skips > 0) {
197 0 : skips--;
198 : } else {
199 16 : attr = i;
200 : }
201 : }
202 144 : i++;
203 : }
204 : }
205 16 : }
206 :
207 :
208 : std::vector<ROVehicle::Mandatory>
209 301398 : ROVehicle::getMandatoryEdges(const ROEdge* requiredStart, const ROEdge* requiredEnd) const {
210 301398 : const RONet* net = RONet::getInstance();
211 : std::vector<Mandatory> mandatory;
212 301398 : if (requiredStart) {
213 : double departPos = 0;
214 295177 : if (getParameter().departPosProcedure == DepartPosDefinition::GIVEN) {
215 843 : departPos = SUMOVehicleParameter::interpretEdgePos(getParameter().departPos, requiredStart->getLength(), SUMO_ATTR_DEPARTPOS, "vehicle '" + getID() + "'");
216 : }
217 295177 : mandatory.push_back(Mandatory(requiredStart, departPos));
218 : }
219 301398 : if (getParameter().via.size() != 0) {
220 : // via takes precedence over stop edges
221 48364 : for (const std::string& via : getParameter().via) {
222 33661 : mandatory.push_back(Mandatory(net->getEdge(via), INVALID_STOP_POS));
223 : }
224 : } else {
225 287600 : for (const auto& stop : getParameter().stops) {
226 905 : const ROEdge* e = net->getEdge(stop.edge);
227 905 : if (e->isInternal()) {
228 : // the edges before and after the internal edge are mandatory
229 10 : const ROEdge* before = e->getNormalBefore();
230 10 : const ROEdge* after = e->getNormalAfter();
231 10 : mandatory.push_back(Mandatory(before, INVALID_STOP_POS));
232 10 : mandatory.push_back(Mandatory(after, INVALID_STOP_POS, stop.jump));
233 : } else {
234 1790 : double endPos = SUMOVehicleParameter::interpretEdgePos(stop.endPos, e->getLength(), SUMO_ATTR_ENDPOS, "stop of vehicle '" + getID() + "' on edge '" + e->getID() + "'");
235 895 : mandatory.push_back(Mandatory(e, endPos, stop.jump));
236 : }
237 : }
238 : }
239 301398 : if (requiredEnd) {
240 : double arrivalPos = INVALID_STOP_POS;
241 295177 : if (getParameter().arrivalPosProcedure == ArrivalPosDefinition::GIVEN) {
242 480 : arrivalPos = SUMOVehicleParameter::interpretEdgePos(getParameter().arrivalPos, requiredEnd->getLength(), SUMO_ATTR_ARRIVALPOS, "vehicle '" + getID() + "'");
243 : }
244 295177 : mandatory.push_back(Mandatory(requiredEnd, arrivalPos));
245 : }
246 301398 : return mandatory;
247 0 : }
248 :
249 :
250 : void
251 401208 : ROVehicle::saveAsXML(OutputDevice& os, OutputDevice* const typeos, bool asAlternatives, OptionsCont& options, int cloneIndex) const {
252 401208 : if (typeos != nullptr && getType() != nullptr && !getType()->saved) {
253 494 : getType()->write(*typeos);
254 494 : getType()->saved = true;
255 : }
256 401208 : if (getType() != nullptr && !getType()->saved) {
257 5022 : getType()->write(os);
258 5022 : getType()->saved = asAlternatives;
259 : }
260 :
261 798150 : const bool writeTrip = options.exists("write-trips") && options.getBool("write-trips");
262 401208 : const bool writeGeoTrip = writeTrip && options.getBool("write-trips.geo");
263 401208 : const bool writeJunctions = writeTrip && options.getBool("write-trips.junctions");
264 401208 : const bool writeNamedRoute = !asAlternatives && options.getBool("named-routes");
265 798150 : const bool writeCosts = options.exists("write-costs") && options.getBool("write-costs");
266 802416 : const bool writeExit = options.exists("exit-times") && options.getBool("exit-times");
267 798150 : const bool writeLength = options.exists("route-length") && options.getBool("route-length");
268 798150 : const bool writeFlow = options.exists("keep-flows") && options.getBool("keep-flows") && isPartOfFlow();
269 :
270 : std::string routeID;
271 401208 : if (writeNamedRoute) {
272 68 : ConstROEdgeVector edges = myRoute->getUsedRoute()->getNormalEdges();
273 : auto it = mySavedRoutes.find(edges);
274 34 : if (it == mySavedRoutes.end()) {
275 26 : routeID = "r" + toString(mySavedRoutes.size());
276 13 : myRoute->getUsedRoute()->writeXMLDefinition(os, this, writeCosts, false, writeExit,
277 : writeLength, routeID);
278 13 : mySavedRoutes[edges] = routeID;
279 : } else {
280 21 : routeID = it->second;
281 : }
282 34 : }
283 401208 : const SumoXMLTag tag = writeFlow ? SUMO_TAG_FLOW : (writeTrip ? SUMO_TAG_TRIP : SUMO_TAG_VEHICLE);
284 : // write the vehicle (new style, with included routes)
285 401208 : if (cloneIndex == 0) {
286 802116 : getParameter().write(os, options, tag);
287 : } else {
288 150 : SUMOVehicleParameter p = getParameter();
289 : // @note id collisions may occur if scale-suffic occurs in other vehicle ids
290 300 : p.id += options.getString("scale-suffix") + toString(cloneIndex);
291 150 : p.write(os, options, tag);
292 150 : }
293 : // save the route
294 401208 : if (writeTrip) {
295 238068 : const ConstROEdgeVector edges = myRoute->getFirstRoute()->getEdgeVector();
296 : const ROEdge* from = nullptr;
297 : const ROEdge* to = nullptr;
298 79356 : if (edges.size() > 0) {
299 79356 : if (edges.front()->isTazConnector()) {
300 7300 : if (edges.size() > 1) {
301 7300 : from = edges[1];
302 7300 : if (from->isTazConnector() && writeJunctions && edges.front()->getSuccessors().size() > 0) {
303 : // routing was skipped
304 10 : from = edges.front()->getSuccessors(getVClass()).front();
305 : }
306 : }
307 : } else {
308 : from = edges[0];
309 : }
310 79356 : if (edges.back()->isTazConnector()) {
311 7300 : if (edges.size() > 1) {
312 7300 : to = edges[edges.size() - 2];
313 7300 : if (to->isTazConnector() && writeJunctions && edges.back()->getPredecessors().size() > 0) {
314 : // routing was skipped
315 5 : to = edges.back()->getPredecessors().front();
316 : }
317 : }
318 : } else {
319 72056 : to = edges[edges.size() - 1];
320 : }
321 : }
322 79356 : if (from != nullptr) {
323 79356 : if (writeGeoTrip) {
324 20 : Position fromPos = from->getLanes()[0]->getShape().positionAtOffset2D(0);
325 20 : if (GeoConvHelper::getFinal().usingGeoProjection()) {
326 0 : os.setPrecision(gPrecisionGeo);
327 0 : GeoConvHelper::getFinal().cartesian2geo(fromPos);
328 0 : os.writeAttr(SUMO_ATTR_FROMLONLAT, fromPos);
329 0 : os.setPrecision(gPrecision);
330 : } else {
331 20 : os.writeAttr(SUMO_ATTR_FROMXY, fromPos);
332 : }
333 79336 : } else if (writeJunctions) {
334 7250 : os.writeAttr(SUMO_ATTR_FROM_JUNCTION, from->getFromJunction()->getID());
335 : } else {
336 72086 : os.writeAttr(SUMO_ATTR_FROM, from->getID());
337 : }
338 : }
339 79356 : if (to != nullptr) {
340 79356 : if (writeGeoTrip) {
341 20 : Position toPos = to->getLanes()[0]->getShape().positionAtOffset2D(to->getLanes()[0]->getShape().length2D());
342 20 : if (GeoConvHelper::getFinal().usingGeoProjection()) {
343 0 : os.setPrecision(gPrecisionGeo);
344 0 : GeoConvHelper::getFinal().cartesian2geo(toPos);
345 0 : os.writeAttr(SUMO_ATTR_TOLONLAT, toPos);
346 0 : os.setPrecision(gPrecision);
347 : } else {
348 20 : os.writeAttr(SUMO_ATTR_TOXY, toPos);
349 : }
350 79336 : } else if (writeJunctions) {
351 7250 : os.writeAttr(SUMO_ATTR_TO_JUNCTION, to->getToJunction()->getID());
352 : } else {
353 72086 : os.writeAttr(SUMO_ATTR_TO, to->getID());
354 : }
355 : }
356 79356 : if (getParameter().via.size() > 0) {
357 : std::vector<std::string> viaOut;
358 : SumoXMLAttr viaAttr = (writeGeoTrip
359 7245 : ? (GeoConvHelper::getFinal().usingGeoProjection() ? SUMO_ATTR_VIALONLAT : SUMO_ATTR_VIAXY)
360 14470 : : (writeJunctions ? SUMO_ATTR_VIAJUNCTIONS : SUMO_ATTR_VIA));
361 21690 : for (const std::string& viaID : getParameter().via) {
362 14445 : const ROEdge* viaEdge = RONet::getInstance()->getEdge(viaID);
363 14445 : if (viaEdge->isTazConnector()) {
364 25 : if (viaEdge->getPredecessors().size() == 0) {
365 0 : continue;
366 : }
367 : // XXX used edge that was used in route
368 25 : viaEdge = viaEdge->getPredecessors().front();
369 : }
370 : assert(viaEdge != nullptr);
371 14445 : if (writeGeoTrip) {
372 10 : Position viaPos = viaEdge->getLanes()[0]->getShape().positionAtOffset2D(viaEdge->getLanes()[0]->getShape().length2D() / 2);
373 10 : if (GeoConvHelper::getFinal().usingGeoProjection()) {
374 0 : GeoConvHelper::getFinal().cartesian2geo(viaPos);
375 0 : viaOut.push_back(toString(viaPos, gPrecisionGeo));
376 : } else {
377 20 : viaOut.push_back(toString(viaPos, gPrecision));
378 : }
379 14435 : } else if (writeJunctions) {
380 10 : viaOut.push_back(viaEdge->getToJunction()->getID());
381 : } else {
382 14425 : viaOut.push_back(viaEdge->getID());
383 : }
384 : }
385 7245 : os.writeAttr(viaAttr, viaOut);
386 7245 : }
387 401208 : } else if (writeNamedRoute) {
388 34 : os.writeAttr(SUMO_ATTR_ROUTE, routeID);
389 : } else {
390 321818 : myRoute->writeXMLDefinition(os, this, asAlternatives, writeExit, writeCosts, writeLength);
391 : }
392 402980 : for (StopParVector::const_iterator stop = getParameter().stops.begin(); stop != getParameter().stops.end(); ++stop) {
393 1772 : stop->write(os);
394 : }
395 401208 : getParameter().writeParams(os);
396 802416 : os.closeTag();
397 401208 : }
398 :
399 :
400 : /****************************************************************************/
|
