Eclipse SUMO - Simulation of Urban MObility
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_TELEPORT , NOTIFICATION_PARKING , NOTIFICATION_PARKING_REROUTE , NOTIFICATION_ARRIVED ,
  NOTIFICATION_TELEPORT_ARRIVED , NOTIFICATION_VAPORIZED_CALIBRATOR , NOTIFICATION_VAPORIZED_COLLISION , NOTIFICATION_VAPORIZED_TRACI ,
  NOTIFICATION_VAPORIZED_GUI , NOTIFICATION_VAPORIZED_VAPORIZER
}
 Definition of a vehicle state. More...
 

Public Member Functions

const std::string & getDescription () const
 
const MSLanegetLane () const
 Returns the lane the reminder works on. More...
 
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. More...
 
 PassedTracker (MSLane *lane)
 
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. More...
 
virtual bool notifyIdle (SUMOTrafficObject &veh)
 Computes idling emission values and adds them to the emission sums. More...
 
virtual bool notifyLeave (SUMOTrafficObject &veh, double lastPos, Notification reason, const MSLane *enteredLane=0)
 Called if the vehicle leaves the reminder's lane. More...
 
void updateDetector (SUMOTrafficObject &veh, double entryPos, double leavePos, SUMOTime entryTime, SUMOTime currentTime, SUMOTime leaveTime, bool cleanUp)
 

Protected Member Functions

void removeFromVehicleUpdateValues (SUMOTrafficObject &veh)
 

Protected Attributes

std::string myDescription
 a description of this moveReminder More...
 
MSLane *const myLane
 Lane on which the reminder works. More...
 

Private Attributes

std::map< SUMOTrafficObject *, std::pair< SUMOTime, double > > myLastVehicleUpdateValues
 

inherited from MSMoveReminder

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

Detailed Description

Definition at line 94 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_TELEPORT 

The vehicle is being teleported.

NOTIFICATION_PARKING 

The vehicle starts or ends parking.

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.

Definition at line 89 of file MSMoveReminder.h.

Constructor & Destructor Documentation

◆ PassedTracker()

MSRailSignalConstraint_Predecessor::PassedTracker::PassedTracker ( MSLane lane)

Definition at line 176 of file MSRailSignalConstraint.cpp.

Member Function Documentation

◆ clearState()

void MSRailSignalConstraint_Predecessor::PassedTracker::clearState ( )

Clear all passed states before quick-loading state.

Definition at line 227 of file MSRailSignalConstraint.cpp.

◆ getDescription()

const std::string& MSMoveReminder::getDescription ( ) const
inlineinherited

Definition at line 249 of file MSMoveReminder.h.

References MSMoveReminder::myDescription.

◆ getLane()

const MSLane* MSMoveReminder::getLane ( ) const
inlineinherited

◆ hasPassed()

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

Definition at line 207 of file MSRailSignalConstraint.cpp.

◆ 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 249 of file MSRailSignalConstraint.cpp.

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 183 of file MSRailSignalConstraint.cpp.

References Named::getID(), SUMOTrafficObject::getParameter(), Parameterised::getParameter(), 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 MSMeanData_Emissions::MSLaneMeanDataValues, MSDevice_Tripinfo, and MSDevice_Emissions.

Definition at line 177 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

◆ notifyLeave()

virtual bool MSMoveReminder::notifyLeave ( SUMOTrafficObject veh,
double  lastPos,
Notification  reason,
const MSLane enteredLane = 0 
)
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 MSDevice_Vehroutes, MSDevice_BTsender, MSDevice_BTreceiver, MSTriggeredRerouter, MSMeanData_Net::MSLaneMeanDataValues, MSMeanData::MeanDataValueTracker, MSMeanData::MeanDataValues, MSInstantInductLoop, MSInductLoop, MSE3Collector::MSE3LeaveReminder, MSE3Collector::MSE3EntryReminder, MSE2Collector, MSDevice_Tripinfo, MSDevice_Transportable, MSDevice_Taxi, MSDevice_SSM, MSDevice_Example, MSDevice_Bluelight, and MSDevice_ElecHybrid.

Definition at line 195 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 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::MSE3EntryReminder, MSE3Collector::MSE3LeaveReminder, MSDevice_ToC, MSTriggeredRerouter, MSMeanData::MeanDataValues, MSInstantInductLoop, MSInductLoop, MSE2Collector, MSDevice_Tripinfo, MSDevice_Transportable, MSDevice_Taxi, MSDevice_SSM, MSDevice_Example, MSDevice_Emissions, MSDevice_BTsender, MSDevice_BTreceiver, MSDevice_Bluelight, MSDevice_Battery, and MSDevice_ElecHybrid.

Definition at line 157 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

◆ 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 it's 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 MSMeanData_Emissions::MSLaneMeanDataValues, MSMeanData_Amitran::MSLaneMeanDataValues, MSMeanData_Harmonoise::MSLaneMeanDataValues, MSMeanData_Net::MSLaneMeanDataValues, MSDevice_Tripinfo, MSDevice_Transportable, MSMeanData::MeanDataValueTracker, MSDevice_Emissions, and MSDevice_ElecHybrid.

Definition at line 227 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

Referenced by MSMoveReminder::updateDetector().

Here is the caller graph for this function:

◆ raiseLimit()

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

Definition at line 195 of file MSRailSignalConstraint.cpp.

Referenced by MSRailSignalConstraint_Predecessor::MSRailSignalConstraint_Predecessor().

Here is the caller graph for this function:

◆ removeFromVehicleUpdateValues()

void MSMoveReminder::removeFromVehicleUpdateValues ( SUMOTrafficObject veh)
protectedinherited

Definition at line 89 of file MSMoveReminder.cpp.

References MSMoveReminder::myLastVehicleUpdateValues.

Referenced by MSMoveReminder::updateDetector().

Here is the caller graph for this function:

◆ saveState()

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

◆ setDescription()

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

Definition at line 245 of file MSMoveReminder.h.

References MSMoveReminder::myDescription.

Referenced by MSMeanData::init(), MEInductLoop::MEInductLoop(), METriggeredCalibrator::METriggeredCalibrator(), 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 47 of file MSMoveReminder.cpp.

References MSMoveReminder::myLastVehicleUpdateValues, MSMoveReminder::notifyMoveInternal(), MSMoveReminder::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 261 of file MSMoveReminder.h.

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

◆ myLane

◆ myLastIndex

int MSRailSignalConstraint_Predecessor::PassedTracker::myLastIndex

index of the last passed object

Definition at line 121 of file MSRailSignalConstraint.h.

◆ myLastVehicleUpdateValues

std::map<SUMOTrafficObject*, std::pair<SUMOTime, double> > MSMoveReminder::myLastVehicleUpdateValues
privateinherited

◆ myPassed

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

passed tripIds

Definition at line 118 of file MSRailSignalConstraint.h.


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