SUMO - Simulation of Urban MObility
MSCFModel_Rail Class Reference

#include <MSCFModel_Rail.h>

Inheritance diagram for MSCFModel_Rail:
Inheritance graph
Collaboration diagram for MSCFModel_Rail:
Collaboration graph

Data Structures

struct  TrainParams
 

Public Member Functions

MSCFModel::VehicleVariablescreateVehicleVariables () const
 Returns model specific values which are stored inside a vehicle and must be used with casting. More...
 
virtual MSCFModelduplicate (const MSVehicleType *vtype) const
 Duplicates the car-following model. More...
 
double estimateSpeedAfterDistance (const double dist, const double v, const double accel) const
 
double followSpeed (const MSVehicle *const veh, double speed, double gap2pred, double predSpeed, double predMaxDecel) const
 Computes the vehicle's follow speed (no dawdling) More...
 
double freeSpeed (const MSVehicle *const veh, double speed, double seen, double maxSpeed, const bool onInsertion) const
 Computes the vehicle's safe speed without a leader. More...
 
double getApparentDecel () const
 Get the vehicle type's apparent deceleration [m/s^2] (the one regarded by its followers. More...
 
double getEmergencyDecel () const
 Get the vehicle type's maximal phisically possible deceleration [m/s^2]. More...
 
double getMaxAccel () const
 Get the vehicle type's maximum acceleration [m/s^2]. More...
 
double getMaxDecel () const
 Get the vehicle type's maximal comfortable deceleration [m/s^2]. More...
 
double getMinimalArrivalSpeed (double dist, double currentSpeed) const
 Computes the minimal possible arrival speed after covering a given distance. More...
 
double getMinimalArrivalSpeedEuler (double dist, double currentSpeed) const
 Computes the minimal possible arrival speed after covering a given distance for Euler update. More...
 
SUMOTime getMinimalArrivalTime (double dist, double currentSpeed, double arrivalSpeed) const
 Computes the minimal time needed to cover a distance given the desired speed at arrival. More...
 
virtual int getModelID () const
 Returns the model's ID; the XML-Tag number is used. More...
 
double getSpeedAfterMaxDecel (double v) const
 Returns the velocity after maximum deceleration. More...
 
double maximumSafeFollowSpeed (double gap, double egoSpeed, double predSpeed, double predMaxDecel, bool onInsertion=false) const
 Returns the maximum safe velocity for following the given leader. More...
 
double maximumSafeStopSpeed (double gap, double currentSpeed, bool onInsertion=false, double headway=-1) const
 Returns the maximum next velocity for stopping within gap. More...
 
double maximumSafeStopSpeedBallistic (double gap, double currentSpeed, bool onInsertion=false, double headway=-1) const
 Returns the maximum next velocity for stopping within gap when using the ballistic positional update. More...
 
double maximumSafeStopSpeedEuler (double gap) const
 Returns the maximum next velocity for stopping within gap when using the semi-implicit Euler update. More...
 
virtual double maxNextSpeed (double speed, const MSVehicle *const veh) const
 Returns the maximum speed given the current speed. More...
 
virtual double minNextSpeed (double speed, const MSVehicle *const veh) const
 Returns the minimum speed given the current speed (depends on the numerical update scheme and its step width) Note that it wouldn't have to depend on the numerical update scheme if the semantics would rely on acceleration instead of velocity. More...
 
double moveHelper (MSVehicle *const veh, double vPos) const
 Applies interaction with stops and lane changing model influences. More...
 
 MSCFModel_Rail (const MSVehicleType *vtype, std::string trainType)
 Constructor. More...
 
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) More...
 
virtual ~MSCFModel_Rail ()
 
Methods to override by model implementation
virtual double insertionFollowSpeed (const MSVehicle *const veh, double speed, double gap2pred, double predSpeed, double predMaxDecel) const
 Computes the vehicle's safe speed (no dawdling) This method is used during the insertion stage. Whereas the method followSpeed returns the desired speed which may be lower than the safe speed, this method only considers safety constraints. More...
 
virtual double insertionStopSpeed (const MSVehicle *const veh, double speed, double gap) const
 Computes the vehicle's safe speed for approaching an obstacle at insertion without constraints due to acceleration capabilities and previous speeds. More...
 
virtual double followSpeedTransient (double duration, const MSVehicle *const veh, double speed, double gap2pred, double predSpeed, double predMaxDecel) const
 Computes the vehicle's follow speed that avoids a collision for the given amount of time. More...
 
virtual double interactionGap (const MSVehicle *const veh, double vL) const
 Returns the maximum gap at which an interaction between both vehicles occurs. More...
 
Virtual methods with default implementation
virtual double getImperfection () const
 Get the driver's imperfection. More...
 
virtual double getHeadwayTime () const
 Get the driver's desired headway [s]. More...
 
Setter methods
virtual void setMaxAccel (double accel)
 Sets a new value for maximum acceleration [m/s^2]. More...
 
virtual void setMaxDecel (double decel)
 Sets a new value for maximal comfortable deceleration [m/s^2]. More...
 
virtual void setEmergencyDecel (double decel)
 Sets a new value for maximal physically possible deceleration [m/s^2]. More...
 
virtual void setApparentDecel (double decel)
 Sets a new value for the apparent deceleration [m/s^2]. More...
 
virtual void setImperfection (double imperfection)
 Sets a new value for driver imperfection. More...
 
virtual void setHeadwayTime (double headwayTime)
 Sets a new value for desired headway [s]. More...
 

Static Public Member Functions

static double avoidArrivalAccel (double dist, double time, double speed)
 Computes the acceleration needed to arrive not before the given time. More...
 
static double distAfterTime (double t, double speed, double accel)
 calculates the distance travelled after accelerating for time t More...
 
static double estimateArrivalTime (double dist, double speed, double maxSpeed, double accel)
 Computes the time needed to travel a distance dist given an initial speed and constant acceleration. The speed during traveling is assumed not to exceed the max speed. More...
 
