SUMO - Simulation of Urban MObility
MSMoveReminder Class Reference

Something on a lane to be noticed about vehicle movement. More...

#include <MSMoveReminder.h>

Inheritance diagram for MSMoveReminder:
MSDevice MSE2Collector MSE3Collector::MSE3EntryReminder MSE3Collector::MSE3LeaveReminder MSInductLoop MSInstantInductLoop MSMeanData::MeanDataValues MSRouteProbe MSTriggeredRerouter

Public Types

enum  Notification {
  NOTIFICATION_DEPARTED, NOTIFICATION_JUNCTION, NOTIFICATION_SEGMENT, NOTIFICATION_LANE_CHANGE,
  NOTIFICATION_TELEPORT, NOTIFICATION_PARKING, NOTIFICATION_ARRIVED, NOTIFICATION_VAPORIZED,
  NOTIFICATION_TELEPORT_ARRIVED
}
 Definition of a vehicle state. More...

Public Member Functions

const MSLanegetLane () const
 Returns the lane the reminder works on.
 MSMoveReminder (MSLane *const lane=0, const bool doAdd=true)
 Constructor.
virtual void notifyMoveInternal (SUMOVehicle &veh, SUMOReal timeOnLane, SUMOReal speed)
 Internal notification about the vehicle moves.
virtual ~MSMoveReminder ()
 Destructor.
Interface methods, to be derived by subclasses
virtual bool notifyEnter (SUMOVehicle &veh, Notification reason)
 Checks whether the reminder is activated by a vehicle entering the lane.
virtual bool notifyMove (SUMOVehicle &veh, SUMOReal oldPos, SUMOReal newPos, SUMOReal newSpeed)
 Checks whether the reminder still has to be notified about the vehicle moves.
virtual bool notifyLeave (SUMOVehicle &veh, SUMOReal lastPos, Notification reason)
 Called if the vehicle leaves the reminder's lane.

Protected Attributes

MSLane *const myLane
 Lane on which the reminder works.

Private Member Functions

MSMoveReminderoperator= (const MSMoveReminder &)

Detailed Description

Something on a lane to be noticed about vehicle movement.

Base class of all move-reminders. During move, the vehicles call notifyMove() for all reminders on their current lane (all lanes they pass during one step). If a vehicle enters the lane the reminder is positioned at during insertion or lanechange notifyEnter() is called. If a vehicle leaves the reminder lane it calls notifyLeave().

The reminder knows whom to tell about move, insertion and lanechange. The vehicles will remove the reminder that is not notifyMove() from their reminder container.

See also:
MSLane::addMoveReminder
MSLane::getMoveReminder

Definition at line 68 of file MSMoveReminder.h.


Member Enumeration Documentation

Definition of a vehicle state.

Enumerator:
NOTIFICATION_DEPARTED 

The vehicle has departed (was inserted into the network)

NOTIFICATION_JUNCTION 

The vehicle arrived at a junction.

NOTIFICATION_SEGMENT 

The vehicle changes the segment (meso only)

NOTIFICATION_LANE_CHANGE 

The vehicle changes lanes (micro only)

NOTIFICATION_TELEPORT 

The vehicle is being teleported.

NOTIFICATION_PARKING 

The vehicle starts or ends parking.

NOTIFICATION_ARRIVED 

The vehicle arrived at its destination (is deleted)

NOTIFICATION_VAPORIZED 

The vehicle got vaporized.

NOTIFICATION_TELEPORT_ARRIVED 

The vehicle was teleported out of the net.

Definition at line 93 of file MSMoveReminder.h.


Constructor & Destructor Documentation

MSMoveReminder::MSMoveReminder ( MSLane *const  lane = 0,
const bool  doAdd = true 
)

Constructor.

Parameters:
[in]laneLane on which the reminder will work.
[in]doAddwhether to add the reminder to the lane

Definition at line 40 of file MSMoveReminder.cpp.

References MSLane::addMoveReminder(), and myLane.

virtual MSMoveReminder::~MSMoveReminder ( ) [inline, virtual]

Destructor.

Definition at line 80 of file MSMoveReminder.h.


