Eclipse SUMO - Simulation of Urban MObility
Loading...
Searching...
No Matches
MSRailSignalConstraint_Predecessor::PassedTracker Class Reference

#include <MSRailSignalConstraint.h>

Inheritance diagram for MSRailSignalConstraint_Predecessor::PassedTracker:
[legend]
Collaboration diagram for MSRailSignalConstraint_Predecessor::PassedTracker:
[legend]

Public Types

enum  Notification {
  NOTIFICATION_DEPARTED , NOTIFICATION_JUNCTION , NOTIFICATION_SEGMENT , NOTIFICATION_LANE_CHANGE ,
  NOTIFICATION_LOAD_STATE , NOTIFICATION_TELEPORT , NOTIFICATION_TELEPORT_CONTINUATION , NOTIFICATION_PARKING ,
  NOTIFICATION_REROUTE , NOTIFICATION_PARKING_REROUTE , NOTIFICATION_ARRIVED , NOTIFICATION_TELEPORT_ARRIVED ,
  NOTIFICATION_VAPORIZED_CALIBRATOR , NOTIFICATION_VAPORIZED_COLLISION , NOTIFICATION_VAPORIZED_TRACI , NOTIFICATION_VAPORIZED_GUI ,
  NOTIFICATION_VAPORIZED_VAPORIZER , NOTIFICATION_VAPORIZED_BREAKDOWN , NOTIFICATION_NONE
}
 Definition of a vehicle state. More...

Public Member Functions

const std::string & getDescription () const
const MSLanegetLane () const
 Returns the lane the reminder works on.
virtual bool isParkingRerouter () const
void loadReminderState (long long int numID, SUMOTime time, double pos)
virtual void notifyMoveInternal (const SUMOTrafficObject &veh, const double frontOnLane, const double timeOnLane, const double meanSpeedFrontOnLane, const double meanSpeedVehicleOnLane, const double travelledDistanceFrontOnLane, const double travelledDistanceVehicleOnLane, const double meanLengthOnLane)
 Internal notification about the vehicle moves.
 PassedTracker (MSLane *lane)
void saveReminderState (OutputDevice &out, const SUMOTrafficObject &veh)
 Saves the current state into the given stream.
void setDescription (const std::string &description)
Interface methods, to be derived by subclasses
virtual bool notifyMove (SUMOTrafficObject &veh, double oldPos, double newPos, double newSpeed)
 Checks whether the reminder still has to be notified about the vehicle moves.
virtual bool notifyIdle (SUMOTrafficObject &veh)
 Computes idling emission values and adds them to the emission sums.
virtual void notifyParking ()
 called to update state for parking vehicles
virtual void notifyStopEnded ()
 called to update state for stopped vehicles
virtual bool notifyLeave (SUMOTrafficObject &veh, double lastPos, Notification reason, const MSLane *enteredLane=nullptr)
 Called if the vehicle leaves the reminder's lane.
virtual bool notifyLeaveBack (SUMOTrafficObject &veh, Notification reason, const MSLane *leftLane)
 Called if the vehicle's back leaves the reminder's lane.
virtual bool notifyReroute (SUMOTrafficObject &veh)
 Called if the vehicle change it's route.
void updateDetector (SUMOTrafficObject &veh, double entryPos, double leavePos, SUMOTime entryTime, SUMOTime currentTime, SUMOTime leaveTime, bool cleanUp)

Static Public Attributes

static StringBijection< NotificationNotifications

Protected Member Functions

void removeFromVehicleUpdateValues (SUMOTrafficObject &veh)

Protected Attributes

std::string myDescription
 a description of this moveReminder
MSLanemyLane
 Lane on which the reminder works.

Private Attributes

std::map< long long int, std::pair< SUMOTime, double > > myLastVehicleUpdateValues

Static Private Attributes

static StringBijection< Notification >::Entry NotificationValues []

inherited from MSMoveReminder

std::vector< std::string > myPassed
 passed tripIds
int myLastIndex
 index of the last passed object
bool notifyEnter (SUMOTrafficObject &veh, MSMoveReminder::Notification reason, const MSLane *enteredLane=0)
 tracks vehicles that passed this link (entered the next lane)
