SUMO - Simulation of Urban MObility
MSLCM_DK2008 Class Reference

A lane change model developed by D. Krajzewicz between 2004 and 2010. More...

#include <MSLCM_DK2008.h>

Inheritance diagram for MSLCM_DK2008:
Inheritance graph
Collaboration diagram for MSLCM_DK2008:
Collaboration graph

Public Types

enum  MyLCAEnum {
  LCA_AMBLOCKINGLEADER = 1 << 16, LCA_AMBLOCKINGFOLLOWER = 1 << 17, LCA_MRIGHT = 1 << 18, LCA_MLEFT = 1 << 19,
  LCA_AMBLOCKINGFOLLOWER_DONTBRAKE = 1 << 21, LCA_AMBACKBLOCKER = 1 << 26, LCA_AMBACKBLOCKER_STANDING = 1 << 27
}
 

Public Member Functions

bool alreadyMoved () const
 reset the flag whether a vehicle already moved to false More...
 
virtual void changed (int dir)
 
void continueLaneChangeManeuver (bool moved)
 
void endLaneChangeManeuver (const MSMoveReminder::Notification reason=MSMoveReminder::NOTIFICATION_LANE_CHANGE)
 
SUMOReal getLaneChangeCompletion () const
 return whether the vehicle passed the midpoint of a continuous lane change maneuver More...
 
int getLaneChangeDirection () const
 return the direction of the current lane change maneuver More...
 
SUMOTime getLastLaneChangeOffset () const
 
int getOwnState () const
 
MSLanegetShadowLane () const
 Returns the lane the vehicles shadow is on during continuouss lane change. More...
 
MSLanegetShadowLane (const MSLane *lane) const
 return the shadow lane for the given lane More...
 
bool hasShadowVehicle () const
 return true if the vehicle currently has a shadow vehicle More...
 
virtual void * inform (void *info, MSVehicle *sender)
 
bool isChangingLanes () const
 return true if the vehicle currently performs a lane change maneuver More...
 
bool isLaneChangeMidpointPassed () const
 return whether the vehicle passed the midpoint of a continuous lane change maneuver More...
 
 MSLCM_DK2008 (MSVehicle &v)
 
virtual SUMOReal patchSpeed (const SUMOReal min, const SUMOReal wanted, const SUMOReal max, const MSCFModel &cfModel)
 Called to adapt the speed in order to allow a lane change. More...
 
virtual void prepareStep ()
 
void removeLaneChangeShadow (const MSMoveReminder::Notification reason, bool notify=true)
 remove the shadow copy of a lane change maneuver More...
 
void resetMoved ()
 reset the flag whether a vehicle already moved to false More...
 
virtual void saveBlockerLength (SUMOReal length)
 reserve space at the end of the lane to avoid dead locks More...
 
void setNoShadowPartialOccupator (MSLane *lane)
 
void setOwnState (int state)
 
void setShadowPartialOccupator (MSLane *lane)
 
bool startLaneChangeManeuver (MSLane *source, MSLane *target, int direction)
 start the lane change maneuver and return whether it continues More...
 
void unchanged ()
 
int wantsChange (int laneOffset, MSAbstractLaneChangeModel::MSLCMessager &msgPass, int blocked, const std::pair< MSVehicle *, SUMOReal > &leader, const std::pair< MSVehicle *, SUMOReal > &neighLead, const std::pair< MSVehicle *, SUMOReal > &neighFollow, const MSLane &neighLane, const std::vector< MSVehicle::LaneQ > &preb, MSVehicle **lastBlocked, MSVehicle **firstBlocked)
 Called to examine whether the vehicle wants to change using the given laneOffset. This method gets the information about the surrounding vehicles and whether another lane may be more preferable. More...
 
virtual ~MSLCM_DK2008 ()
 

Static Public Member Functions

static MSAbstractLaneChangeModelbuild (LaneChangeModel lcm, MSVehicle &vehicle)
 Factory method for instantiating new lane changing models. More...
 
static void initGlobalOptions (const OptionsCont &oc)
 init global model parameters More...
 

Protected Types

typedef std::pair< SUMOReal, int > Info
 

Protected Member Functions

bool amBlockingFollower ()
 
bool amBlockingFollowerNB ()
 
bool amBlockingFollowerPlusNB ()
 
bool amBlockingLeader ()
 
bool cancelRequest (int state)
 whether the influencer cancels the given request More...
 
virtual bool congested (const MSVehicle *const neighLeader)
 
bool currentDistAllows (SUMOReal dist, int laneOffset, SUMOReal lookForwardDist)
 
