Line data Source code
1 : /****************************************************************************/
2 : // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
3 : // Copyright (C) 2002-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 : /****************************************************************************/
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 : // ===========================================================================
42 : // static members
43 : // ===========================================================================
44 : std::map<ConstROEdgeVector, std::string> ROVehicle::mySavedRoutes;
45 :
46 : // ===========================================================================
47 : // method definitions
48 : // ===========================================================================
49 152714 : ROVehicle::ROVehicle(const SUMOVehicleParameter& pars,
50 : RORouteDef* route, const SUMOVTypeParameter* type,
51 152714 : const RONet* net, MsgHandler* errorHandler):
52 : RORoutable(pars, type),
53 152714 : myRoute(route),
54 152714 : myJumpTime(-1) {
55 : getParameter().stops.clear();
56 304802 : if (route != nullptr && route->getFirstRoute() != nullptr) {
57 304500 : for (std::vector<SUMOVehicleParameter::Stop>::const_iterator s = route->getFirstRoute()->getStops().begin(); s != route->getFirstRoute()->getStops().end(); ++s) {
58 324 : addStop(*s, net, errorHandler);
59 : }
60 : }
61 158829 : for (std::vector<SUMOVehicleParameter::Stop>::const_iterator s = pars.stops.begin(); s != pars.stops.end(); ++s) {
62 6115 : addStop(*s, net, errorHandler);
63 : }
64 152714 : if (pars.via.size() != 0) {
65 : // via takes precedence over stop edges
66 : // XXX check for inconsistencies #2275
67 : myStopEdges.clear();
68 26658 : for (std::vector<std::string>::const_iterator it = pars.via.begin(); it != pars.via.end(); ++it) {
69 : assert(net->getEdge(*it) != 0);
70 38396 : myStopEdges.push_back(net->getEdge(*it));
71 : }
72 : }
73 152714 : }
74 :
75 :
76 : void
77 6439 : ROVehicle::addStop(const SUMOVehicleParameter::Stop& stopPar, const RONet* net, MsgHandler* errorHandler) {
78 12878 : const ROEdge* stopEdge = net->getEdge(stopPar.edge);
79 : assert(stopEdge != 0); // was checked when parsing the stop
80 6439 : if (stopEdge->prohibits(this)) {
81 0 : if (errorHandler != nullptr) {
82 0 : errorHandler->inform("Stop edge '" + stopEdge->getID() + "' does not allow vehicle '" + getID() + "'.");
83 : }
84 0 : return;
85 : }
86 : // where to insert the stop
87 : std::vector<SUMOVehicleParameter::Stop>::iterator iter = getParameter().stops.begin();
88 : ConstROEdgeVector::iterator edgeIter = myStopEdges.begin();
89 6439 : if (stopPar.index == STOP_INDEX_END || stopPar.index >= static_cast<int>(getParameter().stops.size())) {
90 6439 : if (getParameter().stops.size() > 0) {
91 : iter = getParameter().stops.end();
92 : edgeIter = myStopEdges.end();
93 : }
94 : } else {
95 0 : if (stopPar.index == STOP_INDEX_FIT) {
96 0 : const ConstROEdgeVector edges = myRoute->getFirstRoute()->getEdgeVector();
97 0 : ConstROEdgeVector::const_iterator stopEdgeIt = std::find(edges.begin(), edges.end(), stopEdge);
98 0 : if (stopEdgeIt == edges.end()) {
99 : iter = getParameter().stops.end();
100 : edgeIter = myStopEdges.end();
101 : } else {
102 0 : while (iter != getParameter().stops.end()) {
103 0 : if (edgeIter > stopEdgeIt || (edgeIter == stopEdgeIt && iter->endPos >= stopPar.endPos)) {
104 : break;
105 : }
106 : ++iter;
107 : ++edgeIter;
108 : }
109 : }
110 0 : } else {
111 : iter += stopPar.index;
112 : edgeIter += stopPar.index;
113 : }
114 : }
115 6439 : getParameter().stops.insert(iter, stopPar);
116 6439 : myStopEdges.insert(edgeIter, stopEdge);
117 6439 : if (stopPar.jump >= 0) {
118 24 : if (stopEdge->isInternal()) {
119 0 : if (errorHandler != nullptr) {
120 0 : errorHandler->inform("Jumps are not supported from internal stop edge '" + stopEdge->getID() + "'.");
121 : }
122 : } else {
123 24 : if (myJumpTime < 0) {
124 20 : myJumpTime = 0;
125 : }
126 24 : myJumpTime += stopPar.jump;
127 : }
128 : }
129 : }
130 :
131 :
132 305353 : ROVehicle::~ROVehicle() {}
133 :
134 :
135 : const ROEdge*
136 360 : ROVehicle:: getDepartEdge() const {
137 360 : return myRoute->getFirstRoute()->getFirst();
138 : }
139 :
140 :
141 : void
142 151872 : ROVehicle::computeRoute(const RORouterProvider& provider,
143 : const bool removeLoops, MsgHandler* errorHandler) {
144 : SUMOAbstractRouter<ROEdge, ROVehicle>& router = provider.getVehicleRouter(getVClass());
145 303744 : std::string noRouteMsg = "The vehicle '" + getID() + "' has no valid route.";
146 : RORouteDef* const routeDef = getRouteDefinition();
147 : // check if the route definition is valid
148 151872 : if (routeDef == nullptr) {
149 0 : errorHandler->inform(noRouteMsg);
150 0 : myRoutingSuccess = false;
151 0 : return;
152 : }
153 151872 : RORoute* current = routeDef->buildCurrentRoute(router, getDepartureTime(), *this);
154 151872 : if (current == nullptr || current->size() == 0) {
155 1964 : delete current;
156 1300 : if (current == nullptr || !routeDef->discardSilent()) {
157 1992 : errorHandler->inform(noRouteMsg);
158 : }
159 1964 : myRoutingSuccess = false;
160 1964 : return;
161 : }
162 : // check whether we have to evaluate the route for not containing loops
163 149908 : if (removeLoops) {
164 4588 : const ROEdge* requiredStart = (getParameter().departPosProcedure == DepartPosDefinition::GIVEN
165 4588 : || getParameter().departLaneProcedure == DepartLaneDefinition::GIVEN ? current->getEdgeVector().front() : 0);
166 4588 : const ROEdge* requiredEnd = (getParameter().arrivalPosProcedure == ArrivalPosDefinition::GIVEN
167 4588 : || getParameter().arrivalLaneProcedure == ArrivalLaneDefinition::GIVEN ? current->getEdgeVector().back() : 0);
168 4588 : current->recheckForLoops(getMandatoryEdges(requiredStart, requiredEnd));
169 : // check whether the route is still valid
170 4588 : if (current->size() == 0) {
171 0 : delete current;
172 16 : errorHandler->inform(noRouteMsg + " (after removing loops)");
173 0 : myRoutingSuccess = false;
174 0 : return;
175 : }
176 : }
177 : // add built route
178 149908 : routeDef->addAlternative(router, this, current, getDepartureTime());
179 149892 : myRoutingSuccess = true;
180 : }
181 :
182 :
183 : ConstROEdgeVector
184 150041 : ROVehicle::getMandatoryEdges(const ROEdge* requiredStart, const ROEdge* requiredEnd) const {
185 : ConstROEdgeVector mandatory;
186 150041 : if (requiredStart) {
187 145461 : mandatory.push_back(requiredStart);
188 : }
189 175518 : for (const ROEdge* e : getStopEdges()) {
190 25477 : if (e->isInternal()) {
191 : // the edges before and after the internal edge are mandatory
192 8 : const ROEdge* before = e->getNormalBefore();
193 8 : const ROEdge* after = e->getNormalAfter();
194 8 : if (mandatory.size() == 0 || after != mandatory.back()) {
195 8 : mandatory.push_back(before);
196 8 : mandatory.push_back(after);
197 : }
198 : } else {
199 25469 : if (mandatory.size() == 0 || e != mandatory.back()) {
200 20701 : mandatory.push_back(e);
201 : }
202 : }
203 : }
204 150041 : if (requiredEnd) {
205 145461 : if (mandatory.size() < 2 || mandatory.back() != requiredEnd) {
206 142771 : mandatory.push_back(requiredEnd);
207 : }
208 : }
209 150041 : return mandatory;
210 0 : }
211 :
212 :
213 : void
214 145453 : ROVehicle::collectJumps(const ConstROEdgeVector& mandatory, std::set<ConstROEdgeVector::const_iterator>& jumpStarts) const {
215 145453 : auto itM = mandatory.begin();
216 : auto itS = getParameter().stops.begin();
217 : auto itSEnd = getParameter().stops.end();
218 153485 : while (itM != mandatory.end() && itS != itSEnd) {
219 : bool repeatMandatory = false;
220 : // if we stop twice on the same edge, we must treat this as a repeated
221 : // mandatory edge (even though the edge appears only once in the mandatory vector)
222 8032 : if ((*itM)->getID() == itS->edge) {
223 6259 : if (itS->jump >= 0) {
224 : jumpStarts.insert(itM);
225 : }
226 : itS++;
227 6259 : if (itS != itSEnd && itS->edge == (itS - 1)->edge) {
228 : repeatMandatory = true;
229 : }
230 : }
231 : if (!repeatMandatory) {
232 : itM++;
233 : }
234 : }
235 145453 : }
236 :
237 :
238 : void
239 266279 : ROVehicle::saveAsXML(OutputDevice& os, OutputDevice* const typeos, bool asAlternatives, OptionsCont& options, int cloneIndex) const {
240 266279 : if (typeos != nullptr && getType() != nullptr && !getType()->saved) {
241 224 : getType()->write(*typeos);
242 224 : getType()->saved = true;
243 : }
244 266279 : if (getType() != nullptr && !getType()->saved) {
245 11198 : getType()->write(os);
246 11198 : getType()->saved = asAlternatives;
247 : }
248 :
249 528417 : const bool writeTrip = options.exists("write-trips") && options.getBool("write-trips");
250 266279 : const bool writeGeoTrip = writeTrip && options.getBool("write-trips.geo");
251 266279 : const bool writeJunctions = writeTrip && options.getBool("write-trips.junctions");
252 266279 : const bool writeNamedRoute = !asAlternatives && options.getBool("named-routes");
253 528417 : const bool writeCosts = options.exists("write-costs") && options.getBool("write-costs");
254 532558 : const bool writeExit = options.exists("exit-times") && options.getBool("exit-times");
255 528417 : const bool writeLength = options.exists("route-length") && options.getBool("route-length");
256 :
257 : std::string routeID;
258 266279 : if (writeNamedRoute) {
259 21 : ConstROEdgeVector edges = myRoute->getUsedRoute()->getNormalEdges();
260 : auto it = mySavedRoutes.find(edges);
261 21 : if (it == mySavedRoutes.end()) {
262 14 : routeID = "r" + toString(mySavedRoutes.size());
263 7 : myRoute->getUsedRoute()->writeXMLDefinition(os, this, writeCosts, false, writeExit,
264 : writeLength, routeID);
265 7 : mySavedRoutes[edges] = routeID;
266 : } else {
267 14 : routeID = it->second;
268 : }
269 21 : }
270 : // write the vehicle (new style, with included routes)
271 266279 : if (cloneIndex == 0) {
272 787226 : getParameter().write(os, options, writeTrip ? SUMO_TAG_TRIP : SUMO_TAG_VEHICLE);
273 : } else {
274 120 : SUMOVehicleParameter p = getParameter();
275 : // @note id collisions may occur if scale-suffic occurs in other vehicle ids
276 240 : p.id += options.getString("scale-suffix") + toString(cloneIndex);
277 240 : p.write(os, options, writeTrip ? SUMO_TAG_TRIP : SUMO_TAG_VEHICLE);
278 120 : }
279 : // save the route
280 266279 : if (writeTrip) {
281 22502 : const ConstROEdgeVector edges = myRoute->getFirstRoute()->getEdgeVector();
282 : const ROEdge* from = nullptr;
283 : const ROEdge* to = nullptr;
284 11251 : if (edges.size() > 0) {
285 11251 : if (edges.front()->isTazConnector()) {
286 3674 : if (edges.size() > 1) {
287 3674 : from = edges[1];
288 3674 : if (from->isTazConnector() && writeJunctions && edges.front()->getSuccessors().size() > 0) {
289 : // routing was skipped
290 8 : from = edges.front()->getSuccessors(getVClass()).front();
291 : }
292 : }
293 : } else {
294 : from = edges[0];
295 : }
296 11251 : if (edges.back()->isTazConnector()) {
297 3674 : if (edges.size() > 1) {
298 3674 : to = edges[edges.size() - 2];
299 3674 : if (to->isTazConnector() && writeJunctions && edges.back()->getPredecessors().size() > 0) {
300 : // routing was skipped
301 4 : to = edges.back()->getPredecessors().front();
302 : }
303 : }
304 : } else {
305 7577 : to = edges[edges.size() - 1];
306 : }
307 : }
308 11251 : if (from != nullptr) {
309 11251 : if (writeGeoTrip) {
310 16 : Position fromPos = from->getLanes()[0]->getShape().positionAtOffset2D(0);
311 16 : if (GeoConvHelper::getFinal().usingGeoProjection()) {
312 0 : os.setPrecision(gPrecisionGeo);
313 0 : GeoConvHelper::getFinal().cartesian2geo(fromPos);
314 : os.writeAttr(SUMO_ATTR_FROMLONLAT, fromPos);
315 0 : os.setPrecision(gPrecision);
316 : } else {
317 : os.writeAttr(SUMO_ATTR_FROMXY, fromPos);
318 : }
319 11235 : } else if (writeJunctions) {
320 : os.writeAttr(SUMO_ATTR_FROM_JUNCTION, from->getFromJunction()->getID());
321 : } else {
322 : os.writeAttr(SUMO_ATTR_FROM, from->getID());
323 : }
324 : }
325 11251 : if (to != nullptr) {
326 11251 : if (writeGeoTrip) {
327 16 : Position toPos = to->getLanes()[0]->getShape().positionAtOffset2D(to->getLanes()[0]->getShape().length2D());
328 16 : if (GeoConvHelper::getFinal().usingGeoProjection()) {
329 0 : os.setPrecision(gPrecisionGeo);
330 0 : GeoConvHelper::getFinal().cartesian2geo(toPos);
331 : os.writeAttr(SUMO_ATTR_TOLONLAT, toPos);
332 0 : os.setPrecision(gPrecision);
333 : } else {
334 : os.writeAttr(SUMO_ATTR_TOXY, toPos);
335 : }
336 11235 : } else if (writeJunctions) {
337 : os.writeAttr(SUMO_ATTR_TO_JUNCTION, to->getToJunction()->getID());
338 : } else {
339 : os.writeAttr(SUMO_ATTR_TO, to->getID());
340 : }
341 : }
342 11251 : if (getParameter().via.size() > 0) {
343 : std::vector<std::string> viaOut;
344 : SumoXMLAttr viaAttr = (writeGeoTrip
345 3636 : ? (GeoConvHelper::getFinal().usingGeoProjection() ? SUMO_ATTR_VIALONLAT : SUMO_ATTR_VIAXY)
346 3628 : : (writeJunctions ? SUMO_ATTR_VIAJUNCTIONS : SUMO_ATTR_VIA));
347 10872 : for (const std::string& viaID : getParameter().via) {
348 7236 : const ROEdge* viaEdge = RONet::getInstance()->getEdge(viaID);
349 7236 : if (viaEdge->isTazConnector()) {
350 20 : if (viaEdge->getPredecessors().size() == 0) {
351 0 : continue;
352 : }
353 : // XXX used edge that was used in route
354 20 : viaEdge = viaEdge->getPredecessors().front();
355 : }
356 : assert(viaEdge != nullptr);
357 7236 : if (writeGeoTrip) {
358 8 : Position viaPos = viaEdge->getLanes()[0]->getShape().positionAtOffset2D(viaEdge->getLanes()[0]->getShape().length2D() / 2);
359 8 : if (GeoConvHelper::getFinal().usingGeoProjection()) {
360 0 : GeoConvHelper::getFinal().cartesian2geo(viaPos);
361 0 : viaOut.push_back(toString(viaPos, gPrecisionGeo));
362 : } else {
363 16 : viaOut.push_back(toString(viaPos, gPrecision));
364 : }
365 7228 : } else if (writeJunctions) {
366 8 : viaOut.push_back(viaEdge->getToJunction()->getID());
367 : } else {
368 7220 : viaOut.push_back(viaEdge->getID());
369 : }
370 : }
371 : os.writeAttr(viaAttr, viaOut);
372 3636 : }
373 266279 : } else if (writeNamedRoute) {
374 : os.writeAttr(SUMO_ATTR_ROUTE, routeID);
375 : } else {
376 255007 : myRoute->writeXMLDefinition(os, this, asAlternatives, writeExit, writeCosts, writeLength);
377 : }
378 278853 : for (std::vector<SUMOVehicleParameter::Stop>::const_iterator stop = getParameter().stops.begin(); stop != getParameter().stops.end(); ++stop) {
379 12574 : stop->write(os);
380 : }
381 266279 : getParameter().writeParams(os);
382 532558 : os.closeTag();
383 266279 : }
384 :
385 :
386 : /****************************************************************************/
|