static double estimateArrivalTime (double dist, double initialSpeed, double arrivalSpeed, double maxSpeed, double accel, double decel)
 Computes the time needed to travel a distance dist given an initial speed, arrival speed, constant acceleration and deceleration. The speed during traveling is assumed not to exceed the max speed. More...
 
static double gapExtrapolation (const double duration, const double currentGap, double v1, double v2, double a1=0, double a2=0, const double maxV1=std::numeric_limits< double >::max(), const double maxV2=std::numeric_limits< double >::max())
 return the resulting gap if, starting with gap currentGap, two vehicles continue with constant accelerations (velocities bounded by 0 and maxSpeed) for a given timespan of length 'duration'. More...
 
static double passingTime (const double lastPos, const double passedPos, const double currentPos, const double lastSpeed, const double currentSpeed)
 Calculates the time at which the position passedPosition has been passed In case of a ballistic update, the possibility of a stop within a time step requires more information about the last time-step than in case of the euler update to determine the last position if the currentSpeed is zero. More...
 
static double speedAfterTime (const double t, const double oldSpeed, const double dist)
 Calculates the speed after a time t [0,TS] given the initial speed and the distance traveled in an interval of step length TS. More...
 

Protected Attributes

double myAccel
 The vehicle's maximum acceleration [m/s^2]. More...
 
double myApparentDecel
 The vehicle's deceleration as expected by surrounding traffic [m/s^2]. More...
 
double myDecel
 The vehicle's maximum deceleration [m/s^2]. More...
 
double myEmergencyDecel
 The vehicle's maximum emergency deceleration [m/s^2]. More...
 
double myHeadwayTime
 The driver's desired time headway (aka reaction time tau) [s]. More...
 
const MSVehicleTypemyType
 The type to which this model definition belongs to. More...
 

Private Types

typedef std::map< double, double > LookUpMap
 

Private Member Functions

double getInterpolatedValueFromLookUpMap (double speed, const LookUpMap *lookUpMap) const
 
TrainParams initFreightParams () const
 
LookUpMap initFreightResistance () const
 
LookUpMap initFreightTraction () const
 
TrainParams initICE1Params () const
 
LookUpMap initICE1Resistance () const
 
LookUpMap initICE1Traction () const
 
TrainParams initICE3Params () const
 
LookUpMap initICE3Resistance () const
 
LookUpMap initICE3Traction () const
 
TrainParams initNGT400_16Params () const
 
LookUpMap initNGT400_16Resistance () const
 
LookUpMap initNGT400_16Traction () const
 
TrainParams initNGT400Params () const
 
LookUpMap initNGT400Resistance () const
 
LookUpMap initNGT400Traction () const
 
TrainParams initRB425Params () const
 
LookUpMap initRB425Resistance () const
 
LookUpMap initRB425Traction () const
 
TrainParams initRB628Params () const
 
LookUpMap initRB628Resistance () const
 
LookUpMap initRB628Traction () const
 
TrainParams initREDosto7Params () const
 
LookUpMap initREDosto7Resistance () const
 
LookUpMap initREDosto7Traction () const
 

Private Attributes

TrainParams myTrainParams
 

Currently fixed methods

double brakeGap (const double speed) const
 Returns the distance the vehicle needs to halt including driver's reaction time tau (i.e. desired headway), assuming that during the reaction time, the speed remains constant. More...
 
double getSecureGap (const double speed, const double leaderSpeed, const double leaderMaxDecel) const
 Returns the minimum gap to reserve if the leader is braking at maximum (>=0) More...
 
static double freeSpeed (const double currentSpeed, const double decel, const double dist, const double maxSpeed, const bool onInsertion, const double actionStepLength)
 
static double brakeGap (const double speed, const double decel, const double headwayTime)
 
static double brakeGapEuler (const double speed, const double decel, const double headwayTime)
 

Detailed Description

Definition at line 27 of file MSCFModel_Rail.h.

Member Typedef Documentation

◆ LookUpMap

typedef std::map<double, double> MSCFModel_Rail::LookUpMap
private

Definition at line 62 of file MSCFModel_Rail.h.

Constructor & Destructor Documentation

◆ MSCFModel_Rail()

MSCFModel_Rail::MSCFModel_Rail ( const MSVehicleType vtype,
std::string  trainType 
)

◆ ~MSCFModel_Rail()

MSCFModel_Rail::~MSCFModel_Rail ( )
virtual

Definition at line 66 of file MSCFModel_Rail.cpp.

Member Function Documentation

◆ avoidArrivalAccel()

double MSCFModel::avoidArrivalAccel ( double  dist,
double  time,
double  speed 
)
staticinherited

Computes the acceleration needed to arrive not before the given time.

Parameters
[in]dist- the distance of the critical point
[in]time- the time after which an arrival at dist is allowed
[in]speed- the current speed
Returns
Returns the acceleration which would ensure an arrival at distance dist earliest for the given time

Definition at line 415 of file MSCFModel.cpp.

Referenced by MSLCM_SL2015::commitManoeuvre(), and MSCFModel::getSpeedAfterMaxDecel().

◆ brakeGap() [1/2]

◆ brakeGap() [2/2]

double MSCFModel::brakeGap ( const double  speed,
const double  decel,
const double  headwayTime 
)
staticinherited

◆ brakeGapEuler()

double MSCFModel::brakeGapEuler ( const double  speed,
const double  decel,
const double  headwayTime 
)
staticinherited

Definition at line 80 of file MSCFModel.cpp.

References ACCEL2SPEED, and SPEED2DIST.

Referenced by MSCFModel::brakeGap(), and MSLCM_SL2015::computeSpeedLat().

◆ createVehicleVariables()

MSCFModel::VehicleVariables * MSCFModel_Rail::createVehicleVariables ( ) const
virtual

Returns model specific values which are stored inside a vehicle and must be used with casting.

Reimplemented from MSCFModel.

Definition at line 182 of file MSCFModel_Rail.cpp.

◆ distAfterTime()