bool currentDistDisallows (SUMOReal dist, int laneOffset, SUMOReal lookForwardDist)
 
void informBlocker (MSAbstractLaneChangeModel::MSLCMessager &msgPass, int &blocked, int dir, const std::pair< MSVehicle *, SUMOReal > &neighLead, const std::pair< MSVehicle *, SUMOReal > &neighFollow)
 
void initLastLaneChangeOffset (int dir)
 
virtual bool predInteraction (const MSVehicle *const leader)
 
virtual int wantsChangeToLeft (MSAbstractLaneChangeModel::MSLCMessager &msgPass, int blocked, const std::pair< MSVehicle *, SUMOReal > &leader, const std::pair< MSVehicle *, SUMOReal > &neighLead, const std::pair< MSVehicle *, SUMOReal > &neighFollow, const MSLane &neighLane, const std::vector< MSVehicle::LaneQ > &preb, MSVehicle **lastBlocked, MSVehicle **firstBlocked)
 Called to examine whether the vehicle wants to change to left This method gets the information about the surrounding vehicles and whether another lane may be more preferable. More...
 
virtual int wantsChangeToRight (MSAbstractLaneChangeModel::MSLCMessager &msgPass, int blocked, const std::pair< MSVehicle *, SUMOReal > &leader, const std::pair< MSVehicle *, SUMOReal > &neighLead, const std::pair< MSVehicle *, SUMOReal > &neighFollow, const MSLane &neighLane, const std::vector< MSVehicle::LaneQ > &preb, MSVehicle **lastBlocked, MSVehicle **firstBlocked)
 Called to examine whether the vehicle wants to change to right This method gets the information about the surrounding vehicles and whether another lane may be more preferable. More...
 

Protected Attributes

bool myAlreadyMoved
 whether the vehicle has already moved this step More...
 
const MSCFModelmyCarFollowModel
 The vehicle's car following model. More...
 
SUMOReal myChangeProbability
 
bool myDontBrake
 
bool myHaveShadow
 Wether a vehicle shadow exists. More...
 
SUMOReal myLaneChangeCompletion
 progress of the lane change maneuver 0:started, 1:complete More...
 
int myLaneChangeDirection
 direction of the lane change maneuver -1 means right, 1 means left More...
 
bool myLaneChangeMidpointPassed
 whether myLane has already been set to the target of the lane-change maneuver More...
 
SUMOReal myLeadingBlockerLength
 
SUMOReal myLeftSpace
 
std::vector< MSLane * > myNoPartiallyOccupatedByShadow
 
int myOwnState
 The current state of the vehicle. More...
 
std::vector< MSLane * > myPartiallyOccupatedByShadow
 list of lanes where the shadow vehicle is partial occupator More...
 
MSLanemyShadowLane
 The lane the vehicle shadow is on during a continuous lane change. More...
 
MSVehiclemyVehicle
 The vehicle this lane-changer belongs to. More...
 
std::vector< SUMORealmyVSafes
 

Static Protected Attributes

static bool myAllowOvertakingRight
 whether overtaking on the right is permitted More...
 

Detailed Description

A lane change model developed by D. Krajzewicz between 2004 and 2010.

Definition at line 47 of file MSLCM_DK2008.h.

Member Typedef Documentation

typedef std::pair<SUMOReal, int> MSLCM_DK2008::Info
protected

Definition at line 153 of file MSLCM_DK2008.h.

Member Enumeration Documentation

Enumerator
LCA_AMBLOCKINGLEADER 
LCA_AMBLOCKINGFOLLOWER 
LCA_MRIGHT 
LCA_MLEFT 
LCA_AMBLOCKINGFOLLOWER_DONTBRAKE 
LCA_AMBACKBLOCKER 
LCA_AMBACKBLOCKER_STANDING 

Definition at line 50 of file MSLCM_DK2008.h.

Constructor & Destructor Documentation

MSLCM_DK2008::MSLCM_DK2008 ( MSVehicle v)

Definition at line 66 of file MSLCM_DK2008.cpp.

MSLCM_DK2008::~MSLCM_DK2008 ( )
virtual

Definition at line 71 of file MSLCM_DK2008.cpp.

References changed().

Member Function Documentation

bool MSAbstractLaneChangeModel::alreadyMoved ( ) const
inlineinherited

reset the flag whether a vehicle already moved to false

Definition at line 293 of file MSAbstractLaneChangeModel.h.

References MSAbstractLaneChangeModel::myAlreadyMoved.

Referenced by MSLane::executeMovements().

