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:

Collaboration diagram for MSE3Collector::MSE3LeaveReminder:

Public Member Functions
const std::string &	getDescription () const

const MSLane *	getLane () const
	Returns the lane the reminder works on. More...

virtual bool	isParkingRerouter () const

	MSE3LeaveReminder (const MSCrossSection &crossSection, MSE3Collector &collector)
	Constructor. 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...

void	setDescription (const std::string &description)

Interface methods, to be derived by subclasses
virtual bool	notifyIdle (SUMOTrafficObject &veh)
	Computes idling emission values and adds them to the emission sums. More...

virtual void	notifyParking ()
	called to update state for parking vehicles More...

virtual void	notifyStopEnded ()
	called to update state for stopped vehicles 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

methods from MSMoveReminder
MSE3Collector &	myCollector
	The parent collector. More...

double	myPosition
	The position on the lane. More...

bool	notifyEnter (SUMOTrafficObject &veh, Notification reason, const MSLane *enteredLane)
	Checks whether the reminder is activated by a vehicle entering the lane. More...

bool	notifyMove (SUMOTrafficObject &veh, double oldPos, double newPos, double)
	Checks whether the vehicle leaves. More...

bool	notifyLeave (SUMOTrafficObject &veh, double lastPos, MSMoveReminder::Notification reason, const MSLane *enteredLane=0)
	Processes state changes of a vehicle. More...

double	getPosition () const

	MSE3LeaveReminder (const MSE3LeaveReminder &)
	Invalidated copy constructor. More...

MSE3LeaveReminder &	operator= (const MSE3LeaveReminder &)
	Invalidated assignment operator. More...

Detailed Description

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

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

Definition at line 89 of file MSMoveReminder.h.

Constructor & Destructor Documentation

◆ MSE3LeaveReminder() [1/2]

MSE3Collector::MSE3LeaveReminder::MSE3LeaveReminder	(	const MSCrossSection &	crossSection,
		MSE3Collector &	collector
	)

Constructor.

Parameters

[in]	crossSection	The position at which the exit lies
[in]	collector	The detector the exit belongs to

Definition at line 173 of file MSE3Collector.cpp.

◆ MSE3LeaveReminder() [2/2]

MSE3Collector::MSE3LeaveReminder::MSE3LeaveReminder ( const MSE3LeaveReminder & )

private

Invalidated copy constructor.

Member Function Documentation

◆ getDescription()

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

inlineinherited

Definition at line 261 of file MSMoveReminder.h.

References MSMoveReminder::myDescription.

◆ 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 83 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:

◆ getPosition()

double MSE3Collector::MSE3LeaveReminder::getPosition ( ) const

inline

Definition at line 200 of file MSE3Collector.h.

References myPosition.

◆ isParkingRerouter()

virtual bool MSMoveReminder::isParkingRerouter ( ) const

inlinevirtualinherited

Reimplemented in MSTriggeredRerouter.

Definition at line 266 of file MSMoveReminder.h.

◆ notifyEnter()

bool MSE3Collector::MSE3LeaveReminder::notifyEnter	(	SUMOTrafficObject &	veh,
		Notification	reason,
		const MSLane *	enteredLane
	)

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 180 of file MSE3Collector.cpp.

References DEBUG_COND, SUMOTrafficObject::getBackPositionOnLane(), Named::getID(), 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] veh The vehicle

See also: MSMoveReminder::notifyMove; PollutantsInterface

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

Definition at line 183 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

◆ notifyLeave()

bool MSE3Collector::MSE3LeaveReminder::notifyLeave	(	SUMOTrafficObject &	veh,
		double	lastPos,
		MSMoveReminder::Notification	reason,
		const MSLane *	enteredLane = `0`
	)

virtual

Processes state changes of a vehicle.

Checks whether the vehicle has changed lanes and this reminder needs to be removed

Parameters

[in]	veh	The leaving vehicle (unused).
[in]	lastPos	Position on the lane when leaving (unused).
[in]	reason	The reason for the state change