double MSCFModel::distAfterTime ( double  t,
double  speed,
double  accel 
)
staticinherited

calculates the distance travelled after accelerating for time t

Definition at line 306 of file MSCFModel.cpp.

References ACCEL2SPEED, MSCFModel::brakeGap(), MSGlobals::gSemiImplicitEulerUpdate, MAX2(), SPEED2DIST, and TS.

Referenced by MSCFModel::followSpeedTransient(), and MSCFModel::getSpeedAfterMaxDecel().

◆ duplicate()

MSCFModel * MSCFModel_Rail::duplicate ( const MSVehicleType vtype) const
virtual

Duplicates the car-following model.

Parameters
[in]vtypeThe vehicle type this model belongs to (1:1)
Returns
A duplicate of this car-following model

XXX Fixme

Implements MSCFModel.

Definition at line 80 of file MSCFModel_Rail.cpp.

◆ estimateArrivalTime() [1/2]

double MSCFModel::estimateArrivalTime ( double  dist,
double  speed,
double  maxSpeed,
double  accel 
)
staticinherited

Computes the time needed to travel a distance dist given an initial speed and constant acceleration. The speed during traveling is assumed not to exceed the max speed.

Parameters
[in]distDistance to be covered (assumed >= 0.)
[in]speedInitial speed of vehicle
[in]accelAssumed acceleration until reaching maxspeed or speed=0.
Returns
Returns the estimated time needed to cover the given distance If distance will never be covered with the given parameters INVALID_DOUBLE (from MSLink.h) is returned.

Definition at line 344 of file MSCFModel.cpp.

References INVALID_DOUBLE.

Referenced by MSLCM_SL2015::commitManoeuvre(), MSDevice_SSM::estimateConflictTimes(), and MSCFModel::getSpeedAfterMaxDecel().

◆ estimateArrivalTime() [2/2]

double MSCFModel::estimateArrivalTime ( double  dist,
double  initialSpeed,
double  arrivalSpeed,
double  maxSpeed,
double  accel,
double  decel 
)
staticinherited

Computes the time needed to travel a distance dist given an initial speed, arrival speed, constant acceleration and deceleration. The speed during traveling is assumed not to exceed the max speed.

Parameters
[in]distDistance to be covered (assumed >= 0.)
[in]initialSpeedInitial speed of vehicle
[in]arrivalSpeeddesired arrival speed of vehicle
[in]accelAssumed acceleration until reaching maxspeed.
[in]accelAssumed deceleration until reaching targetspeed.
Returns
Returns the estimated time needed to cover the given distance If distance will never be covered with the given parameters INVALID_DOUBLE (from MSLink.h) is returned.
Note
Currently, this is still a stub for actually very special situations in LC context: It is assumed that 0==initialSpeed==arrivalSpeed<=maxspeed, accel==decel>0 (because currently this is only used for lane change purposes, where lateral accel == lateral decel)

Definition at line 383 of file MSCFModel.cpp.

References UNUSED_PARAMETER.

◆ estimateSpeedAfterDistance()

double MSCFModel::estimateSpeedAfterDistance ( const double  dist,
const double  v,
const double  accel 
) const
inherited

◆ followSpeed()

double MSCFModel_Rail::followSpeed ( const MSVehicle *const  veh,
double  speed,
double  gap2pred,
double  predSpeed,
double  predMaxDecel 
) const
virtual

Computes the vehicle's follow speed (no dawdling)

Returns the velocity of the vehicle in dependence to the vehicle's and its leader's values and the distance between them.

Parameters
[in]vehThe vehicle (EGO)
[in]speedThe vehicle's speed
[in]gap2predThe (netto) distance to the LEADER
[in]predSpeedThe speed of LEADER
Returns
EGO's safe speed

Implements MSCFModel.

Definition at line 69 of file MSCFModel_Rail.cpp.

References maxNextSpeed().

◆ followSpeedTransient()

double MSCFModel::followSpeedTransient ( double  duration,
const MSVehicle *const  veh,
double  speed,
double  gap2pred,
double  predSpeed,
double  predMaxDecel 
) const
virtualinherited

Computes the vehicle's follow speed that avoids a collision for the given amount of time.

Returns the velocity of the vehicle in dependence to the vehicle's and its leader's values and the distance between them.

Parameters
[in]vehThe vehicle (EGO)
[in]speedThe vehicle's speed
[in]gap2predThe (netto) distance to the LEADER
[in]predSpeedThe speed of LEADER
[in]predMaxDecelThe maximum leader decelration
Returns
EGO's safe speed

Definition at line 255 of file MSCFModel.cpp.

References ACCEL2SPEED, MSCFModel::brakeGap(), DIST2SPEED, MSCFModel::distAfterTime(), gDebugFlag2, MSCFModel::getMaxDecel(), MSGlobals::gSemiImplicitEulerUpdate, MSCFModel::myDecel, SPEED2DIST, and TS.

Referenced by MSLCM_SL2015::commitFollowSpeed().

◆ freeSpeed() [1/2]

double MSCFModel_Rail::freeSpeed ( const MSVehicle *const  veh,
double  speed,
double  seen,
double  maxSpeed,
const bool  onInsertion 
) const
virtual

Computes the vehicle's safe speed without a leader.

Returns the velocity of the vehicle in dependence to the length of the free street and the target velocity at the end of the free range. If onInsertion is true, the vehicle may still brake before the next movement.

Parameters
[in]vehThe vehicle (EGO)
[in]speedThe vehicle's speed
[in]seenThe look ahead distance
[in]maxSpeedThe maximum allowed speed
[in]onInsertionwhether speed at insertion is asked for
Returns
EGO's safe speed

Reimplemented from MSCFModel.

Definition at line 197 of file MSCFModel_Rail.cpp.

References ACCEL2DIST, ACCEL2SPEED, MSCFModel_Rail::TrainParams::decl, DIST2SPEED, MSGlobals::gSemiImplicitEulerUpdate, MAX2(), MSCFModel::myDecel, myTrainParams, SPEED2DIST, and WRITE_ERROR.