bool MSLCM_DK2008::amBlockingFollower ( )
inlineprotected
bool MSLCM_DK2008::amBlockingFollowerNB ( )
inlineprotected
bool MSLCM_DK2008::amBlockingFollowerPlusNB ( )
inlineprotected
bool MSLCM_DK2008::amBlockingLeader ( )
inlineprotected

Definition at line 134 of file MSLCM_DK2008.h.

References LCA_AMBLOCKINGLEADER, and MSAbstractLaneChangeModel::myOwnState.

MSAbstractLaneChangeModel * MSAbstractLaneChangeModel::build ( LaneChangeModel  lcm,
MSVehicle vehicle 
)
staticinherited

Factory method for instantiating new lane changing models.

Parameters
[in]lcmThe type of model to build
[in]vehicleThe vehicle for which this model shall be built

Definition at line 60 of file MSAbstractLaneChangeModel.cpp.

References LCM_DK2008, LCM_JE2013, LCM_LC2013, and toString().

Referenced by MSVehicle::MSVehicle().

bool MSAbstractLaneChangeModel::cancelRequest ( int  state)
protectedinherited
bool MSAbstractLaneChangeModel::congested ( const MSVehicle *const  neighLeader)
protectedvirtualinherited
bool MSLCM_DK2008::currentDistAllows ( SUMOReal  dist,
int  laneOffset,
SUMOReal  lookForwardDist 
)
inlineprotected

Definition at line 149 of file MSLCM_DK2008.h.

References abs.

Referenced by wantsChangeToLeft(), and wantsChangeToRight().

bool MSLCM_DK2008::currentDistDisallows ( SUMOReal  dist,
int  laneOffset,
SUMOReal  lookForwardDist 
)
inlineprotected

Definition at line 146 of file MSLCM_DK2008.h.

References abs.

Referenced by wantsChangeToLeft(), and wantsChangeToRight().

SUMOReal MSAbstractLaneChangeModel::getLaneChangeCompletion ( ) const
inlineinherited

return whether the vehicle passed the midpoint of a continuous lane change maneuver

Definition at line 273 of file MSAbstractLaneChangeModel.h.

References MSAbstractLaneChangeModel::myLaneChangeCompletion.

Referenced by MSVehicle::getAngle(), and MSVehicle::getPosition().

int MSAbstractLaneChangeModel::getLaneChangeDirection ( ) const
inlineinherited

return the direction of the current lane change maneuver

Definition at line 288 of file MSAbstractLaneChangeModel.h.

References MSAbstractLaneChangeModel::myLaneChangeDirection.

Referenced by MSVehicle::getAngle().

SUMOTime MSAbstractLaneChangeModel::getLastLaneChangeOffset ( ) const
inlineinherited
int MSAbstractLaneChangeModel::getOwnState ( ) const
inlineinherited
MSLane* MSAbstractLaneChangeModel::getShadowLane ( ) const
inlineinherited
MSLane * MSAbstractLaneChangeModel::getShadowLane ( const MSLane lane) const
inherited
bool MSAbstractLaneChangeModel::hasShadowVehicle ( ) const
inlineinherited

return true if the vehicle currently has a shadow vehicle

Definition at line 283 of file MSAbstractLaneChangeModel.h.

References MSAbstractLaneChangeModel::myHaveShadow.

Referenced by MSLane::executeMovements().

void * MSLCM_DK2008::inform ( void *  info,
MSVehicle sender 
)
virtual

Implements MSAbstractLaneChangeModel.

Definition at line 610 of file MSLCM_DK2008.cpp.

References MSAbstractLaneChangeModel::myOwnState.

void MSAbstractLaneChangeModel::initGlobalOptions ( const OptionsCont oc)
staticinherited

init global model parameters

Definition at line 54 of file MSAbstractLaneChangeModel.cpp.

References OptionsCont::getBool(), and MSAbstractLaneChangeModel::myAllowOvertakingRight.

Referenced by MSFrame::setMSGlobals().

void MSAbstractLaneChangeModel::initLastLaneChangeOffset ( int  dir)
protectedinherited
bool MSAbstractLaneChangeModel::isChangingLanes ( ) const
inlineinherited
bool MSAbstractLaneChangeModel::isLaneChangeMidpointPassed ( ) const
inlineinherited

return whether the vehicle passed the midpoint of a continuous lane change maneuver

Definition at line 268 of file MSAbstractLaneChangeModel.h.

References MSAbstractLaneChangeModel::myLaneChangeMidpointPassed.

Referenced by MSVehicle::getAngle(), and MSVehicle::planMoveInternal().