void raiseLimit (int limit)
bool hasPassed (const std::string &tripId, int limit) const
void clearState ()
 Clear all passed states before quick-loading state.
void saveState (OutputDevice &out)
 Saves the current passed states into the given stream.
void loadState (int index, const std::vector< std::string > &tripIDs)
 loads the current passed states into the given stream

Detailed Description

Definition at line 172 of file MSRailSignalConstraint.h.

Member Enumeration Documentation

◆ Notification

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_LOAD_STATE 

The vehicle has been loaded from a state file.

NOTIFICATION_TELEPORT 

The vehicle is being teleported.

NOTIFICATION_TELEPORT_CONTINUATION 

The vehicle continues being teleported past an edge.

NOTIFICATION_PARKING 

The vehicle starts or ends parking.

NOTIFICATION_REROUTE 

The vehicle changed it's route.

NOTIFICATION_PARKING_REROUTE 

The vehicle needs another parking area.

NOTIFICATION_ARRIVED 

The vehicle arrived at its destination (is deleted).

NOTIFICATION_TELEPORT_ARRIVED 

The vehicle was teleported out of the net.

NOTIFICATION_VAPORIZED_CALIBRATOR 

The vehicle got removed by a calibrator.

NOTIFICATION_VAPORIZED_COLLISION 

The vehicle got removed by a collision.

NOTIFICATION_VAPORIZED_TRACI 

The vehicle got removed via TraCI.

NOTIFICATION_VAPORIZED_GUI 

The vehicle got removed via the GUI.

NOTIFICATION_VAPORIZED_VAPORIZER 

The vehicle got vaporized with a vaporizer.

NOTIFICATION_VAPORIZED_BREAKDOWN 

The vehicle got removed via stationfinder device.

NOTIFICATION_NONE 

must be the last one

Definition at line 91 of file MSMoveReminder.h.

Constructor & Destructor Documentation

◆ PassedTracker()

MSRailSignalConstraint_Predecessor::PassedTracker::PassedTracker ( MSLane * lane)

Member Function Documentation

◆ clearState()

void MSRailSignalConstraint_Predecessor::PassedTracker::clearState ( )

Clear all passed states before quick-loading state.

Definition at line 287 of file MSRailSignalConstraint.cpp.

References myLastIndex, and myPassed.

◆ getDescription()

◆ getLane()

◆ hasPassed()

bool MSRailSignalConstraint_Predecessor::PassedTracker::hasPassed ( const std::string & tripId,
int limit ) const

Definition at line 267 of file MSRailSignalConstraint.cpp.

References myLastIndex, and myPassed.

◆ isParkingRerouter()

virtual bool MSMoveReminder::isParkingRerouter ( ) const
inlinevirtualinherited

Reimplemented in MSTriggeredRerouter.

Definition at line 300 of file MSMoveReminder.h.

◆ loadReminderState()

void MSMoveReminder::loadReminderState ( long long int numID,
SUMOTime time,
double pos )
inherited

Definition at line 125 of file MSMoveReminder.cpp.

References myLastVehicleUpdateValues.

◆ loadState()

void MSRailSignalConstraint_Predecessor::PassedTracker::loadState ( int index,
const std::vector< std::string > & tripIDs )

loads the current passed states into the given stream

Definition at line 309 of file MSRailSignalConstraint.cpp.

References MSMoveReminder::myLane, myLastIndex, myPassed, and raiseLimit().

Referenced by MSRailSignalConstraint_Predecessor::loadState().

Here is the caller graph for this function:

◆ notifyEnter()

bool MSRailSignalConstraint_Predecessor::PassedTracker::notifyEnter ( SUMOTrafficObject & veh,
MSMoveReminder::Notification reason,
const MSLane * enteredLane = 0 )
virtual

tracks vehicles that passed this link (entered the next lane)

Reimplemented from MSMoveReminder.

Definition at line 243 of file MSRailSignalConstraint.cpp.

References Named::getID(), Parameterised::getParameter(), SUMOTrafficObject::getParameter(), MSMoveReminder::myLane, myLastIndex, myPassed, and SIMTIME.