◆ freeSpeed() [2/2]

double MSCFModel::freeSpeed ( const double  currentSpeed,
const double  decel,
const double  dist,
const double  maxSpeed,
const bool  onInsertion,
const double  actionStepLength 
)
staticinherited

◆ gapExtrapolation()

double MSCFModel::gapExtrapolation ( const double  duration,
const double  currentGap,
double  v1,
double  v2,
double  a1 = 0,
double  a2 = 0,
const double  maxV1 = std::numeric_limits<double>::max(),
const double  maxV2 = std::numeric_limits<double>::max() 
)
staticinherited

return the resulting gap if, starting with gap currentGap, two vehicles continue with constant accelerations (velocities bounded by 0 and maxSpeed) for a given timespan of length 'duration'.

Parameters
[in]currentGap(pos(veh1) - pos(veh2) at start)
[in]v1initial speed of vehicle 1
[in]v2initial speed of vehicle 2
[in]a1acceleration of vehicle 1
[in]a2acceleration of vehicle 2
[in]maxV1maximal speed of vehicle 1
[in]maxV2maximal speed of vehicle 2
[in]durationtime span for the process
Returns
estimated gap after 'duration' seconds

Definition at line 458 of file MSCFModel.cpp.

References MSGlobals::gSemiImplicitEulerUpdate, MAX2(), MIN2(), and TS.

Referenced by MSLCM_SL2015::checkBlockingVehicles(), MSCFModel::getSpeedAfterMaxDecel(), and MSLCM_LC2013::informFollower().

◆ getApparentDecel()

double MSCFModel::getApparentDecel ( ) const
inlineinherited

Get the vehicle type's apparent deceleration [m/s^2] (the one regarded by its followers.

Returns
The apparent deceleration (in m/s^2) of vehicles of this class

Definition at line 227 of file MSCFModel.h.

References MSCFModel::myApparentDecel.

Referenced by libsumo::VehicleType::getApparentDecel(), and libsumo::Vehicle::getApparentDecel().

◆ getEmergencyDecel()

double MSCFModel::getEmergencyDecel ( ) const
inlineinherited

Get the vehicle type's maximal phisically possible deceleration [m/s^2].

Returns
The maximal physically possible deceleration (in m/s^2) of vehicles of this class

Definition at line 219 of file MSCFModel.h.

References MSCFModel::myEmergencyDecel.

Referenced by libsumo::VehicleType::getEmergencyDecel(), and libsumo::Vehicle::getEmergencyDecel().

◆ getHeadwayTime()

virtual double MSCFModel::getHeadwayTime ( ) const
inlinevirtualinherited

◆ getImperfection()

virtual double MSCFModel::getImperfection ( ) const
inlinevirtualinherited

Get the driver's imperfection.

Returns
The imperfection of drivers of this class

Reimplemented in MSCFModel_KraussOrig1, MSCFModel_SmartSK, MSCFModel_Daniel1, and MSCFModel_PWag2009.

Definition at line 238 of file MSCFModel.h.

Referenced by libsumo::VehicleType::getImperfection(), and libsumo::Vehicle::getImperfection().

◆ getInterpolatedValueFromLookUpMap()

double MSCFModel_Rail::getInterpolatedValueFromLookUpMap ( double  speed,
const LookUpMap lookUpMap 
) const
private

Definition at line 133 of file MSCFModel_Rail.cpp.

Referenced by maxNextSpeed(), and minNextSpeed().

◆ getMaxAccel()

◆ getMaxDecel()

double MSCFModel::getMaxDecel ( ) const
inlineinherited

Get the vehicle type's maximal comfortable deceleration [m/s^2].

Returns
The maximal comfortable deceleration (in m/s^2) of vehicles of this class

Definition at line 211 of file MSCFModel.h.

References MSCFModel::myDecel.

Referenced by MSLCM_LC2013::_wantsChange(), MSLCM_LC2013::adaptSpeedToPedestrians(), MSPModel_Striping::addCrossingVehs(), MSCriticalFollowerDistanceInfo::addFollower(), MSLink::blockedByFoe(), MSLaneChanger::changeOpposite(), MSLCM_SL2015::checkBlockingVehicles(), MSLaneChanger::checkChange(), MSLane::checkForPedestrians(), MSVehicle::checkRewindLinkLanes(), MSLCM_SL2015::checkStrategicChange(), MSLCM_SL2015::commitFollowSpeed(), MSLaneChanger::computeOvertakingTime(), MSLink::couldBrakeForLeader(), MSCFModel::followSpeedTransient(), MSLane::freeInsertion(), MSLane::getCriticalLeader(), libsumo::VehicleType::getDecel(), libsumo::Vehicle::getDecel(), MSLane::getLeaderOnConsecutive(), MSLane::getLeadersOnConsecutive(), MSCFModel::getMinimalArrivalSpeed(), MSCFModel::getMinimalArrivalSpeedEuler(), MSCFModel::getMinimalArrivalTime(), MSLane::getMissingRearGap(), MSLink::getZipperSpeed(), MSLCM_DK2008::informBlocker(), MSLCM_LC2013::informFollower(), MSLCM_SL2015::informFollower(), MSLCM_LC2013::informLeader(), MSLCM_SL2015::informLeader(), MSLane::isInsertionSuccess(), MESegment::isOpen(), MSLane::lastInsertion(), MSLink::maybeOccupied(), MSLCM_LC2013::overtakeDistance(), MSVehicle::planMoveInternal(), MSVehicle::processLinkAproaches(), MSLane::safeInsertionSpeed(), MSLCM_SL2015::saveBlockerLength(), MSLCM_LC2013::saveBlockerLength(), GUIVehicle::selectBlockingFoes(), MSAbstractLaneChangeModel::setFollowerGaps(), MSAbstractLaneChangeModel::setLeaderGaps(), MSAbstractLaneChangeModel::setOrigLeaderGaps(), MSLCM_LC2013::slowDownForBlocked(), MSLCM_SL2015::slowDownForBlocked(), MSLCM_SL2015::updateExpectedSublaneSpeeds(), MSVehicleControl::vehicleDeparted(), MSLCM_DK2008::wantsChangeToLeft(), and MSLCM_DK2008::wantsChangeToRight().