Member Function Documentation

virtual bool MSMoveReminder::notifyEnter ( SUMOVehicle veh,
Notification  reason 
) [inline, virtual]

Checks whether the reminder is activated by a vehicle entering the lane.

Lane change means in this case that the vehicle changes to the lane the reminder is placed at.

Parameters:
[in]vehThe entering vehicle.
[in]reasonhow the vehicle enters the lane
Returns:
True if vehicle enters the reminder.
See also:
Notification

Reimplemented in MSMeanData::MeanDataValueTracker, MSE2Collector, MSInductLoop, MSInstantInductLoop, MSMeanData_Net::MSLaneMeanDataValues, MSDevice_Routing, MSTriggeredRerouter, MSMeanData_Harmonoise::MSLaneMeanDataValues, MSMeanData::MeanDataValues, MSRouteProbe, MSDevice_Person, MSDevice_Tripinfo, and MSDevice_Vehroutes.

Definition at line 128 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

virtual bool MSMoveReminder::notifyLeave ( SUMOVehicle veh,
SUMOReal  lastPos,
Notification  reason 
) [inline, virtual]

Called if the vehicle leaves the reminder's lane.

Informs if vehicle leaves reminder lane (due to lane change, removal from the network, or leaving to the next lane). The default is to do nothing.

Parameters:
[in]vehThe leaving vehicle.
[in]lastPosPosition on the lane when leaving.
[in]reasonhow the vehicle leaves the lane
See also:
Notification
Returns:
True if the reminder wants to receive further info.

Reimplemented in MSMeanData::MeanDataValueTracker, MSE2Collector, MSInductLoop, MSMeanData::MeanDataValues, MSInstantInductLoop, MSE3Collector::MSE3EntryReminder, MSMeanData_Net::MSLaneMeanDataValues, MSDevice_Person, MSDevice_Tripinfo, and MSDevice_Vehroutes.

Definition at line 173 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

virtual bool MSMoveReminder::notifyMove ( SUMOVehicle veh,
SUMOReal  oldPos,
SUMOReal  newPos,
SUMOReal  newSpeed 
) [inline, virtual]

Checks whether the reminder still has to be notified about the vehicle moves.

Indicator if the reminders is still active for the passed vehicle/parameters. If false, the vehicle will erase this reminder from it's reminder-container.

Parameters:
[in]vehVehicle that asks this reminder.
[in]oldPosPosition before move.
[in]newPosPosition after move with newSpeed.
[in]newSpeedMoving speed.
Returns:
True if vehicle hasn't passed the reminder completely.

Reimplemented in MSE3Collector::MSE3LeaveReminder, MSE2Collector, MSInductLoop, MSMeanData::MeanDataValues, MSDevice_HBEFA, MSE3Collector::MSE3EntryReminder, MSInstantInductLoop, MSDevice_Person, and MSDevice_Tripinfo.

Definition at line 148 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

virtual void MSMoveReminder::notifyMoveInternal ( SUMOVehicle veh,
SUMOReal  timeOnLane,
SUMOReal  speed 
) [inline, virtual]

Internal notification about the vehicle moves.

Indicator if the reminders is still active for the passed vehicle/parameters. If false, the vehicle will erase this reminder from it's reminder-container.

Parameters:
[in]vehVehicle that asks this reminder.
[in]timeOnLanetime the vehicle spent on the lane.
[in]speedMoving speed.

Reimplemented in MSMeanData::MeanDataValueTracker, MSMeanData_Net::MSLaneMeanDataValues, MSMeanData_Harmonoise::MSLaneMeanDataValues, and MSMeanData_HBEFA::MSLaneMeanDataValues.

Definition at line 200 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

MSMoveReminder& MSMoveReminder::operator= ( const MSMoveReminder ) [private]

Field Documentation

MSLane* const MSMoveReminder::myLane [protected]

Lane on which the reminder works.

Definition at line 215 of file MSMoveReminder.h.

Referenced by MSE2Collector::detectorUpdate(), getLane(), MSE2Collector::MSE2Collector(), and MSMoveReminder().


The documentation for this class was generated from the following files:
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Defines