MSCalibrator::VehicleRemover Class Reference

#include <MSCalibrator.h>

Inheritance diagram for MSCalibrator::VehicleRemover:

Collaboration diagram for MSCalibrator::VehicleRemover:

Public Types
enum	Notification {   NOTIFICATION_DEPARTED , NOTIFICATION_JUNCTION , NOTIFICATION_SEGMENT , NOTIFICATION_LANE_CHANGE ,   NOTIFICATION_LOAD_STATE , NOTIFICATION_TELEPORT , NOTIFICATION_TELEPORT_CONTINUATION , 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 ,   NOTIFICATION_VAPORIZED_BREAKDOWN , NOTIFICATION_NONE }
	Definition of a vehicle state. More...

Public Member Functions
const std::string &	getDescription () const
const MSLane *	getLane () const
	Returns the lane the reminder works on.
virtual bool	isParkingRerouter () const
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.
void	setDescription (const std::string &description)
	VehicleRemover (MSLane *const lane, MSCalibrator *const parent, const bool undo=false)
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	notifyLeaveBack (SUMOTrafficObject &veh, Notification reason, const MSLane *leftLane)
	Called if the vehicle's back leaves the reminder's lane.
void	updateDetector (SUMOTrafficObject &veh, double entryPos, double leavePos, SUMOTime entryTime, SUMOTime currentTime, SUMOTime leaveTime, bool cleanUp)

Static Public Attributes
static StringBijection< Notification >	Notifications

Protected Member Functions
void	removeFromVehicleUpdateValues (SUMOTrafficObject &veh)

Protected Attributes
std::string	myDescription
	a description of this moveReminder
MSLane *	myLane
	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
MSCalibrator *	myParent
const bool	myUndoCalibration
virtual bool	notifyEnter (SUMOTrafficObject &veh, MSMoveReminder::Notification reason, const MSLane *enteredLane=nullptr)
	Checks whether the reminder is activated by a vehicle entering the lane.
virtual bool	notifyLeave (SUMOTrafficObject &veh, double lastPos, Notification reason, const MSLane *enteredLane=nullptr)
	Checks whether any calibrations need to be undone.
void	disable ()

Detailed Description

Definition at line 192 of file MSCalibrator.h.

Member Enumeration Documentation

Notification

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_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_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 90 of file MSMoveReminder.h.

Constructor & Destructor Documentation

VehicleRemover()

MSCalibrator::VehicleRemover::VehicleRemover ( MSLane *const  lane, MSCalibrator *const  parent, const bool  undo = false  )

inline

Definition at line 194 of file MSCalibrator.h.

Member Function Documentation

disable()

void MSCalibrator::VehicleRemover::disable ( )

inline

Definition at line 223 of file MSCalibrator.h.

References myParent.

getDescription()

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

inlineinherited

Definition at line 283 of file MSMoveReminder.h.

References MSMoveReminder::myDescription.

Referenced by MSDriveWay::notifyEnter(), MSDriveWay::notifyLeave(), and MSDriveWay::notifyLeaveBack().

Here is the caller graph for this function:

getLane()

const MSLane * MSMoveReminder::getLane ( ) const

inlineinherited

Returns the lane the reminder works on.

Returns

The lane the reminder is anchored on.

Definition at line 84 of file MSMoveReminder.h.

References MSMoveReminder::myLane.

Referenced by LIBSUMO_NAMESPACE::InductionLoop::getTree(), GUIInductLoop::MyWrapper::MyWrapper(), GUIInstantInductLoop::MyWrapper::MyWrapper(), MSDevice_Tripinfo::notifyEnter(), MSDevice_Tripinfo::notifyLeave(), LIBSUMO_NAMESPACE::InductionLoop::storeShape(), and MSMeanData::writeEdge().

Here is the caller graph for this function:

isParkingRerouter()

virtual bool MSMoveReminder::isParkingRerouter ( ) const

inlinevirtualinherited

Reimplemented in MSTriggeredRerouter.

Definition at line 288 of file MSMoveReminder.h.

notifyEnter()

bool MSCalibrator::VehicleRemover::notifyEnter ( SUMOTrafficObject &  veh, MSMoveReminder::Notification  reason, const MSLane *  enteredLane = nullptr  )

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]	veh	The entering vehicle.
[in]	reason	how the vehicle enters the lane

Returns

True if vehicle enters the reminder.

See also

Notification

Reimplemented from MSMoveReminder.

Definition at line 602 of file MSCalibrator.cpp.

References DEBUGCOND2, DEFAULT_VTYPE_ID, Named::getID(), MSNet::getInstance(), SUMOTrafficObject::getParameter(), RandomDistributor< T >::getVals(), MSNet::getVehicleControl(), SUMOTrafficObject::getVehicleType(), MSVehicleControl::getVType(), MSVehicleControl::getVTypeDistribution(), MSCalibrator::isActive(), MSCalibrator::myClearedInJam, MSCalibrator::myCurrentStateInterval, MSCalibrator::myHaveInvalidJam, MSCalibrator::myHaveWarnedAboutClearingJam, myParent, MSCalibrator::myRemoved, MSCalibrator::passed(), SUMOTrafficObject::replaceVehicleType(), MSCalibrator::scheduleRemoval(), SIMSTEP, time2string(), TL, MSCalibrator::totalWished(), MSCalibrator::updateMeanData(), MSDetectorFileOutput::vehicleApplies(), SUMOVehicleParameter::vtypeid, and WRITE_WARNINGF.

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]

veh

The vehicle

See also

MSMoveReminder::notifyMove

PollutantsInterface

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

Definition at line 186 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

notifyLeave()