◆ notifyIdle()

virtual bool MSMoveReminder::notifyIdle ( SUMOTrafficObject & veh)
inlinevirtualinherited

Computes idling emission values and adds them to the emission sums.

Idling implied by zero velocity, acceleration and slope

Parameters
[in]vehThe vehicle
See also
MSMoveReminder::notifyMove
PollutantsInterface

Reimplemented in MSDevice_Emissions, MSDevice_StationFinder, MSDevice_Tripinfo, and MSMeanData_Emissions::MSLaneMeanDataValues.

Definition at line 189 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

◆ notifyLeave()

virtual bool MSMoveReminder::notifyLeave ( SUMOTrafficObject & veh,
double lastPos,
Notification reason,
const MSLane * enteredLane = nullptr )
inlinevirtualinherited

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 MSCalibrator::VehicleRemover, MSDevice_Bluelight, MSDevice_ElecHybrid, MSDevice_Example, MSDevice_SSM, MSDevice_Transportable, MSDevice_Tripinfo, MSDevice_Vehroutes, MSDriveWay, MSE2Collector, MSE3Collector::MSE3EntryReminder, MSE3Collector::MSE3LeaveReminder, MSInductLoop, MSInstantInductLoop, MSMeanData::MeanDataValues, MSMeanData::MeanDataValueTracker, MSMeanData_Net::MSLaneMeanDataValues, MSTransportableDevice_BTreceiver, MSTransportableDevice_BTsender, MSTriggeredRerouter, MSVehicleDevice_BTreceiver, and MSVehicleDevice_BTsender.

Definition at line 213 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

◆ notifyLeaveBack()

virtual bool MSMoveReminder::notifyLeaveBack ( SUMOTrafficObject & veh,
Notification reason,
const MSLane * leftLane )
inlinevirtualinherited

Called if the vehicle's back leaves the reminder's lane.

Informs if vehicle back 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]reasonhow the vehicle leaves the lane
[in]leftLaneThe lane that the vehicle's back left
See also
Notification
Returns
True if the reminder wants to receive further info.

Reimplemented in MSDriveWay.

Definition at line 234 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

◆ notifyMove()

virtual bool MSMoveReminder::notifyMove ( SUMOTrafficObject & veh,
double oldPos,
double newPos,
double newSpeed )
inlinevirtualinherited

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 its 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 MSDevice_Battery, MSDevice_Bluelight, MSDevice_ElecHybrid, MSDevice_Emissions, MSDevice_Example, MSDevice_Friction, MSDevice_GLOSA, MSDevice_SSM, MSDevice_StationFinder, MSDevice_Taxi, MSDevice_ToC, MSDevice_Transportable, MSDevice_Tripinfo, MSE2Collector, MSE3Collector::MSE3EntryReminder, MSE3Collector::MSE3LeaveReminder, MSInductLoop, MSInstantInductLoop, MSMeanData::MeanDataValues, MSTransportableDevice_BTreceiver, MSTransportableDevice_BTsender, MSTriggeredRerouter, MSVehicleDevice_BTreceiver, and MSVehicleDevice_BTsender.

Definition at line 169 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

Referenced by MSE3Collector::notifyMovePerson().

Here is the caller graph for this function:

◆ notifyMoveInternal()

virtual void MSMoveReminder::notifyMoveInternal ( const SUMOTrafficObject & veh,
const double frontOnLane,
const double timeOnLane,
const double meanSpeedFrontOnLane,
const double meanSpeedVehicleOnLane,
const double travelledDistanceFrontOnLane,
const double travelledDistanceVehicleOnLane,
const double meanLengthOnLane )
inlinevirtualinherited

Internal notification about the vehicle moves.

Note
meso uses this though it never calls notifyMove()

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

Parameters
[in]vehVehicle that asks this reminder.
[in]frontOnLanetime the front of the vehicle spent on the lane.
[in]timeOnLanetime some part of the vehicle spent on the lane.
[in]meanSpeedFrontOnLaneAverage speed for the time that the front is on the lane.
[in]meanSpeedVehicleOnLaneAverage speed for the time that the vehicle is on the lane (with front or back).
[in]travelledDistanceFrontOnLanedistance travelled while overlapping with the lane.
[in]travelledDistanceVehicleOnLanedistance travelled while front was on the lane.
[in]meanLengthOnLanethe average length of the vehicle's part on the lane during the last step (==complete length in meso case)