SUMOReal MSLCM_DK2008::patchSpeed ( const SUMOReal  min,
const SUMOReal  wanted,
const SUMOReal  max,
const MSCFModel cfModel 
)
virtual
void MSLCM_DK2008::prepareStep ( )
virtual
void MSAbstractLaneChangeModel::removeLaneChangeShadow ( const MSMoveReminder::Notification  reason,
bool  notify = true 
)
inherited
virtual void MSAbstractLaneChangeModel::saveBlockerLength ( SUMOReal  length)
inlinevirtualinherited

reserve space at the end of the lane to avoid dead locks

Reimplemented in MSLCM_LC2013, and MSLCM_JE2013.

Definition at line 319 of file MSAbstractLaneChangeModel.h.

References UNUSED_PARAMETER.

Referenced by MSLCM_JE2013::saveBlockerLength(), and MSLCM_LC2013::saveBlockerLength().

void MSAbstractLaneChangeModel::setOwnState ( int  state)
inlineinherited

Definition at line 204 of file MSAbstractLaneChangeModel.h.

References MSAbstractLaneChangeModel::myOwnState.

Referenced by MSLaneChanger::change().

void MSAbstractLaneChangeModel::setShadowPartialOccupator ( MSLane lane)
inlineinherited
void MSAbstractLaneChangeModel::unchanged ( )
inlineinherited
int MSLCM_DK2008::wantsChange ( int  laneOffset,
MSAbstractLaneChangeModel::MSLCMessager msgPass,
int  blocked,
const std::pair< MSVehicle *, SUMOReal > &  leader,
const std::pair< MSVehicle *, SUMOReal > &  neighLead,
const std::pair< MSVehicle *, SUMOReal > &  neighFollow,
const MSLane neighLane,
const std::vector< MSVehicle::LaneQ > &  preb,
MSVehicle **  lastBlocked,
MSVehicle **  firstBlocked 
)
virtual

Called to examine whether the vehicle wants to change using the given laneOffset. This method gets the information about the surrounding vehicles and whether another lane may be more preferable.

Implements MSAbstractLaneChangeModel.

Definition at line 76 of file MSLCM_DK2008.cpp.

References UNUSED_PARAMETER, wantsChangeToLeft(), and wantsChangeToRight().

int MSLCM_DK2008::wantsChangeToLeft ( MSAbstractLaneChangeModel::MSLCMessager msgPass,
int  blocked,
const std::pair< MSVehicle *, SUMOReal > &  leader,
const std::pair< MSVehicle *, SUMOReal > &  neighLead,
const std::pair< MSVehicle *, SUMOReal > &  neighFollow,
const MSLane neighLane,
const std::vector< MSVehicle::LaneQ > &  preb,
MSVehicle **  lastBlocked,
MSVehicle **  firstBlocked 
)
protectedvirtual

Called to examine whether the vehicle wants to change to left This method gets the information about the surrounding vehicles and whether another lane may be more preferable.

!!

Definition at line 307 of file MSLCM_DK2008.cpp.

References ACCEL2SPEED, amBlockingFollowerPlusNB(), MSVehicle::LaneQ::bestLaneOffset, bla, MSAbstractLaneChangeModel::congested(), currentDistAllows(), currentDistDisallows(), MSEdge::EDGEFUNCTION_INTERNAL, MSCFModel::followSpeed(), gDebugSelectedVehicle, MSVehicle::getCarFollowModel(), MSLane::getEdge(), MSBaseVehicle::getID(), MSVehicle::getLane(), MSLane::getLength(), MSVehicleType::getLengthWithGap(), MSLane::getLinkCont(), MSCFModel::getMaxDecel(), MSVehicleType::getMaxSpeed(), MSVehicleType::getMinGap(), MSVehicle::getPositionOnLane(), MSEdge::getPurpose(), MSVehicle::getSpeed(), MSLane::getVehicleMaxSpeed(), MSBaseVehicle::getVehicleType(), informBlocker(), JAM_FACTOR2, MSVehicle::LaneQ::lane, LCA_AMBACKBLOCKER, LCA_AMBACKBLOCKER_STANDING, LCA_AMBLOCKINGFOLLOWER_DONTBRAKE, LCA_BLOCKED, LCA_COOPERATIVE, LCA_LEFT, LCA_MLEFT, LCA_RIGHT, LCA_SPEEDGAIN, LCA_STAY, LCA_STRATEGIC, LCA_URGENT, MSVehicle::LaneQ::length, LOOK_FORWARD_FAR, LOOK_FORWARD_NEAR, LOOK_FORWARD_SPEED_DIVIDER, MAX2(), MIN2(), MSAbstractLaneChangeModel::myCarFollowModel, myChangeProbability, myDontBrake, myLeadingBlockerLength, myLeftSpace, MSAbstractLaneChangeModel::myOwnState, MSAbstractLaneChangeModel::myVehicle, myVSafes, MSVehicle::LaneQ::occupation, MSAbstractLaneChangeModel::predInteraction(), SUMO_const_haltingSpeed, SUMOReal, TS, and UNUSED_PARAMETER.

