Eclipse SUMO - Simulation of Urban MObility
MEVehicle.h
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2001-2022 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 /****************************************************************************/
18 // A vehicle from the mesoscopic point of view
19 /****************************************************************************/
20 #pragma once
21 #include <config.h>
22 
23 #include <iostream>
24 #include <cassert>
25 #include <map>
26 #include <vector>
27 #include <microsim/MSBaseVehicle.h>
28 #include <microsim/MSEdge.h>
29 #include <utils/common/StdDefs.h>
30 #include "MESegment.h"
31 
32 class MSLane;
33 class MSLink;
34 
35 // ===========================================================================
36 // class definitions
37 // ===========================================================================
42 class MEVehicle : public MSBaseVehicle {
43 public:
51  MEVehicle(SUMOVehicleParameter* pars, const MSRoute* route,
52  MSVehicleType* type, const double speedFactor);
53 
54 
58  double getPositionOnLane() const;
59 
60 
64  double getBackPositionOnLane(const MSLane* lane) const;
65 
66 
70  double getAngle() const;
71 
72 
76  double getSlope() const;
77 
81  const MSLane* getLane() const {
82  return nullptr;
83  }
84 
92  Position getPosition(const double offset = 0) const;
93 
94 
99  double getSpeed() const;
100 
105  double getAverageSpeed() const;
106 
108  double estimateLeaveSpeed(const MSLink* link) const;
109 
110 
116  double getConservativeSpeed(SUMOTime& earliestArrival) const;
117 
119 
120 
130 
131 
135  bool moveRoutePointer();
136 
140  bool hasArrived() const;
141 
145  bool isOnRoad() const;
146 
150  virtual bool isIdling() const;
151 
152 
157  void setApproaching(MSLink* link);
158 
161  return 0;
162  }
163 
165  void processStop();
166 
168  bool stopsAt(MSStoppingPlace* /*stop*/) const {
169  return false;
170  }
171 
172  bool stopsAtEdge(const MSEdge* /*edge*/) const {
173  return false;
174  }
175 
181 
186  bool resumeFromStopping();
187 
189  double getBrakeGap(bool delayed = false) const {
190  UNUSED_PARAMETER(delayed);
191  return 0;
192  }
193 
196  bool replaceParkingArea(MSParkingArea* /* parkingArea = 0 */, std::string& /*errorMsg*/) {
197  throw ProcessError("parkingZoneReroute not implemented for meso");
198  }
199 
203  throw ProcessError("parkingZoneReroute not implemented for meso");
204  }
205 
209  inline void setEventTime(SUMOTime t, bool hasDelay = true) {
210  assert(t > myLastEntryTime);
211  if (hasDelay && mySegment != 0) {
213  }
214  myEventTime = t;
215  }
216 
217 
221  inline SUMOTime getEventTime() const {
222  return myEventTime;
223  }
224 
225 
230  inline virtual void setSegment(MESegment* s, int idx = 0) {
231  mySegment = s;
232  myQueIndex = idx;
233  }
234 
235 
239  inline MESegment* getSegment() const {
240  return mySegment;
241  }
242 
243 
247  inline int getQueIndex() const {
248  return myQueIndex;
249  }
250 
251 
255  inline void setLastEntryTime(SUMOTime t) {
256  myLastEntryTime = t;
257  }
258 
259 
264  return myLastEntryTime;
265  }
266 
267 
271  inline void setBlockTime(const SUMOTime t) {
272  assert(t > myLastEntryTime);
273  myBlockTime = t;
274  }
275 
276 
280  inline SUMOTime getBlockTime() const {
281  return myBlockTime;
282  }
283 
284 
286  inline SUMOTime getWaitingTime() const {
287  return MAX2(SUMOTime(0), myEventTime - myBlockTime);
288  }
289 
290  inline SUMOTime getTimeLoss() const {
291  // slow-downs while driving are not modelled
292  return getWaitingTime();
293  }
294 
297  return getWaitingTime();
298  }
299 
300 
302  double getEventTimeSeconds() const {
303  return STEPS2TIME(getEventTime());
304  }
305 
307  double getLastEntryTimeSeconds() const {
308  return STEPS2TIME(getLastEntryTime());
309  }
310 
312  double getBlockTimeSeconds() const {
313  return STEPS2TIME(getBlockTime());
314  }
315 
317  double getCurrentLinkPenaltySeconds() const;
318 
320  double getCurrentStoppingTimeSeconds() const;
321 
323  bool replaceRoute(const MSRoute* route, const std::string& info, bool onInit = false, int offset = 0, bool addRouteStops = true, bool removeStops = true, std::string* msgReturn = nullptr);
324 
328  bool mayProceed();
329 
332  void updateDetectorForWriting(MSMoveReminder* rem, SUMOTime currentTime, SUMOTime exitTime);
333 
336  void updateDetectors(SUMOTime currentTime, const bool isLeave,
338 
344  BaseInfluencer& getBaseInfluencer();
345 
346  const BaseInfluencer* getBaseInfluencer() const;
347 
348  bool hasInfluencer() const {
349  return myInfluencer != nullptr;
350  }
351 
353 
354 
356  void saveState(OutputDevice& out);
357 
360  void loadState(const SUMOSAXAttributes& attrs, const SUMOTime offset);
362 
363 
364 protected:
367 
370 
373 
376 
379 
382 
383 };
#define STEPS2TIME(x)
Definition: SUMOTime.h:53
long long int SUMOTime
Definition: SUMOTime.h:32
#define UNUSED_PARAMETER(x)
Definition: StdDefs.h:30
T MAX2(T a, T b)
Definition: StdDefs.h:80
A single mesoscopic segment (cell)
Definition: MESegment.h:49
const MSEdge & getEdge() const
Returns the edge this segment belongs to.
Definition: MESegment.h:352
A vehicle from the mesoscopic point of view.
Definition: MEVehicle.h:42
double getConservativeSpeed(SUMOTime &earliestArrival) const
Returns the vehicle's estimated speed taking into account delays.
Definition: MEVehicle.cpp:133
double getLastEntryTimeSeconds() const
Returns the entry time for the current segment.
Definition: MEVehicle.h:307
double getBlockTimeSeconds() const
Returns the time at which the vehicle was blocked on the current segment.
Definition: MEVehicle.h:312
Position getPosition(const double offset=0) const
Return current position (x/y, cartesian)
Definition: MEVehicle.cpp:101
bool hasInfluencer() const
whether the vehicle is individually influenced (via TraCI or special parameters)
Definition: MEVehicle.h:348
double getAverageSpeed() const
Returns the vehicle's estimated average speed on the segment assuming no further delays.
Definition: MEVehicle.cpp:118
double getAngle() const
Returns the vehicle's direction in degrees.
Definition: MEVehicle.cpp:87
double getBackPositionOnLane(const MSLane *lane) const
Get the vehicle's position relative to the given lane.
Definition: MEVehicle.cpp:73
SUMOTime myEventTime
The (planned) time of leaving the segment (cell)
Definition: MEVehicle.h:372
void onRemovalFromNet(const MSMoveReminder::Notification reason)
Called when the vehicle is removed from the network.
Definition: MEVehicle.cpp:478
void updateDetectorForWriting(MSMoveReminder *rem, SUMOTime currentTime, SUMOTime exitTime)
Updates a single vehicle detector if present.
Definition: MEVehicle.cpp:408
BaseInfluencer & getBaseInfluencer()
Returns the velocity/lane influencer.
Definition: MEVehicle.cpp:463
double getCurrentStoppingTimeSeconds() const
Returns the delay that is accrued due to option –meso-tls-penalty or –meso-minor-penalty.
Definition: MEVehicle.cpp:307
double getBrakeGap(bool delayed=false) const
get distance for coming to a stop (used for rerouting checks)
Definition: MEVehicle.h:189
SUMOTime getAccumulatedWaitingTime() const
Returns the duration for which the vehicle was blocked.
Definition: MEVehicle.h:296
bool mayProceed()
Returns whether the vehicle is allowed to pass the next junction, checks also for triggered stops.
Definition: MEVehicle.cpp:355
double estimateLeaveSpeed(const MSLink *link) const
Returns the vehicle's estimated speed after driving accross the link.
Definition: MEVehicle.cpp:124
void processStop()
ends the current stop and performs loading/unloading
Definition: MEVehicle.cpp:326
bool hasArrived() const
Returns whether this vehicle has already arived (reached the arrivalPosition on its final edge)
Definition: MEVehicle.cpp:158
MEVehicle(SUMOVehicleParameter *pars, const MSRoute *route, MSVehicleType *type, const double speedFactor)
Constructor.
Definition: MEVehicle.cpp:51
bool moveRoutePointer()
Update when the vehicle enters a new edge in the move step.
Definition: MEVehicle.cpp:140
int myQueIndex
Index of the que the vehicle is in (important for multiqueue extension)
Definition: MEVehicle.h:369
bool stopsAtEdge(const MSEdge *) const
Returns whether the vehicle stops at the given edge.
Definition: MEVehicle.h:172
SUMOTime checkStop(SUMOTime time)
Returns until when to stop at the current segment and sets the information that the stop has been rea...
Definition: MEVehicle.cpp:214
void updateDetectors(SUMOTime currentTime, const bool isLeave, const MSMoveReminder::Notification reason=MSMoveReminder::NOTIFICATION_JUNCTION)
Updates all vehicle detectors.
Definition: MEVehicle.cpp:426
virtual bool isIdling() const
Returns whether the vehicle is trying to re-enter the net.
Definition: MEVehicle.cpp:174
SUMOTime getLastEntryTime() const
Returns the time the vehicle entered the current segment.
Definition: MEVehicle.h:263
double getPositionOnLane() const
Get the vehicle's position along the lane.
Definition: MEVehicle.cpp:79
SUMOTime myLastEntryTime
The time the vehicle entered its current segment.
Definition: MEVehicle.h:375
void setEventTime(SUMOTime t, bool hasDelay=true)
Sets the (planned) time at which the vehicle leaves his current cell.
Definition: MEVehicle.h:209
BaseInfluencer * myInfluencer
An instance of a velocity/lane influencing instance; built in "getInfluencer".
Definition: MEVehicle.h:381
void setApproaching(MSLink *link)
registers vehicle with the given link
Definition: MEVehicle.cpp:180
MESegment * getSegment() const
Returns the current segment the vehicle is on.
Definition: MEVehicle.h:239
void saveState(OutputDevice &out)
Saves the states of a vehicle.
Definition: MEVehicle.cpp:484
SUMOTime getTimeLoss() const
Definition: MEVehicle.h:290
void setLastEntryTime(SUMOTime t)
Sets the entry time for the current segment.
Definition: MEVehicle.h:255
MESegment * mySegment
The segment the vehicle is at.
Definition: MEVehicle.h:366
int getQueIndex() const
Returns the index of the que the vehicle is in.
Definition: MEVehicle.h:247
SUMOTime getWaitingTime() const
Returns the duration for which the vehicle was blocked.
Definition: MEVehicle.h:286
bool replaceRoute(const MSRoute *route, const std::string &info, bool onInit=false, int offset=0, bool addRouteStops=true, bool removeStops=true, std::string *msgReturn=nullptr)
Replaces the current route by the given one.
Definition: MEVehicle.cpp:194
void loadState(const SUMOSAXAttributes &attrs, const SUMOTime offset)
Loads the state of this vehicle from the given description.
Definition: MEVehicle.cpp:522
virtual void setSegment(MESegment *s, int idx=0)
Sets the current segment the vehicle is at together with its que.
Definition: MEVehicle.h:230
SUMOTime remainingStopDuration() const
Returns the remaining stop duration for a stopped vehicle or 0.
Definition: MEVehicle.h:160
double getCurrentLinkPenaltySeconds() const
Returns the delay that is accrued due to option –meso-tls-penalty or –meso-minor-penalty.
Definition: MEVehicle.cpp:398
const MSLane * getLane() const
Returns the lane the vehicle is on.
Definition: MEVehicle.h:81
SUMOTime getEventTime() const
Returns the (planned) time at which the vehicle leaves his current cell.
Definition: MEVehicle.h:221
bool stopsAt(MSStoppingPlace *) const
Returns whether the vehicle stops at the given stopping place.
Definition: MEVehicle.h:168
MSParkingArea * getNextParkingArea()
get the current parking area stop
Definition: MEVehicle.h:202
void setBlockTime(const SUMOTime t)
Sets the time at which the vehicle was blocked.
Definition: MEVehicle.h:271
bool isOnRoad() const
Returns the information whether the vehicle is on a road (is simulated)
Definition: MEVehicle.cpp:168
bool resumeFromStopping()
Definition: MEVehicle.cpp:276
double getSpeed() const
Returns the vehicle's estimated speed assuming no delays.
Definition: MEVehicle.cpp:108
double getSlope() const
Returns the slope of the road at vehicle's position in degrees.
Definition: MEVehicle.cpp:94
double getEventTimeSeconds() const
Returns the earliest leave time for the current segment.
Definition: MEVehicle.h:302
SUMOTime myBlockTime
The time at which the vehicle was blocked on its current segment.
Definition: MEVehicle.h:378
bool replaceParkingArea(MSParkingArea *, std::string &)
replace the current parking area stop with a new stop with merge duration
Definition: MEVehicle.h:196
SUMOTime getBlockTime() const
Returns the time at which the vehicle was blocked.
Definition: MEVehicle.h:280
The base class for microscopic and mesoscopic vehicles.
Definition: MSBaseVehicle.h:51
A road/street connecting two junctions.
Definition: MSEdge.h:77
void markDelayed() const
Definition: MSEdge.h:693
Representation of a lane in the micro simulation.
Definition: MSLane.h:82
Something on a lane to be noticed about vehicle movement.
Notification
Definition of a vehicle state.
@ NOTIFICATION_JUNCTION
The vehicle arrived at a junction.
A lane area vehicles can halt at.
Definition: MSParkingArea.h:58
A lane area vehicles can halt at.
The car-following model and parameter.
Definition: MSVehicleType.h:62
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:61
A point in 2D or 3D with translation and scaling methods.
Definition: Position.h:37
Encapsulated SAX-Attributes.
Structure representing possible vehicle parameter.