Reimplemented in MSDevice_ElecHybrid, MSDevice_Emissions, MSDevice_StationFinder, MSDevice_Taxi, MSDevice_Transportable, MSDevice_Tripinfo, MSMeanData::MeanDataValueTracker, MSMeanData_Amitran::MSLaneMeanDataValues, MSMeanData_Emissions::MSLaneMeanDataValues, MSMeanData_Harmonoise::MSLaneMeanDataValues, and MSMeanData_Net::MSLaneMeanDataValues.

Definition at line 273 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

Referenced by MSMeanData::MeanDataValues::notifyMove(), and updateDetector().

Here is the caller graph for this function:

◆ notifyParking()

virtual void MSMoveReminder::notifyParking ( )
inlinevirtualinherited

called to update state for parking vehicles

Reimplemented in MSDevice_Battery.

Definition at line 195 of file MSMoveReminder.h.

◆ notifyReroute()

virtual bool MSMoveReminder::notifyReroute ( SUMOTrafficObject & veh)
inlinevirtualinherited

Called if the vehicle change it's route.

Parameters
[in]vehThe rerouted vehicle.
Returns
True if the reminder wants to receive further info.

Reimplemented in MSDriveWay.

Definition at line 245 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

◆ notifyStopEnded()

virtual void MSMoveReminder::notifyStopEnded ( )
inlinevirtualinherited

called to update state for stopped vehicles

Reimplemented in MSDevice_Routing, and MSDevice_Vehroutes.

Definition at line 198 of file MSMoveReminder.h.

◆ raiseLimit()

void MSRailSignalConstraint_Predecessor::PassedTracker::raiseLimit ( int limit)

Definition at line 255 of file MSRailSignalConstraint.cpp.

References MSMoveReminder::myLane, myLastIndex, and myPassed.

Referenced by loadState().

Here is the caller graph for this function:

◆ removeFromVehicleUpdateValues()

void MSMoveReminder::removeFromVehicleUpdateValues ( SUMOTrafficObject & veh)
protectedinherited

Definition at line 131 of file MSMoveReminder.cpp.

References SUMOTrafficObject::getNumericalID(), and myLastVehicleUpdateValues.

Referenced by MSMeanData_Net::MSLaneMeanDataValues::notifyLeave(), and updateDetector().

Here is the caller graph for this function:

◆ saveReminderState()

void MSMoveReminder::saveReminderState ( OutputDevice & out,
const SUMOTrafficObject & veh )
inherited

◆ saveState()

void MSRailSignalConstraint_Predecessor::PassedTracker::saveState ( OutputDevice & out)

◆ setDescription()

void MSMoveReminder::setDescription ( const std::string & description)
inlineinherited

Definition at line 291 of file MSMoveReminder.h.

References myDescription.

Referenced by MSMeanData::init(), and MSCalibrator::MSCalibrator().

Here is the caller graph for this function:

◆ updateDetector()

void MSMoveReminder::updateDetector ( SUMOTrafficObject & veh,
double entryPos,
double leavePos,
SUMOTime entryTime,
SUMOTime currentTime,
SUMOTime leaveTime,
bool cleanUp )
inherited

Definition at line 71 of file MSMoveReminder.cpp.

References SUMOTrafficObject::getNumericalID(), myLastVehicleUpdateValues, notifyMoveInternal(), removeFromVehicleUpdateValues(), and STEPS2TIME.

Referenced by MEVehicle::updateDetectorForWriting().

Here is the caller graph for this function:

Field Documentation

◆ myDescription

std::string MSMoveReminder::myDescription
protectedinherited

a description of this moveReminder

Definition at line 319 of file MSMoveReminder.h.

Referenced by getDescription(), MSMoveReminder(), and setDescription().

◆ myLane

◆ myLastIndex

int MSRailSignalConstraint_Predecessor::PassedTracker::myLastIndex

index of the last passed object

