SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
MSAbstractLaneChangeModel::MSLCMessager Class Reference

A class responsible for exchanging messages between cars involved in lane-change interaction. More...

#include <MSAbstractLaneChangeModel.h>

Public Member Functions

void * informLeader (void *info, MSVehicle *sender)
 Informs the leader on the same lane. More...
 
void * informNeighFollower (void *info, MSVehicle *sender)
 Informs the follower on the desired lane. More...
 
void * informNeighLeader (void *info, MSVehicle *sender)
 Informs the leader on the desired lane. More...
 
 MSLCMessager (MSVehicle *leader, MSVehicle *neighLead, MSVehicle *neighFollow)
 Constructor. More...
 
 ~MSLCMessager ()
 Destructor. More...
 

Private Attributes

MSVehiclemyLeader
 The leader on the informed vehicle's lane. More...
 
MSVehiclemyNeighFollower
 The follower on the lane the vehicle want to change to. More...
 
MSVehiclemyNeighLeader
 The leader on the lane the vehicle want to change to. More...
 

Detailed Description

A class responsible for exchanging messages between cars involved in lane-change interaction.

Definition at line 120 of file MSAbstractLaneChangeModel.h.

Constructor & Destructor Documentation

MSAbstractLaneChangeModel::MSLCMessager::MSLCMessager ( MSVehicle leader,
MSVehicle neighLead,
MSVehicle neighFollow 
)
inline

Constructor.

Parameters
[in]leaderThe leader on the informed vehicle's lane
[in]neighLeadThe leader on the lane the vehicle want to change to
[in]neighFollowThe follower on the lane the vehicle want to change to

Definition at line 127 of file MSAbstractLaneChangeModel.h.

MSAbstractLaneChangeModel::MSLCMessager::~MSLCMessager ( )
inline

Destructor.

Definition at line 133 of file MSAbstractLaneChangeModel.h.

Member Function Documentation

void* MSAbstractLaneChangeModel::MSLCMessager::informLeader ( void *  info,
MSVehicle sender 
)
inline

Informs the leader on the same lane.

Parameters
[in]infoThe information to pass
[in]senderThe sending vehicle (the lane changing vehicle)
Returns
Something!?

Definition at line 141 of file MSAbstractLaneChangeModel.h.

References MSVehicle::getLaneChangeModel(), MSAbstractLaneChangeModel::inform(), and myLeader.

void* MSAbstractLaneChangeModel::MSLCMessager::informNeighFollower ( void *  info,
MSVehicle sender 
)
inline

Informs the follower on the desired lane.

Parameters
[in]infoThe information to pass
[in]senderThe sending vehicle (the lane changing vehicle)
Returns
Something!?

Definition at line 163 of file MSAbstractLaneChangeModel.h.

References MSVehicle::getLaneChangeModel(), MSAbstractLaneChangeModel::inform(), and myNeighFollower.

Referenced by MSLCM_DK2008::informBlocker(), MSLCM_JE2013::informFollower(), and MSLCM_LC2013::informFollower().

void* MSAbstractLaneChangeModel::MSLCMessager::informNeighLeader ( void *  info,
MSVehicle sender 
)
inline

Informs the leader on the desired lane.

Parameters
[in]infoThe information to pass
[in]senderThe sending vehicle (the lane changing vehicle)
Returns
Something!?

Definition at line 152 of file MSAbstractLaneChangeModel.h.

References MSVehicle::getLaneChangeModel(), MSAbstractLaneChangeModel::inform(), and myNeighLeader.

Referenced by MSLCM_DK2008::informBlocker(), MSLCM_JE2013::informLeader(), and MSLCM_LC2013::informLeader().

Field Documentation

MSVehicle* MSAbstractLaneChangeModel::MSLCMessager::myLeader
private

The leader on the informed vehicle's lane.

Definition at line 171 of file MSAbstractLaneChangeModel.h.

Referenced by informLeader().

MSVehicle* MSAbstractLaneChangeModel::MSLCMessager::myNeighFollower
private

The follower on the lane the vehicle want to change to.

Definition at line 175 of file MSAbstractLaneChangeModel.h.

Referenced by informNeighFollower().

MSVehicle* MSAbstractLaneChangeModel::MSLCMessager::myNeighLeader
private

The leader on the lane the vehicle want to change to.

Definition at line 173 of file MSAbstractLaneChangeModel.h.

Referenced by informNeighLeader().


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