Referenced by wantsChange().

int MSLCM_DK2008::wantsChangeToRight ( MSAbstractLaneChangeModel::MSLCMessager msgPass,
int  blocked,
const std::pair< MSVehicle *, SUMOReal > &  leader,
const std::pair< MSVehicle *, SUMOReal > &  neighLead,
const std::pair< MSVehicle *, SUMOReal > &  neighFollow,
const MSLane neighLane,
const std::vector< MSVehicle::LaneQ > &  preb,
MSVehicle **  lastBlocked,
MSVehicle **  firstBlocked 
)
protectedvirtual

Called to examine whether the vehicle wants to change to right This method gets the information about the surrounding vehicles and whether another lane may be more preferable.

!!

Definition at line 95 of file MSLCM_DK2008.cpp.

References ACCEL2SPEED, amBlockingFollowerPlusNB(), MSVehicle::LaneQ::bestLaneOffset, bla, MSAbstractLaneChangeModel::congested(), currentDistAllows(), currentDistDisallows(), MSEdge::EDGEFUNCTION_INTERNAL, MSCFModel::followSpeed(), gDebugSelectedVehicle, MSVehicle::getCarFollowModel(), MSLane::getEdge(), MSBaseVehicle::getID(), MSVehicle::getLane(), MSLane::getLength(), MSVehicleType::getLengthWithGap(), MSLane::getLinkCont(), MSCFModel::getMaxDecel(), MSVehicleType::getMaxSpeed(), MSVehicleType::getMinGap(), MSVehicle::getPositionOnLane(), MSEdge::getPurpose(), MSVehicle::getSpeed(), MSLane::getSpeedLimit(), MSLane::getVehicleMaxSpeed(), MSBaseVehicle::getVehicleType(), informBlocker(), JAM_FACTOR2, MSVehicle::LaneQ::lane, LCA_AMBACKBLOCKER, LCA_AMBACKBLOCKER_STANDING, LCA_AMBLOCKINGFOLLOWER_DONTBRAKE, LCA_BLOCKED, LCA_COOPERATIVE, LCA_LEFT, LCA_MRIGHT, LCA_RIGHT, LCA_SPEEDGAIN, LCA_STAY, LCA_STRATEGIC, LCA_URGENT, MSVehicle::LaneQ::length, LOOK_FORWARD_FAR, LOOK_FORWARD_NEAR, LOOK_FORWARD_SPEED_DIVIDER, MAX2(), MIN2(), MSAbstractLaneChangeModel::myCarFollowModel, myChangeProbability, myDontBrake, myLeadingBlockerLength, myLeftSpace, MSAbstractLaneChangeModel::myOwnState, MSAbstractLaneChangeModel::myVehicle, myVSafes, MSVehicle::LaneQ::occupation, MSAbstractLaneChangeModel::predInteraction(), SUMO_const_haltingSpeed, SUMOReal, TS, and UNUSED_PARAMETER.

Referenced by wantsChange().

Field Documentation

bool MSAbstractLaneChangeModel::myAllowOvertakingRight
staticprotectedinherited
bool MSAbstractLaneChangeModel::myAlreadyMoved
protectedinherited
SUMOReal MSLCM_DK2008::myChangeProbability
protected

Definition at line 158 of file MSLCM_DK2008.h.

Referenced by changed(), prepareStep(), wantsChangeToLeft(), and wantsChangeToRight().

bool MSLCM_DK2008::myDontBrake
protected
int MSAbstractLaneChangeModel::myLaneChangeDirection
protectedinherited
bool MSAbstractLaneChangeModel::myLaneChangeMidpointPassed
protectedinherited
SUMOReal MSLCM_DK2008::myLeadingBlockerLength
protected
SUMOReal MSLCM_DK2008::myLeftSpace
protected
std::vector<MSLane*> MSAbstractLaneChangeModel::myNoPartiallyOccupatedByShadow
protectedinherited
std::vector<MSLane*> MSAbstractLaneChangeModel::myPartiallyOccupatedByShadow
protectedinherited
std::vector<SUMOReal> MSLCM_DK2008::myVSafes
protected

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