Eclipse SUMO - Simulation of Urban MObility
MSCFModel_IDM.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-2019 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials
5 // are made available under the terms of the Eclipse Public License v2.0
6 // which accompanies this distribution, and is available at
7 // http://www.eclipse.org/legal/epl-v20.html
8 // SPDX-License-Identifier: EPL-2.0
9 /****************************************************************************/
16 // The Intelligent Driver Model (IDM) car-following model
17 /****************************************************************************/
18 #ifndef MSCFMODEL_IDM_H
19 #define MSCFMODEL_IDM_H
20 
21 // ===========================================================================
22 // included modules
23 // ===========================================================================
24 #include <config.h>
25 
26 #include "MSCFModel.h"
27 #include <microsim/MSLane.h>
28 #include <microsim/MSVehicle.h>
29 #include <microsim/MSVehicleType.h>
31 
32 
33 // ===========================================================================
34 // class definitions
35 // ===========================================================================
40 class MSCFModel_IDM : public MSCFModel {
41 public:
46  MSCFModel_IDM(const MSVehicleType* vtype, bool idmm);
47 
48 
59  MSCFModel_IDM(const MSVehicleType* vtype, double accel, double decel, double emergencyDecel, double apparentDecel,
60  double headwayTime, double adaptationFactor, double adaptationTime,
61  double internalStepping);
62 
63 
66 
67 
70 
76  double finalizeSpeed(MSVehicle* const veh, double vPos) const;
77 
90  virtual double freeSpeed(const MSVehicle* const veh, double speed, double seen,
91  double maxSpeed, const bool onInsertion = false) const;
92 
101  double followSpeed(const MSVehicle* const veh, double speed, double gap2pred, double predSpeed, double predMaxDecel, const MSVehicle* const pred = 0) const;
102 
103 
111  double stopSpeed(const MSVehicle* const veh, const double speed, double gap) const;
112 
113 
123  double interactionGap(const MSVehicle* const, double vL) const;
124 
125 
138  double insertionFollowSpeed(const MSVehicle* const veh, double speed, double gap2pred, double predSpeed, double predMaxDecel, const MSVehicle* const pred = 0) const;
139 
140 
148  double getSecureGap(const MSVehicle* const veh, const MSVehicle* const pred, const double speed, const double leaderSpeed, const double leaderMaxDecel) const;
149 
154  int getModelID() const {
156  }
158 
159 
160 
165  MSCFModel* duplicate(const MSVehicleType* vtype) const;
166 
167 
169  if (myAdaptationFactor != 1.) {
170  return new VehicleVariables();
171  }
172  return 0;
173  }
174 
175 
176 private:
178  public:
182  };
183 
184 
185 private:
186  double _v(const MSVehicle* const veh, const double gap2pred, const double mySpeed,
187  const double predSpeed, const double desSpeed, const bool respectMinGap = true) const;
188 
189 
190 private:
192  const bool myIDMM;
193 
195  const double myDelta;
196 
198  const double myAdaptationFactor;
199 
201  const double myAdaptationTime;
202 
204  const int myIterations;
205 
207  const double myTwoSqrtAccelDecel;
208 
209 private:
212 };
213 
214 #endif /* MSCFMODEL_IDM_H */
MSCFModel_IDM::MSCFModel_IDM
MSCFModel_IDM(const MSVehicleType *vtype, bool idmm)
Constructor.
Definition: MSCFModel_IDM.cpp:33
MSVehicleType
The car-following model and parameter.
Definition: MSVehicleType.h:65
MSCFModel_IDM::myTwoSqrtAccelDecel
const double myTwoSqrtAccelDecel
A computational shortcut.
Definition: MSCFModel_IDM.h:207
SUMO_TAG_CF_IDMM
@ SUMO_TAG_CF_IDMM
Definition: SUMOXMLDefinitions.h:282
MSCFModel_IDM::createVehicleVariables
VehicleVariables * createVehicleVariables() const
Returns model specific values which are stored inside a vehicle and must be used with casting.
Definition: MSCFModel_IDM.h:168
MSCFModel_IDM::getSecureGap
double getSecureGap(const MSVehicle *const veh, const MSVehicle *const pred, const double speed, const double leaderSpeed, const double leaderMaxDecel) const
Returns the minimum gap to reserve if the leader is braking at maximum (>=0)
Definition: MSCFModel_IDM.cpp:142
MSCFModel_IDM::myAdaptationTime
const double myAdaptationTime
The IDMM adaptation time tau.
Definition: MSCFModel_IDM.h:201
MSCFModel_IDM::myIterations
const int myIterations
The number of iterations in speed calculations.
Definition: MSCFModel_IDM.h:204
MSCFModel_IDM::MSCFModel_IDM
MSCFModel_IDM(const MSVehicleType *vtype, double accel, double decel, double emergencyDecel, double apparentDecel, double headwayTime, double adaptationFactor, double adaptationTime, double internalStepping)
Constructor.
SUMO_TAG_CF_IDM
@ SUMO_TAG_CF_IDM
Definition: SUMOXMLDefinitions.h:281
MSVehicle.h
MSVehicleType.h
MSCFModel_IDM::duplicate
MSCFModel * duplicate(const MSVehicleType *vtype) const
Duplicates the car-following model.
Definition: MSCFModel_IDM.cpp:192
MSCFModel_IDM::getModelID
int getModelID() const
Returns the model's name.
Definition: MSCFModel_IDM.h:154
MSCFModel_IDM::VehicleVariables::VehicleVariables
VehicleVariables()
Definition: MSCFModel_IDM.h:179
MSCFModel_IDM::finalizeSpeed
double finalizeSpeed(MSVehicle *const veh, double vPos) const
Applies interaction with stops and lane changing model influences.
Definition: MSCFModel_IDM.cpp:49
MSCFModel_IDM::~MSCFModel_IDM
~MSCFModel_IDM()
Destructor.
Definition: MSCFModel_IDM.cpp:45
MSCFModel_IDM::myDelta
const double myDelta
The IDM delta exponent.
Definition: MSCFModel_IDM.h:195
MSCFModel_IDM::myAdaptationFactor
const double myAdaptationFactor
The IDMM adaptation factor beta.
Definition: MSCFModel_IDM.h:198
MSCFModel_IDM::insertionFollowSpeed
double insertionFollowSpeed(const MSVehicle *const veh, double speed, double gap2pred, double predSpeed, double predMaxDecel, const MSVehicle *const pred=0) const
Computes the vehicle's safe speed (no dawdling) This method is used during the insertion stage....
Definition: MSCFModel_IDM.cpp:96
MSCFModel_IDM::followSpeed
double followSpeed(const MSVehicle *const veh, double speed, double gap2pred, double predSpeed, double predMaxDecel, const MSVehicle *const pred=0) const
Computes the vehicle's safe speed (no dawdling)
Definition: MSCFModel_IDM.cpp:86
MSCFModel_IDM::stopSpeed
double stopSpeed(const MSVehicle *const veh, const double speed, double gap) const
Computes the vehicle's safe speed for approaching a non-moving obstacle (no dawdling)
Definition: MSCFModel_IDM.cpp:109
MSCFModel_IDM
The Intelligent Driver Model (IDM) car-following model.
Definition: MSCFModel_IDM.h:40
MSCFModel::VehicleVariables
Definition: MSCFModel.h:60
MSCFModel.h
MSCFModel_IDM::_v
double _v(const MSVehicle *const veh, const double gap2pred, const double mySpeed, const double predSpeed, const double desSpeed, const bool respectMinGap=true) const
Definition: MSCFModel_IDM.cpp:149
MSCFModel_IDM::freeSpeed
virtual double freeSpeed(const MSVehicle *const veh, double speed, double seen, double maxSpeed, const bool onInsertion=false) const
Computes the vehicle's safe speed without a leader.
Definition: MSCFModel_IDM.cpp:60
MSCFModel_IDM::myIDMM
const bool myIDMM
whether the model is IDMM or IDM
Definition: MSCFModel_IDM.h:192
MSCFModel
The car-following model abstraction.
Definition: MSCFModel.h:56
config.h
MSCFModel_IDM::operator=
MSCFModel_IDM & operator=(const MSCFModel_IDM &s)
Invalidated assignment operator.
MSLane.h
MSCFModel_IDM::VehicleVariables
Definition: MSCFModel_IDM.h:177
MSCFModel_IDM::interactionGap
double interactionGap(const MSVehicle *const, double vL) const
Returns the maximum gap at which an interaction between both vehicles occurs.
Definition: MSCFModel_IDM.cpp:129
SUMOXMLDefinitions.h
MSCFModel_IDM::VehicleVariables::levelOfService
double levelOfService
state variable for remembering speed deviation history (lambda)
Definition: MSCFModel_IDM.h:181
MSVehicle
Representation of a vehicle in the micro simulation.
Definition: MSVehicle.h:79