SUMO - Simulation of Urban MObility
MSE3Collector::MSE3LeaveReminder Class Reference

A place on the road net (at a certain lane and position on it) where the E3 area ends. More...

#include <MSE3Collector.h>

Inheritance diagram for MSE3Collector::MSE3LeaveReminder:
MSMoveReminder

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.
 MSE3LeaveReminder (const MSCrossSection &crossSection, MSE3Collector &collector)
 Constructor.
virtual void notifyMoveInternal (SUMOVehicle &veh, SUMOReal timeOnLane, SUMOReal speed)
 Internal notification about the vehicle moves.
methods from MSMoveReminder
bool notifyMove (SUMOVehicle &veh, SUMOReal, SUMOReal newPos, SUMOReal)
 Checks whether the vehicle leaves.
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 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

 MSE3LeaveReminder (const MSE3LeaveReminder &)
 Invalidated copy constructor.
MSE3LeaveReminderoperator= (const MSE3LeaveReminder &)
 Invalidated assignment operator.

Private Attributes

MSE3CollectormyCollector
 The parent collector.
SUMOReal myPosition
 The position on the lane.

Detailed Description

A place on the road net (at a certain lane and position on it) where the E3 area ends.

Definition at line 138 of file MSE3Collector.h.


Member Enumeration Documentation

enum MSMoveReminder::Notification [inherited]

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

Constructor.

Parameters:
[in]crossSectionThe position at which the exit lies
[in]collectorThe detector the exit belongs to

Definition at line 89 of file MSE3Collector.cpp.

Invalidated copy constructor.


Member Function Documentation

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

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, inherited]

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.

bool MSE3Collector::MSE3LeaveReminder::notifyMove ( SUMOVehicle veh,
SUMOReal  oldPos,
SUMOReal  newPos,
SUMOReal  newSpeed 
) [virtual]

Checks whether the vehicle leaves.

As soon as the reported vehicle leaves the detector area (position-length>myPosition) the leaving time is computed and both are made known to the parent detector using "leave".

Parameters:
[in]vehThe vehicle in question.
[in]oldPosPosition before the move-micro-timestep.
[in]newPosPosition after the move-micro-timestep.
[in]newSpeedUnused here.
Returns:
False, if vehicle passed the detector entierly, else true.
See also:
MSMoveReminder
MSMoveReminder::notifyMove
MSE3Collector::leave

Reimplemented from MSMoveReminder.

Definition at line 96 of file MSE3Collector.cpp.

References MSNet::getInstance(), STEPS2TIME, and SUMOReal.

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

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.

MSE3LeaveReminder& MSE3Collector::MSE3LeaveReminder::operator= ( const MSE3LeaveReminder ) [private]

Invalidated assignment operator.


Field Documentation

The parent collector.

Definition at line 172 of file MSE3Collector.h.

MSLane* const MSMoveReminder::myLane [protected, inherited]

The position on the lane.

Definition at line 175 of file MSE3Collector.h.


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