See also: MSMoveReminder::notifyLeave

Reimplemented from MSMoveReminder.

Definition at line 263 of file MSE3Collector.cpp.

References DEBUG_COND, MSLane::getEdge(), Named::getID(), MSGlobals::gNumSimThreads, MSMoveReminder::NOTIFICATION_ARRIVED, MSMoveReminder::NOTIFICATION_LANE_CHANGE, MSMoveReminder::NOTIFICATION_TELEPORT, SIMSTEP, SIMTIME, SUMO_TAG_E3DETECTOR, time2string(), toString(), and WRITE_WARNINGF.

◆ notifyMove()

bool MSE3Collector::MSE3LeaveReminder::notifyMove	(	SUMOTrafficObject &	veh,
		double	oldPos,
		double	newPos,
		double	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]	veh	The vehicle in question.
[in]	oldPos	Position before the move-micro-timestep.
[in]	newPos	Position after the move-micro-timestep.
[in]	newSpeed	Unused here.

Returns: False, if vehicle passed the detector entirely, else true.

See also: MSMoveReminder; MSMoveReminder::notifyMove; MSE3Collector::leave

Reimplemented from MSMoveReminder.

Definition at line 210 of file MSE3Collector.cpp.

References DEBUG_COND, Named::getID(), MSVehicleType::getLength(), SUMOTrafficObject::getPreviousSpeed(), SUMOTrafficObject::getVehicleType(), MSGlobals::gNumSimThreads, MSGlobals::gSemiImplicitEulerUpdate, MSCFModel::passingTime(), SIMTIME, and TS.

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

Definition at line 239 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 189 of file MSMoveReminder.h.

◆ notifyStopEnded()

virtual void MSMoveReminder::notifyStopEnded ( )

inlinevirtualinherited

called to update state for stopped vehicles

Reimplemented in MSDevice_Vehroutes, and MSDevice_Routing.

Definition at line 192 of file MSMoveReminder.h.

◆ operator=()

MSE3LeaveReminder& MSE3Collector::MSE3LeaveReminder::operator= ( const MSE3LeaveReminder & )

private

Invalidated assignment operator.

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

◆ setDescription()

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

inlineinherited

Definition at line 257 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

◆ myCollector

MSE3Collector& MSE3Collector::MSE3LeaveReminder::myCollector

private

The parent collector.

Definition at line 207 of file MSE3Collector.h.

◆ myDescription

std::string MSMoveReminder::myDescription

protectedinherited

a description of this moveReminder

Definition at line 278 of file MSMoveReminder.h.

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

◆ myLane

MSLane* const MSMoveReminder::myLane

protectedinherited

Lane on which the reminder works.

Definition at line 276 of file MSMoveReminder.h.

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

◆ myLastVehicleUpdateValues

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

privateinherited

Definition at line 286 of file MSMoveReminder.h.

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

◆ myPosition

double MSE3Collector::MSE3LeaveReminder::myPosition

private

The position on the lane.

Definition at line 210 of file MSE3Collector.h.

Referenced by getPosition().

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

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 }
	Definition of a vehicle state. More...

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

methods from MSMoveReminder

Detailed Description

Member Enumeration Documentation

◆ Notification

Constructor & Destructor Documentation

◆ MSE3LeaveReminder() [1/2]

◆ MSE3LeaveReminder() [2/2]

Member Function Documentation

◆ getDescription()

◆ getLane()

◆ getPosition()

◆ isParkingRerouter()

◆ notifyEnter()

◆ notifyIdle()

◆ notifyLeave()

◆ notifyMove()

◆ notifyMoveInternal()

◆ notifyParking()

◆ notifyStopEnded()

◆ operator=()

◆ removeFromVehicleUpdateValues()

◆ setDescription()

◆ updateDetector()

Field Documentation

◆ myCollector

◆ myDescription

◆ myLane

◆ myLastVehicleUpdateValues

◆ myPosition