SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MSE3Collector::MSE3EntryReminder Class Reference

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

#include <MSE3Collector.h>

Inheritance diagram for MSE3Collector::MSE3EntryReminder:
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.
 MSE3EntryReminder (const MSCrossSection &crossSection, MSE3Collector &collector)
 Constructor.
virtual void notifyMoveInternal (SUMOVehicle &veh, SUMOReal timeOnLane, SUMOReal speed)
 Internal notification about the vehicle moves.
Methods inherited from MSMoveReminder.
bool notifyMove (SUMOVehicle &veh, SUMOReal, SUMOReal newPos, SUMOReal)
 Checks whether the vehicle enters.
bool notifyLeave (SUMOVehicle &veh, SUMOReal lastPos, MSMoveReminder::Notification reason)
 Processes state changes of a vehicle.
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.

Protected Attributes

MSLane *const myLane
 Lane on which the reminder works.

Private Member Functions

 MSE3EntryReminder (const MSE3EntryReminder &)
 Invalidated copy constructor.
MSE3EntryReminderoperator= (const MSE3EntryReminder &)
 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 begins.

Definition at line 70 of file MSE3Collector.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

MSE3Collector::MSE3EntryReminder::MSE3EntryReminder ( const MSCrossSection crossSection,
MSE3Collector collector 
)

Constructor.

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

Definition at line 51 of file MSE3Collector.cpp.

MSE3Collector::MSE3EntryReminder::MSE3EntryReminder ( const MSE3EntryReminder )
private

Invalidated copy constructor.

Member Function Documentation

virtual bool MSMoveReminder::notifyEnter ( SUMOVehicle veh,
Notification  reason 
)
inlinevirtualinherited

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, MSCalibrator::VehicleRemover, MSMeanData_Harmonoise::MSLaneMeanDataValues, MSMeanData::MeanDataValues, MSRouteProbe, MSDevice_Person, MSDevice_Tripinfo, and MSDevice_Vehroutes.

Definition at line 128 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

bool MSE3Collector::MSE3EntryReminder::notifyLeave ( SUMOVehicle veh,
SUMOReal  lastPos,
MSMoveReminder::Notification  reason 
)
virtual

Processes state changes of a vehicle.

If the reported vehicle is known, and the reason indicates a removal from the network (permanent or temporary), the vehicle is removed from the list of vehicles to regard.

Parameters
[in]vehThe leaving vehicle.
[in]lastPosPosition on the lane when leaving.
[in]reasonThe reason for the state change
See Also
MSMoveReminder::notifyLeave

Reimplemented from MSMoveReminder.

Definition at line 79 of file MSE3Collector.cpp.

References MSMoveReminder::NOTIFICATION_ARRIVED.

bool MSE3Collector::MSE3EntryReminder::notifyMove ( SUMOVehicle veh,
SUMOReal  oldPos,
SUMOReal  newPos,
SUMOReal  newSpeed 
)
virtual

Checks whether the vehicle enters.

As soon as the reported vehicle enters the detector area (position>myPosition) the entering time is computed and both are added to the parent detector using "enter".

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::enter

Reimplemented from MSMoveReminder.

Definition at line 58 of file MSE3Collector.cpp.

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

virtual void MSMoveReminder::notifyMoveInternal ( SUMOVehicle veh,
SUMOReal  timeOnLane,
SUMOReal  speed 
)
inlinevirtualinherited

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.

MSE3EntryReminder& MSE3Collector::MSE3EntryReminder::operator= ( const MSE3EntryReminder )
private

Invalidated assignment operator.

Field Documentation

MSE3Collector& MSE3Collector::MSE3EntryReminder::myCollector
private

The parent collector.

Definition at line 117 of file MSE3Collector.h.

MSLane* const MSMoveReminder::myLane
protectedinherited
SUMOReal MSE3Collector::MSE3EntryReminder::myPosition
private

The position on the lane.

Definition at line 120 of file MSE3Collector.h.


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