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 298110 : ROVehicle::ROVehicle(const SUMOVehicleParameter& pars,
52 : RORouteDef* route, const SUMOVTypeParameter* type,
53 298110 : const RONet* net, MsgHandler* errorHandler):
54 : RORoutable(pars, type),
55 298110 : myRoute(route),
56 298110 : myJumpTime(-1) {
57 : getParameter().stops.clear();
58 893998 : if (route != nullptr && route->getFirstRoute() != nullptr) {
59 594702 : for (StopParVector::const_iterator s = route->getFirstRoute()->getStops().begin(); s != route->getFirstRoute()->getStops().end(); ++s) {
60 332 : addStop(*s, net, errorHandler);
61 : }
62 : }
63 298634 : for (StopParVector::const_iterator s = pars.stops.begin(); s != pars.stops.end(); ++s) {
64 524 : addStop(*s, net, errorHandler);
65 : }
66 298110 : }
67 :
68 :
69 : void
70 856 : ROVehicle::addStop(const SUMOVehicleParameter::Stop& stopPar, const RONet* net, MsgHandler* errorHandler) {
71 856 : const ROEdge* stopEdge = net->getEdge(stopPar.edge);
72 : assert(stopEdge != 0); // was checked when parsing the stop
73 856 : if (stopEdge->prohibits(this)) {
74 0 : if (errorHandler != nullptr) {
75 0 : errorHandler->inform("Stop edge '" + stopEdge->getID() + "' does not allow vehicle '" + getID() + "'.");
76 : }
77 : return;
78 : }
79 : // where to insert the stop
80 : StopParVector::iterator iter = getParameter().stops.begin();
81 856 : 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 856 : getParameter().stops.insert(iter, stopPar);
93 856 : if (stopPar.jump >= 0) {
94 24 : if (stopEdge->isInternal()) {
95 0 : if (errorHandler != nullptr) {
96 0 : errorHandler->inform("Jumps are not supported from internal stop edge '" + stopEdge->getID() + "'.");
97 : }
98 : } else {
99 24 : if (myJumpTime < 0) {
100 20 : myJumpTime = 0;
101 : }
102 24 : myJumpTime += stopPar.jump;
103 : }
104 : }
105 : }
106 :
107 :
108 596127 : ROVehicle::~ROVehicle() {}
109 :
110 :
111 : const ROEdge*
112 657 : ROVehicle:: getDepartEdge() const {
113 657 : return myRoute->getFirstRoute()->getFirst();
114 : }
115 :
116 :
117 : void
118 296957 : ROVehicle::computeRoute(const RORouterProvider& provider,
119 : const bool removeLoops, MsgHandler* errorHandler) {
120 : SUMOAbstractRouter<ROEdge, ROVehicle>& router = provider.getVehicleRouter(getVClass());
121 593914 : std::string noRouteMsg = "The vehicle '" + getID() + "' has no valid route.";
122 : RORouteDef* const routeDef = getRouteDefinition();
123 : // check if the route definition is valid
124 296957 : if (routeDef == nullptr) {
125 16 : errorHandler->inform(noRouteMsg);
126 0 : myRoutingSuccess = false;
127 0 : return;
128 : }
129 296957 : routeDef->validateAlternatives(this, errorHandler);
130 296957 : if (routeDef->getFirstRoute() == nullptr) {
131 : // everything is invalid and no new routes will be computed
132 3 : myRoutingSuccess = false;
133 3 : return;
134 : }
135 296954 : std::shared_ptr<RORoute> current = routeDef->buildCurrentRoute(router, getDepartureTime(), *this);
136 296954 : if (current == nullptr || current->size() == 0) {
137 19212 : if (current == nullptr || !routeDef->discardSilent()) {
138 51861 : errorHandler->inform(noRouteMsg);
139 : }
140 19212 : myRoutingSuccess = false;
141 19212 : return;
142 : }
143 : // check whether we have to evaluate the route for not containing loops
144 277742 : if (removeLoops) {
145 5215 : const ROEdge* requiredStart = (getParameter().departPosProcedure == DepartPosDefinition::GIVEN
146 5215 : || getParameter().departLaneProcedure == DepartLaneDefinition::GIVEN ? current->getEdgeVector().front() : 0);
147 5215 : const ROEdge* requiredEnd = (getParameter().arrivalPosProcedure == ArrivalPosDefinition::GIVEN
148 5215 : || getParameter().arrivalLaneProcedure == ArrivalLaneDefinition::GIVEN ? current->getEdgeVector().back() : 0);
149 : ConstROEdgeVector mandatory;
150 5243 : for (auto m : getMandatoryEdges(requiredStart, requiredEnd)) {
151 28 : mandatory.push_back(m.edge);
152 5215 : }
153 5215 : current->recheckForLoops(mandatory);
154 : // check whether the route is still valid
155 5215 : if (current->size() == 0) {
156 0 : errorHandler->inform(noRouteMsg + " (after removing loops)");
157 0 : myRoutingSuccess = false;
158 : return;
159 : }
160 5215 : }
161 277742 : if (RONet::getInstance()->getMaxTraveltime() > 0) {
162 12 : double costs = router.recomputeCosts(current->getEdgeVector(), this, getDepartureTime());
163 12 : if (costs > RONet::getInstance()->getMaxTraveltime()) {
164 24 : errorHandler->inform(noRouteMsg + " (traveltime " + time2string(TIME2STEPS(costs)) + " exceeds max-traveltime)");
165 8 : myRoutingSuccess = false;
166 8 : return;
167 : }
168 : }
169 : // add built route
170 555468 : std::shared_ptr<RORoute> replaced = routeDef->addAlternative(router, this, current, getDepartureTime(), errorHandler);
171 277718 : if (replaced != nullptr) {
172 154938 : if (getParameter().departEdge > 0) {
173 24 : updateIndex(replaced, current, getParameterMutable().departEdge);
174 : }
175 154938 : if (getParameter().arrivalEdge >= 0) {
176 24 : updateIndex(replaced, current, getParameterMutable().arrivalEdge);
177 : }
178 : }
179 277718 : myRoutingSuccess = true;
180 : }
181 :
182 :
183 : void
184 12 : ROVehicle::updateIndex(const std::shared_ptr<RORoute> replaced, const std::shared_ptr<RORoute> current, int& attr) {
185 : const ConstROEdgeVector& oldRoute = replaced->getEdgeVector();
186 12 : if ((int)oldRoute.size() > attr) {
187 12 : const ROEdge* old = oldRoute[attr];
188 : int skips = 0;
189 63 : for (int i = 0; i < attr; i++) {
190 51 : if (oldRoute[i] == old) {
191 0 : skips++;
192 : }
193 : }
194 : int i = 0;
195 120 : for (const ROEdge* cand : current->getEdgeVector()) {
196 108 : if (cand == old) {
197 12 : if (skips > 0) {
198 0 : skips--;
199 : } else {
200 12 : attr = i;
201 : }
202 : }
203 108 : i++;
204 : }
205 : }
206 12 : }
207 :
208 :
209 : std::vector<ROVehicle::Mandatory>
210 294743 : ROVehicle::getMandatoryEdges(const ROEdge* requiredStart, const ROEdge* requiredEnd) const {
211 294743 : const RONet* net = RONet::getInstance();
212 : std::vector<Mandatory> mandatory;
213 294743 : if (requiredStart) {
214 : double departPos = 0;
215 289536 : if (getParameter().departPosProcedure == DepartPosDefinition::GIVEN) {
216 705 : departPos = SUMOVehicleParameter::interpretEdgePos(getParameter().departPos, requiredStart->getLength(), SUMO_ATTR_DEPARTPOS, "vehicle '" + getID() + "'");
217 : }
218 289536 : mandatory.push_back(Mandatory(requiredStart, departPos));
219 : }
220 294743 : if (getParameter().via.size() != 0) {
221 : // via takes precedence over stop edges
222 48297 : for (const std::string& via : getParameter().via) {
223 33624 : mandatory.push_back(Mandatory(net->getEdge(via), INVALID_STOP_POS));
224 : }
225 : } else {
226 280782 : for (const auto& stop : getParameter().stops) {
227 712 : const ROEdge* e = net->getEdge(stop.edge);
228 712 : if (e->isInternal()) {
229 : // the edges before and after the internal edge are mandatory
230 8 : const ROEdge* before = e->getNormalBefore();
231 8 : const ROEdge* after = e->getNormalAfter();
232 8 : mandatory.push_back(Mandatory(before, INVALID_STOP_POS));
233 8 : mandatory.push_back(Mandatory(after, INVALID_STOP_POS, stop.jump));
234 : } else {
235 1408 : double endPos = SUMOVehicleParameter::interpretEdgePos(stop.endPos, e->getLength(), SUMO_ATTR_ENDPOS, "stop of vehicle '" + getID() + "' on edge '" + e->getID() + "'");
236 704 : mandatory.push_back(Mandatory(e, endPos, stop.jump));
237 : }
238 : }
239 : }
240 294743 : if (requiredEnd) {
241 : double arrivalPos = INVALID_STOP_POS;
242 289536 : if (getParameter().arrivalPosProcedure == ArrivalPosDefinition::GIVEN) {
243 414 : arrivalPos = SUMOVehicleParameter::interpretEdgePos(getParameter().arrivalPos, requiredEnd->getLength(), SUMO_ATTR_ARRIVALPOS, "vehicle '" + getID() + "'");
244 : }
245 289536 : mandatory.push_back(Mandatory(requiredEnd, arrivalPos));
246 : }
247 294743 : return mandatory;
248 0 : }
249 :
250 :
251 : void
252 390865 : ROVehicle::saveAsXML(OutputDevice& os, OutputDevice* const typeos, bool asAlternatives, OptionsCont& options, int cloneIndex) const {
253 390865 : if (typeos != nullptr && getType() != nullptr && !getType()->saved) {
254 402 : getType()->write(*typeos);
255 402 : getType()->saved = true;
256 : }
257 390865 : if (getType() != nullptr && !getType()->saved) {
258 4100 : getType()->write(os);
259 4100 : getType()->saved = asAlternatives;
260 : }
261 :
262 777464 : const bool writeTrip = options.exists("write-trips") && options.getBool("write-trips");
263 390865 : const bool writeGeoTrip = writeTrip && options.getBool("write-trips.geo");
264 390865 : const bool writeJunctions = writeTrip && options.getBool("write-trips.junctions");
265 390865 : const bool writeNamedRoute = !asAlternatives && options.getBool("named-routes");
266 777464 : const bool writeCosts = options.exists("write-costs") && options.getBool("write-costs");
267 781730 : const bool writeExit = options.exists("exit-times") && options.getBool("exit-times");
268 777464 : const bool writeLength = options.exists("route-length") && options.getBool("route-length");
269 777464 : const bool writeFlow = options.exists("keep-flows") && options.getBool("keep-flows") && isPartOfFlow();
270 :
271 : std::string routeID;
272 390865 : if (writeNamedRoute) {
273 58 : ConstROEdgeVector edges = myRoute->getUsedRoute()->getNormalEdges();
274 : auto it = mySavedRoutes.find(edges);
275 29 : if (it == mySavedRoutes.end()) {
276 22 : routeID = "r" + toString(mySavedRoutes.size());
277 11 : myRoute->getUsedRoute()->writeXMLDefinition(os, this, writeCosts, false, writeExit,
278 : writeLength, routeID);
279 11 : mySavedRoutes[edges] = routeID;
280 : } else {
281 18 : routeID = it->second;
282 : }
283 29 : }
284 390865 : const SumoXMLTag tag = writeFlow ? SUMO_TAG_FLOW : (writeTrip ? SUMO_TAG_TRIP : SUMO_TAG_VEHICLE);
285 : // write the vehicle (new style, with included routes)
286 390865 : if (cloneIndex == 0) {
287 781490 : getParameter().write(os, options, tag);
288 : } else {
289 120 : SUMOVehicleParameter p = getParameter();
290 : // @note id collisions may occur if scale-suffic occurs in other vehicle ids
291 240 : p.id += options.getString("scale-suffix") + toString(cloneIndex);
292 120 : p.write(os, options, tag);
293 120 : }
294 : // save the route
295 390865 : if (writeTrip) {
296 237978 : const ConstROEdgeVector edges = myRoute->getFirstRoute()->getEdgeVector();
297 : const ROEdge* from = nullptr;
298 : const ROEdge* to = nullptr;
299 79326 : if (edges.size() > 0) {
300 79326 : if (edges.front()->isTazConnector()) {
301 7284 : if (edges.size() > 1) {
302 7284 : from = edges[1];
303 7284 : if (from->isTazConnector() && writeJunctions && edges.front()->getSuccessors().size() > 0) {
304 : // routing was skipped
305 8 : from = edges.front()->getSuccessors(getVClass()).front();
306 : }
307 : }
308 : } else {
309 : from = edges[0];
310 : }
311 79326 : if (edges.back()->isTazConnector()) {
312 7284 : if (edges.size() > 1) {
313 7284 : to = edges[edges.size() - 2];
314 7284 : if (to->isTazConnector() && writeJunctions && edges.back()->getPredecessors().size() > 0) {
315 : // routing was skipped
316 4 : to = edges.back()->getPredecessors().front();
317 : }
318 : }
319 : } else {
320 72042 : to = edges[edges.size() - 1];
321 : }
322 : }
323 79326 : if (from != nullptr) {
324 79326 : if (writeGeoTrip) {
325 16 : Position fromPos = from->getLanes()[0]->getShape().positionAtOffset2D(0);
326 16 : if (GeoConvHelper::getFinal().usingGeoProjection()) {
327 0 : os.setPrecision(gPrecisionGeo);
328 0 : GeoConvHelper::getFinal().cartesian2geo(fromPos);
329 0 : os.writeAttr(SUMO_ATTR_FROMLONLAT, fromPos);
330 0 : os.setPrecision(gPrecision);
331 : } else {
332 16 : os.writeAttr(SUMO_ATTR_FROMXY, fromPos);
333 : }
334 79310 : } else if (writeJunctions) {
335 7244 : os.writeAttr(SUMO_ATTR_FROM_JUNCTION, from->getFromJunction()->getID());
336 : } else {
337 72066 : os.writeAttr(SUMO_ATTR_FROM, from->getID());
338 : }
339 : }
340 79326 : if (to != nullptr) {
341 79326 : if (writeGeoTrip) {
342 16 : Position toPos = to->getLanes()[0]->getShape().positionAtOffset2D(to->getLanes()[0]->getShape().length2D());
343 16 : if (GeoConvHelper::getFinal().usingGeoProjection()) {
344 0 : os.setPrecision(gPrecisionGeo);
345 0 : GeoConvHelper::getFinal().cartesian2geo(toPos);
346 0 : os.writeAttr(SUMO_ATTR_TOLONLAT, toPos);
347 0 : os.setPrecision(gPrecision);
348 : } else {
349 16 : os.writeAttr(SUMO_ATTR_TOXY, toPos);
350 : }
351 79310 : } else if (writeJunctions) {
352 7244 : os.writeAttr(SUMO_ATTR_TO_JUNCTION, to->getToJunction()->getID());
353 : } else {
354 72066 : os.writeAttr(SUMO_ATTR_TO, to->getID());
355 : }
356 : }
357 79326 : if (getParameter().via.size() > 0) {
358 : std::vector<std::string> viaOut;
359 : SumoXMLAttr viaAttr = (writeGeoTrip
360 7236 : ? (GeoConvHelper::getFinal().usingGeoProjection() ? SUMO_ATTR_VIALONLAT : SUMO_ATTR_VIAXY)
361 14456 : : (writeJunctions ? SUMO_ATTR_VIAJUNCTIONS : SUMO_ATTR_VIA));
362 21672 : for (const std::string& viaID : getParameter().via) {
363 14436 : const ROEdge* viaEdge = RONet::getInstance()->getEdge(viaID);
364 14436 : if (viaEdge->isTazConnector()) {
365 20 : if (viaEdge->getPredecessors().size() == 0) {
366 0 : continue;
367 : }
368 : // XXX used edge that was used in route
369 20 : viaEdge = viaEdge->getPredecessors().front();
370 : }
371 : assert(viaEdge != nullptr);
372 14436 : if (writeGeoTrip) {
373 8 : Position viaPos = viaEdge->getLanes()[0]->getShape().positionAtOffset2D(viaEdge->getLanes()[0]->getShape().length2D() / 2);
374 8 : if (GeoConvHelper::getFinal().usingGeoProjection()) {
375 0 : GeoConvHelper::getFinal().cartesian2geo(viaPos);
376 0 : viaOut.push_back(toString(viaPos, gPrecisionGeo));
377 : } else {
378 16 : viaOut.push_back(toString(viaPos, gPrecision));
379 : }
380 14428 : } else if (writeJunctions) {
381 8 : viaOut.push_back(viaEdge->getToJunction()->getID());
382 : } else {
383 14420 : viaOut.push_back(viaEdge->getID());
384 : }
385 : }
386 7236 : os.writeAttr(viaAttr, viaOut);
387 7236 : }
388 390865 : } else if (writeNamedRoute) {
389 29 : os.writeAttr(SUMO_ATTR_ROUTE, routeID);
390 : } else {
391 311510 : myRoute->writeXMLDefinition(os, this, asAlternatives, writeExit, writeCosts, writeLength);
392 : }
393 392261 : for (StopParVector::const_iterator stop = getParameter().stops.begin(); stop != getParameter().stops.end(); ++stop) {
394 1396 : stop->write(os);
395 : }
396 390865 : getParameter().writeParams(os);
397 781730 : os.closeTag();
398 390865 : }
399 :
400 :
401 : /****************************************************************************/
|