◆ getMinimalArrivalSpeed()

double MSCFModel::getMinimalArrivalSpeed ( double  dist,
double  currentSpeed 
) const
inherited

Computes the minimal possible arrival speed after covering a given distance.

Parameters
[in]distDistance to be covered
[in]currentSpeedActual speed of vehicle

Definition at line 432 of file MSCFModel.cpp.

References MSCFModel::estimateSpeedAfterDistance(), MSCFModel::getHeadwayTime(), and MSCFModel::getMaxDecel().

Referenced by MSCFModel::getSpeedAfterMaxDecel(), and MSVehicle::planMoveInternal().

◆ getMinimalArrivalSpeedEuler()

double MSCFModel::getMinimalArrivalSpeedEuler ( double  dist,
double  currentSpeed 
) const
inherited

Computes the minimal possible arrival speed after covering a given distance for Euler update.

Parameters
[in]distDistance to be covered
[in]currentSpeedActual speed of vehicle

Definition at line 439 of file MSCFModel.cpp.

References MSCFModel::estimateSpeedAfterDistance(), MSCFModel::getHeadwayTime(), MSCFModel::getMaxDecel(), and INVALID_SPEED.

Referenced by MSCFModel::getSpeedAfterMaxDecel(), and MSVehicle::planMoveInternal().

◆ getMinimalArrivalTime()

SUMOTime MSCFModel::getMinimalArrivalTime ( double  dist,
double  currentSpeed,
double  arrivalSpeed 
) const
inherited

Computes the minimal time needed to cover a distance given the desired speed at arrival.

Parameters
[in]distDistance to be covered
[in]currentSpeedActual speed of vehicle
[in]arrivalSpeedDesired speed at arrival

Definition at line 331 of file MSCFModel.cpp.

References MSCFModel::getMaxAccel(), MSCFModel::getMaxDecel(), MAX2(), MAX3(), SUMO_const_haltingSpeed, and TIME2STEPS.

Referenced by MSCFModel::getSpeedAfterMaxDecel(), and MSVehicle::planMoveInternal().

◆ getModelID()

int MSCFModel_Rail::getModelID ( ) const
virtual

Returns the model's ID; the XML-Tag number is used.

Returns
The model's ID

Implements MSCFModel.

Definition at line 75 of file MSCFModel_Rail.cpp.

References SUMO_TAG_CF_RAIL.

◆ getSecureGap()

◆ getSpeedAfterMaxDecel()

double MSCFModel_Rail::getSpeedAfterMaxDecel ( double  v) const
virtual

Returns the velocity after maximum deceleration.

Parameters
[in]vThe velocity
Returns
The velocity after maximum deceleration

Reimplemented from MSCFModel.

Definition at line 170 of file MSCFModel_Rail.cpp.

References WRITE_ERROR.

◆ initFreightParams()

◆ initFreightResistance()

LookUpMap MSCFModel_Rail::initFreightResistance ( ) const
inlineprivate

Definition at line 654 of file MSCFModel_Rail.h.

Referenced by initFreightParams().

◆ initFreightTraction()

LookUpMap MSCFModel_Rail::initFreightTraction ( ) const
inlineprivate

Definition at line 636 of file MSCFModel_Rail.h.

Referenced by initFreightParams().

◆ initICE1Params()

◆ initICE1Resistance()

LookUpMap MSCFModel_Rail::initICE1Resistance ( ) const
inlineprivate

Definition at line 383 of file MSCFModel_Rail.h.

Referenced by initICE1Params().

◆ initICE1Traction()

LookUpMap MSCFModel_Rail::initICE1Traction ( ) const
inlineprivate

Definition at line 352 of file MSCFModel_Rail.h.

Referenced by initICE1Params().

◆ initICE3Params()

◆ initICE3Resistance()

LookUpMap MSCFModel_Rail::initICE3Resistance ( ) const
inlineprivate

Definition at line 478 of file MSCFModel_Rail.h.

Referenced by initICE3Params().

◆ initICE3Traction()

LookUpMap MSCFModel_Rail::initICE3Traction ( ) const
inlineprivate

Definition at line 442 of file MSCFModel_Rail.h.

Referenced by initICE3Params().

◆ initNGT400_16Params()

◆ initNGT400_16Resistance()

LookUpMap MSCFModel_Rail::initNGT400_16Resistance ( ) const
inlineprivate

Definition at line 285 of file MSCFModel_Rail.h.

Referenced by initNGT400_16Params().

◆ initNGT400_16Traction()

LookUpMap MSCFModel_Rail::initNGT400_16Traction ( ) const
inlineprivate

Definition at line 232 of file MSCFModel_Rail.h.

Referenced by initNGT400_16Params().

◆ initNGT400Params()

◆ initNGT400Resistance()

LookUpMap MSCFModel_Rail::initNGT400Resistance ( ) const
inlineprivate

Definition at line 164 of file MSCFModel_Rail.h.

Referenced by initNGT400Params().

◆ initNGT400Traction()

LookUpMap MSCFModel_Rail::initNGT400Traction ( ) const
inlineprivate

Definition at line 110 of file MSCFModel_Rail.h.

Referenced by initNGT400Params().

◆ initRB425Params()

◆ initRB425Resistance()

LookUpMap MSCFModel_Rail::initRB425Resistance ( ) const
inlineprivate

Definition at line 694 of file MSCFModel_Rail.h.

Referenced by initRB425Params().

◆ initRB425Traction()

LookUpMap MSCFModel_Rail::initRB425Traction ( ) const
inlineprivate

Definition at line 672 of file MSCFModel_Rail.h.

Referenced by initRB425Params().

◆ initRB628Params()