Definition at line 199 of file MSRailSignalConstraint.h.

Referenced by clearState(), hasPassed(), loadState(), notifyEnter(), PassedTracker(), raiseLimit(), and saveState().

◆ myLastVehicleUpdateValues

std::map<long long int, std::pair<SUMOTime, double> > MSMoveReminder::myLastVehicleUpdateValues
privateinherited

◆ myPassed

std::vector<std::string> MSRailSignalConstraint_Predecessor::PassedTracker::myPassed

passed tripIds

Definition at line 196 of file MSRailSignalConstraint.h.

Referenced by clearState(), hasPassed(), loadState(), notifyEnter(), PassedTracker(), raiseLimit(), and saveState().

◆ Notifications

StringBijection< MSMoveReminder::Notification > MSMoveReminder::Notifications
staticinherited

Definition at line 309 of file MSMoveReminder.h.

Referenced by MSDriveWay::writeBlockVehicles().

◆ NotificationValues

StringBijection< MSMoveReminder::Notification >::Entry MSMoveReminder::NotificationValues
staticprivateinherited
Initial value:
= {
{"departed", NOTIFICATION_DEPARTED},
{"junction", NOTIFICATION_JUNCTION},
{"segment", NOTIFICATION_SEGMENT},
{"laneChange", NOTIFICATION_LANE_CHANGE},
{"loadState", NOTIFICATION_LOAD_STATE},
{"teleport", NOTIFICATION_TELEPORT},
{"teleportContinuation", NOTIFICATION_TELEPORT_CONTINUATION},
{"parking", NOTIFICATION_PARKING},
{"reroute", NOTIFICATION_REROUTE},
{"parkingReroute", NOTIFICATION_PARKING_REROUTE},
{"arrived", NOTIFICATION_ARRIVED},
{"teleportArrived", NOTIFICATION_TELEPORT_ARRIVED},
{"vaporizedCalibrator", NOTIFICATION_VAPORIZED_CALIBRATOR},
{"vaporizedCollision", NOTIFICATION_VAPORIZED_COLLISION},
{"vaporizedTraCI", NOTIFICATION_VAPORIZED_TRACI},
{"vaporizedGUI", NOTIFICATION_VAPORIZED_GUI},
{"vaporizedBreakdown", NOTIFICATION_VAPORIZED_BREAKDOWN},
}
@ NOTIFICATION_VAPORIZED_TRACI
The vehicle got removed via TraCI.
@ NOTIFICATION_ARRIVED
The vehicle arrived at its destination (is deleted).
@ NOTIFICATION_TELEPORT_ARRIVED
The vehicle was teleported out of the net.
@ NOTIFICATION_PARKING_REROUTE
The vehicle needs another parking area.
@ NOTIFICATION_VAPORIZED_CALIBRATOR
The vehicle got removed by a calibrator.
@ NOTIFICATION_VAPORIZED_GUI
The vehicle got removed via the GUI.
@ NOTIFICATION_DEPARTED
The vehicle has departed (was inserted into the network).
@ NOTIFICATION_REROUTE
The vehicle changed it's route.
@ NOTIFICATION_SEGMENT
The vehicle changes the segment (meso only).
@ NOTIFICATION_LANE_CHANGE
The vehicle changes lanes (micro only).
@ NOTIFICATION_VAPORIZED_VAPORIZER
The vehicle got vaporized with a vaporizer.
@ NOTIFICATION_JUNCTION
The vehicle arrived at a junction.
@ NOTIFICATION_VAPORIZED_BREAKDOWN
The vehicle got removed via stationfinder device.
@ NOTIFICATION_PARKING
The vehicle starts or ends parking.
@ NOTIFICATION_VAPORIZED_COLLISION
The vehicle got removed by a collision.
@ NOTIFICATION_LOAD_STATE
The vehicle has been loaded from a state file.
@ NOTIFICATION_TELEPORT
The vehicle is being teleported.
@ NOTIFICATION_NONE
must be the last one
@ NOTIFICATION_TELEPORT_CONTINUATION
The vehicle continues being teleported past an edge.

Definition at line 28 of file MSMoveReminder.h.


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