bool MSCalibrator::VehicleRemover::notifyLeave ( SUMOTrafficObject &  veh, double  lastPos, Notification  reason, const MSLane *  enteredLane = nullptr  )

virtual

Checks whether any calibrations need to be undone.

Parameters

[in]	veh	The leaving vehicle.
[in]	lastPos	Position on the lane when leaving.
[in]	reason	how the vehicle leaves the lane

See also

Notification

Returns

True if the reminder wants to receive further info.

Reimplemented from MSMoveReminder.

Definition at line 665 of file MSCalibrator.cpp.

References MSNet::getInstance(), SUMOTrafficObject::getParameter(), SUMOTrafficObject::replaceVehicleType(), and SUMOVehicleParameter::vtypeid.

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]	veh	The leaving vehicle.
[in]	reason	how the vehicle leaves the lane
[in]	leftLane	The 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 231 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]	veh	Vehicle that asks this reminder.
[in]	oldPos	Position before move.
[in]	newPos	Position after move with newSpeed.
[in]	newSpeed	Moving speed.

Returns

True if vehicle hasn't passed the reminder completely.

Reimplemented in MSDevice_ElecHybrid, MSDevice_Bluelight, MSVehicleDevice_BTreceiver, MSTransportableDevice_BTreceiver, MSVehicleDevice_BTsender, MSTransportableDevice_BTsender, MSDevice_Emissions, MSDevice_Example, MSDevice_Friction, MSDevice_GLOSA, MSDevice_SSM, MSDevice_Taxi, MSDevice_Transportable, MSDevice_Tripinfo, MSE2Collector, MSInductLoop, MSInstantInductLoop, MSMeanData::MeanDataValues, MSTriggeredRerouter, MSDevice_Battery, MSDevice_StationFinder, MSDevice_ToC, MSE3Collector::MSE3LeaveReminder, and MSE3Collector::MSE3EntryReminder.

Definition at line 166 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]	veh	Vehicle that asks this reminder.
[in]	frontOnLane	time the front of the vehicle spent on the lane.
[in]	timeOnLane	time some part of the vehicle spent on the lane.
[in]	meanSpeedFrontOnLane	Average speed for the time that the front is on the lane.
[in]	meanSpeedVehicleOnLane	Average speed for the time that the vehicle is on the lane (with front or back).
[in]	travelledDistanceFrontOnLane	distance travelled while overlapping with the lane.
[in]	travelledDistanceVehicleOnLane	distance travelled while front was on the lane.
[in]	meanLengthOnLane	the 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_Taxi, MSDevice_Transportable, MSDevice_Tripinfo, MSMeanData::MeanDataValueTracker, MSDevice_StationFinder, MSMeanData_Net::MSLaneMeanDataValues, MSMeanData_Harmonoise::MSLaneMeanDataValues, MSMeanData_Amitran::MSLaneMeanDataValues, and MSMeanData_Emissions::MSLaneMeanDataValues.

Definition at line 261 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

Referenced by MSMoveReminder::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 192 of file MSMoveReminder.h.

notifyStopEnded()

virtual void MSMoveReminder::notifyStopEnded ( )

inlinevirtualinherited

called to update state for stopped vehicles

Reimplemented in MSDevice_Routing, and MSDevice_Vehroutes.

Definition at line 195 of file MSMoveReminder.h.

removeFromVehicleUpdateValues()

void MSMoveReminder::removeFromVehicleUpdateValues ( SUMOTrafficObject &  veh )

protectedinherited

Definition at line 112 of file MSMoveReminder.cpp.

References SUMOTrafficObject::getNumericalID(), and MSMoveReminder::myLastVehicleUpdateValues.

Referenced by MSMoveReminder::updateDetector().

Here is the caller graph for this function:

setDescription()

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

inlineinherited

Definition at line 279 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 70 of file MSMoveReminder.cpp.

References SUMOTrafficObject::getNumericalID(), 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 302 of file MSMoveReminder.h.

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

myLane

MSLane* MSMoveReminder::myLane

protectedinherited

Lane on which the reminder works.

Definition at line 300 of file MSMoveReminder.h.

Referenced by MSDriveWay::buildRoute(), MSDriveWay::buildSubFoe(), MSE2Collector::detectorUpdate(), MSInductLoop::detectorUpdate(), MSE2Collector::getEstimatedCurrentVehicleNumber(), MSMoveReminder::getLane(), MSMoveReminder::MSMoveReminder(), MSE2Collector::notifyEnter(), MSDriveWay::notifyEnter(), MSInductLoop::notifyEnter(), MSE2Collector::notifyLeave(), and MSE2Collector::notifyMove().

myLastVehicleUpdateValues

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

privateinherited

Definition at line 310 of file MSMoveReminder.h.

Referenced by MSMoveReminder::removeFromVehicleUpdateValues(), and MSMoveReminder::updateDetector().

myParent

MSCalibrator* MSCalibrator::VehicleRemover::myParent

private

Definition at line 228 of file MSCalibrator.h.

Referenced by disable(), and notifyEnter().

myUndoCalibration

const bool MSCalibrator::VehicleRemover::myUndoCalibration

private

Definition at line 229 of file MSCalibrator.h.

Notifications

StringBijection< MSMoveReminder::Notification > MSMoveReminder::Notifications

staticinherited

Definition at line 292 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},
    {"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},
    {"vaporizer",              NOTIFICATION_VAPORIZED_VAPORIZER},
    {"vaporizedBreakdown",     NOTIFICATION_VAPORIZED_BREAKDOWN},
    {"none",                   NOTIFICATION_NONE}
}

Definition at line 28 of file MSMoveReminder.h.

---

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

• MSCalibrator.h
• MSCalibrator.cpp