◆ initRB628Resistance()

LookUpMap MSCFModel_Rail::initRB628Resistance ( ) const
inlineprivate

Definition at line 604 of file MSCFModel_Rail.h.

Referenced by initRB628Params().

◆ initRB628Traction()

LookUpMap MSCFModel_Rail::initRB628Traction ( ) const
inlineprivate

Definition at line 586 of file MSCFModel_Rail.h.

Referenced by initRB628Params().

◆ initREDosto7Params()

◆ initREDosto7Resistance()

LookUpMap MSCFModel_Rail::initREDosto7Resistance ( ) const
inlineprivate

Definition at line 550 of file MSCFModel_Rail.h.

Referenced by initREDosto7Params().

◆ initREDosto7Traction()

LookUpMap MSCFModel_Rail::initREDosto7Traction ( ) const
inlineprivate

Definition at line 528 of file MSCFModel_Rail.h.

Referenced by initREDosto7Params().

◆ insertionFollowSpeed()

double MSCFModel::insertionFollowSpeed ( const MSVehicle *const  veh,
double  speed,
double  gap2pred,
double  predSpeed,
double  predMaxDecel 
) const
virtualinherited

Computes the vehicle's safe speed (no dawdling) This method is used during the insertion stage. Whereas the method followSpeed returns the desired speed which may be lower than the safe speed, this method only considers safety constraints.

Returns the velocity of the vehicle in dependence to the vehicle's and its leader's values and the distance between them.

Parameters
[in]vehThe vehicle (EGO)
[in]speedThe vehicle's speed
[in]gap2predThe (netto) distance to the LEADER
[in]predSpeedThe speed of LEADER
Returns
EGO's safe speed

Reimplemented in MSCFModel_KraussOrig1.

Definition at line 234 of file MSCFModel.cpp.

References MSGlobals::gSemiImplicitEulerUpdate, and MSCFModel::maximumSafeFollowSpeed().

Referenced by MSLane::freeInsertion(), MSLane::getCriticalLeader(), and MSLane::safeInsertionSpeed().

◆ insertionStopSpeed()

double MSCFModel::insertionStopSpeed ( const MSVehicle *const  veh,
double  speed,
double  gap 
) const
virtualinherited

Computes the vehicle's safe speed for approaching an obstacle at insertion without constraints due to acceleration capabilities and previous speeds.

Parameters
[in]vehThe vehicle (EGO)
[in]speedThe vehicle's speed
[in]gapThe (netto) distance to the the obstacle
Returns
EGO's safe speed for approaching a non-moving obstacle at insertion
See also
stopSpeed() and insertionFollowSpeed()

Definition at line 245 of file MSCFModel.cpp.

References MSVehicleType::getMaxSpeed(), MSGlobals::gSemiImplicitEulerUpdate, MSCFModel::maximumSafeStopSpeed(), MIN2(), MSCFModel::myType, and MSCFModel::stopSpeed().

Referenced by MSLane::isInsertionSuccess().

◆ interactionGap()

double MSCFModel::interactionGap ( const MSVehicle *const  veh,
double  vL 
) const
virtualinherited

Returns the maximum gap at which an interaction between both vehicles occurs.

"interaction" means that the LEADER influences EGO's speed.

Parameters
[in]vehThe EGO vehicle
[in]vLLEADER's speed
Returns
The interaction gap
Todo:
evaluate signature

Reimplemented in MSCFModel_IDM, and MSCFModel_Wiedemann.

Definition at line 189 of file MSCFModel.cpp.

References MSVehicle::getLane(), MSVehicle::getSpeed(), MSLane::getVehicleMaxSpeed(), MAX2(), MSCFModel::maxNextSpeed(), MIN2(), MSCFModel::myDecel, MSCFModel::myHeadwayTime, and SPEED2DIST.

Referenced by MSAbstractLaneChangeModel::predInteraction().

◆ maximumSafeFollowSpeed()

double MSCFModel::maximumSafeFollowSpeed ( double  gap,
double  egoSpeed,
double  predSpeed,
double  predMaxDecel,
bool  onInsertion = false 
) const
inherited

Returns the maximum safe velocity for following the given leader.

Parameters
[in]gap2predThe (netto) distance to the LEADER
[in]egoSpeedThe FOLLOWERS's speed
[in]predSpeedThe LEADER's speed
[in]predMaxDecelThe LEADER's maximum deceleration
[in]onInsertionIndicator whether the call is triggered during vehicle insertion
Returns
the safe velocity

Returns the SK-vsafe.

Definition at line 770 of file MSCFModel.cpp.

References MSCFModel::brakeGap(), MSGlobals::gSemiImplicitEulerUpdate, ISNAN(), MAX2(), MSCFModel::maximumSafeStopSpeed(), MSCFModel::myDecel, and MSCFModel::myHeadwayTime.

Referenced by MSLCM_LC2013::_wantsChange(), MSCFModel_KraussOrig1::followSpeed(), MSCFModel_Krauss::followSpeed(), MSCFModel_KraussOrig1::insertionFollowSpeed(), MSCFModel::insertionFollowSpeed(), and MSCFModel::setHeadwayTime().

◆ maximumSafeStopSpeed()

double MSCFModel::maximumSafeStopSpeed ( double  gap,
double  currentSpeed,
bool  onInsertion = false,
double  headway = -1 
) const
inherited

Returns the maximum next velocity for stopping within gap.

Parameters
[in]gapThe (netto) distance to the desired stopping point
[in]currentSpeedThe current speed of the ego vehicle
[in]onInsertionIndicator whether the call is triggered during vehicle insertion
[in]headwayThe desired time headway to be included in the calculations (default argument -1 induces the use of myHeadway)

Definition at line 662 of file MSCFModel.cpp.

References MSGlobals::gSemiImplicitEulerUpdate, MSCFModel::maximumSafeStopSpeedBallistic(), and MSCFModel::maximumSafeStopSpeedEuler().

Referenced by MSLCM_LC2013::_wantsChange(), MSCFModel::insertionStopSpeed(), MSCFModel::maximumSafeFollowSpeed(), MSVehicle::planMoveInternal(), MSCFModel::setHeadwayTime(), stopSpeed(), and MSCFModel_Krauss::stopSpeed().

◆ maximumSafeStopSpeedBallistic()

double MSCFModel::maximumSafeStopSpeedBallistic ( double  gap,
double  currentSpeed,
bool  onInsertion = false,
double  headway = -1 
) const
inherited

Returns the maximum next velocity for stopping within gap when using the ballistic positional update.

Note
This takes into account the driver's reaction time tau (i.e. the desired headway) and the car's current speed. (The latter is required to calculate the distance covered in the following timestep.)
Parameters
[in]gapThe (netto) distance to the desired stopping point
[in]currentSpeedThe current speed of the ego vehicle
[in]onInsertionIndicator whether the call is triggered during vehicle insertion
[in]headwayThe desired time headway to be included in the calculations (default argument -1 induces the use of myHeadway)
Returns
the safe velocity (to be attained at the end of the following time step) that assures the possibility of stopping within gap. If a negative value is returned, the required stop has to take place before the end of the time step.

Definition at line 703 of file MSCFModel.cpp.

References INVALID_SPEED, MAX2(), MSCFModel::myDecel, MSCFModel::myHeadwayTime, NUMERICAL_EPS, and TS.

Referenced by MSCFModel::maximumSafeStopSpeed(), MSCFModel::setHeadwayTime(), and MSCFModel_KraussOrig1::stopSpeed().

◆ maximumSafeStopSpeedEuler()

double MSCFModel::maximumSafeStopSpeedEuler ( double  gap) const
inherited

Returns the maximum next velocity for stopping within gap when using the semi-implicit Euler update.

Parameters
[in]gapThe (netto) distance to the LEADER

Definition at line 672 of file MSCFModel.cpp.

References ACCEL2SPEED, DIST2SPEED, MIN2(), MSCFModel::myDecel, MSCFModel::myHeadwayTime, NUMERICAL_EPS, and TS.

Referenced by MSCFModel::maximumSafeStopSpeed(), and MSCFModel::setHeadwayTime().

◆ maxNextSpeed()

double MSCFModel_Rail::maxNextSpeed ( double  speed,
const MSVehicle *const  veh 
) const
virtual

Returns the maximum speed given the current speed.

The implementation of this method must take into account the time step duration.

Justification: Due to air brake or other influences, the vehicle's next maximum speed may depend on the vehicle's current speed (given).

Parameters
[in]speedThe vehicle's current speed
[in]speedThe vehicle itself, for obtaining other values
Returns
The maximum possible speed for the next step

Reimplemented from MSCFModel.

Definition at line 85 of file MSCFModel_Rail.cpp.

References DEG2RAD, DELTA_T, G, getInterpolatedValueFromLookUpMap(), MSVehicle::getSlope(), myTrainParams, MSCFModel_Rail::TrainParams::resistance, MSCFModel_Rail::TrainParams::rotWeight, MSCFModel_Rail::TrainParams::traction, MSCFModel_Rail::TrainParams::vmax, and MSCFModel_Rail::TrainParams::weight.

Referenced by followSpeed(), moveHelper(), and stopSpeed().

◆ minNextSpeed()

double MSCFModel_Rail::minNextSpeed ( double  speed,
const MSVehicle *const  veh 
) const
virtual

Returns the minimum speed given the current speed (depends on the numerical update scheme and its step width) Note that it wouldn't have to depend on the numerical update scheme if the semantics would rely on acceleration instead of velocity.

Parameters
[in]speedThe vehicle's current speed
[in]speedThe vehicle itself, for obtaining other values, if needed as e.g. road conditions.
Returns
The minimum possible speed for the next step

Reimplemented from MSCFModel.

Definition at line 119 of file MSCFModel_Rail.cpp.

References MSCFModel_Rail::TrainParams::decl, DEG2RAD, DELTA_T, G, getInterpolatedValueFromLookUpMap(), MSVehicle::getSlope(), myTrainParams, MSCFModel_Rail::TrainParams::resistance, MSCFModel_Rail::TrainParams::rotWeight, and MSCFModel_Rail::TrainParams::weight.

Referenced by moveHelper().

◆ moveHelper()

double MSCFModel_Rail::moveHelper ( MSVehicle *const  veh,
double  vPos 
) const
virtual

Applies interaction with stops and lane changing model influences.

Parameters
[in]vehThe ego vehicle
[in]vPosThe possible velocity
Returns
The velocity after applying interactions with stops and lane change model influences

Reimplemented from MSCFModel.

Definition at line 188 of file MSCFModel_Rail.cpp.

References MSVehicle::getLaneChangeModel(), MSVehicle::getMaxSpeedOnLane(), MSVehicle::getSpeed(), MAX2(), maxNextSpeed(), MIN2(), MIN3(), minNextSpeed(), MSAbstractLaneChangeModel::patchSpeed(), and MSVehicle::processNextStop().

◆ passingTime()

double MSCFModel::passingTime ( const double  lastPos,
const double  passedPos,
const double  currentPos,
const double  lastSpeed,
const double  currentSpeed 
)
staticinherited

Calculates the time at which the position passedPosition has been passed In case of a ballistic update, the possibility of a stop within a time step requires more information about the last time-step than in case of the euler update to determine the last position if the currentSpeed is zero.

Parameters
[in]lastPosthe position at time t=0 (must be < currentPos)
[in]passedPosthe position for which the passing time is to be determined (has to lie within [lastPos, currentPos]!)
[in]currentPosthe position at time t=TS (one time-step after lastPos) (must be > lastPos)
[in]lastSpeedthe speed at moment t=0
[in]currentSpeedthe speed at moment t=TS
Returns
time t in [0,TS] at which passedPos in [lastPos, currentPos] was passed.

Definition at line 552 of file MSCFModel.cpp.

References MSGlobals::gSemiImplicitEulerUpdate, MAX2(), MIN2(), NUMERICAL_EPS, SPEED2ACCEL, TS, and WRITE_ERROR.

Referenced by MSE2Collector::calculateTimeLossAndTimeOnDetector(), MSDevice_SSM::checkConflictEntryAndExit(), MSCFModel::getSpeedAfterMaxDecel(), MSE3Collector::MSE3EntryReminder::notifyMove(), MSInstantInductLoop::notifyMove(), MSMeanData::MeanDataValues::notifyMove(), MSInductLoop::notifyMove(), and MSE3Collector::MSE3LeaveReminder::notifyMove().

◆ setApparentDecel()

virtual void MSCFModel::setApparentDecel ( double  decel)
inlinevirtualinherited

Sets a new value for the apparent deceleration [m/s^2].

Parameters
[in]decelThe new deceleration in m/s^2

Definition at line 467 of file MSCFModel.h.

References MSCFModel::myApparentDecel.

Referenced by libsumo::VehicleType::setApparentDecel().

◆ setEmergencyDecel()

virtual void MSCFModel::setEmergencyDecel ( double  decel)
inlinevirtualinherited

Sets a new value for maximal physically possible deceleration [m/s^2].

Parameters
[in]decelThe new deceleration in m/s^2

Definition at line 459 of file MSCFModel.h.

References MSCFModel::myEmergencyDecel.

Referenced by libsumo::VehicleType::setEmergencyDecel().

◆ setHeadwayTime()

virtual void MSCFModel::setHeadwayTime ( double  headwayTime)
inlinevirtualinherited

Sets a new value for desired headway [s].

Parameters
[in]headwayTimeThe new desired headway (in s)

Reimplemented in MSCFModel_KraussOrig1, MSCFModel_SmartSK, and MSCFModel_Daniel1.

Definition at line 483 of file MSCFModel.h.

References MSCFModel::maximumSafeFollowSpeed(), MSCFModel::maximumSafeStopSpeed(), MSCFModel::maximumSafeStopSpeedBallistic(), MSCFModel::maximumSafeStopSpeedEuler(), and MSCFModel::myHeadwayTime.

Referenced by libsumo::VehicleType::setTau().

◆ setImperfection()

virtual void MSCFModel::setImperfection ( double  imperfection)
inlinevirtualinherited

Sets a new value for driver imperfection.

Parameters
[in]accelThe new driver imperfection

Reimplemented in MSCFModel_KraussOrig1, MSCFModel_SmartSK, and MSCFModel_Daniel1.

Definition at line 475 of file MSCFModel.h.

References UNUSED_PARAMETER.

Referenced by libsumo::VehicleType::setImperfection().

◆ setMaxAccel()

virtual void MSCFModel::setMaxAccel ( double  accel)
inlinevirtualinherited

Sets a new value for maximum acceleration [m/s^2].

Parameters
[in]accelThe new acceleration in m/s^2

Definition at line 443 of file MSCFModel.h.

References MSCFModel::myAccel.

Referenced by libsumo::VehicleType::setAccel().

◆ setMaxDecel()

virtual void MSCFModel::setMaxDecel ( double  decel)
inlinevirtualinherited

Sets a new value for maximal comfortable deceleration [m/s^2].

Parameters
[in]decelThe new deceleration in m/s^2

Reimplemented in MSCFModel_KraussOrig1, MSCFModel_SmartSK, and MSCFModel_Daniel1.

Definition at line 451 of file MSCFModel.h.

References MSCFModel::myDecel.

Referenced by MSLCM_SL2015::commitFollowSpeed(), MSCFModel_Rail(), and libsumo::VehicleType::setDecel().

◆ speedAfterTime()

double MSCFModel::speedAfterTime ( const double  t,
const double  oldSpeed,
const double  dist 
)
staticinherited

Calculates the speed after a time t [0,TS] given the initial speed and the distance traveled in an interval of step length TS.

Note
If the acceleration were known, this would be much nicer, but in this way we need to reconstruct it (for the ballistic update at least, where we assume that a stop may occur within the interval)
Parameters
[in]ttime in [0,TS] for which the speed shall be determined
[in]oldSpeedspeed before the last time step (referred to as t == 0)
[in]distancecovered
Returns
speed at time t

Definition at line 624 of file MSCFModel.cpp.

References DIST2SPEED, MSGlobals::gSemiImplicitEulerUpdate, and TS.

Referenced by MSE2Collector::calculateTimeLossAndTimeOnDetector(), MSCFModel::getSpeedAfterMaxDecel(), MSInstantInductLoop::notifyMove(), and MSMeanData::MeanDataValues::notifyMove().

◆ stopSpeed()

double MSCFModel_Rail::stopSpeed ( const MSVehicle *const  veh,
const double  speed,
double  gap 
) const
virtual

Computes the vehicle's safe speed for approaching a non-moving obstacle (no dawdling)

Returns the velocity of the vehicle when approaching a static object (such as the end of a lane) assuming no reaction time is needed.

Parameters
[in]vehThe vehicle (EGO)
[in]speedThe vehicle's speed
[in]gapThe (netto) distance to the the obstacle
Returns
EGO's safe speed for approaching a non-moving obstacle
Todo:
generic Interface, models can call for the values they need

Implements MSCFModel.

Definition at line 229 of file MSCFModel_Rail.cpp.

References MSCFModel::maximumSafeStopSpeed(), maxNextSpeed(), MIN2(), and TS.

Field Documentation

◆ myAccel

◆ myApparentDecel

◆ myDecel

◆ myEmergencyDecel

◆ myHeadwayTime

◆ myTrainParams

TrainParams MSCFModel_Rail::myTrainParams
private

Definition at line 108 of file MSCFModel_Rail.h.

Referenced by freeSpeed(), maxNextSpeed(), minNextSpeed(), and MSCFModel_Rail().

◆ myType

const MSVehicleType* MSCFModel::myType
protectedinherited

The documentation for this class was generated from the following files: