Data structure for mean (aggregated) edge/lane values for tracked vehicles. More...

#include <MSMeanData.h>

Inheritance diagram for MSMeanData::MeanDataValueTracker:

Collaboration diagram for MSMeanData::MeanDataValueTracker:

Data Structures
class	TrackerEntry

Public Member Functions
void	addTo (MSMeanData::MeanDataValues &val) const
	Add the values of this to the given one and store them there.

virtual double	getAttributeValue (SumoXMLAttr a, const SUMOTime period, const double numLanes, const double speedLimit) const
	return attribute value

const std::string &	getDescription () const

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

double	getLaneLength () const

SUMOTime	getResetTime () const

double	getTravelledDistance () const
	Returns the total travelled distance.

virtual bool	isParkingRerouter () const

	MeanDataValueTracker (MSLane const lane, const double length, const MSMeanData const parent)
	Constructor.

bool	notifyMove (SUMOTrafficObject &veh, double oldPos, double newPos, double newSpeed)
	Checks whether the reminder still has to be notified about the vehicle moves.

void	reset (bool afterWrite)
	Resets values so they may be used for the next interval.

void	setDescription (const std::string &description)

virtual void	update ()
	Called if a per timestep update is needed. Default does nothing.

virtual	~MeanDataValueTracker ()
	Destructor.

Interface methods, to be derived by subclasses
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)

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.

const double	myLaneLength
	The length of the lane / edge the data collector is on.

const MSMeanData *const	myParent
	The meandata parent.

Collected values
The number of sampled vehicle movements (in s)
double	sampleSeconds

double	travelledDistance
	The sum of the distances the vehicles travelled.

SUMOTime	resetTime
	time at which collection was reset;

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

Methods inherited from MSMoveReminder
std::map< const SUMOTrafficObject , TrackerEntry >	myTrackedData
	The map of vehicles to data entries.

std::list< TrackerEntry * >	myCurrentData
	The currently active meandata "intervals".

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.

bool	notifyLeave (SUMOTrafficObject &veh, double lastPos, MSMoveReminder::Notification reason, const MSLane *enteredLane=0)
	Called if the vehicle leaves the reminder's lane.

bool	notifyEnter (SUMOTrafficObject &veh, MSMoveReminder::Notification reason, const MSLane *enteredLane=0)
	Computes current values and adds them to their sums.

bool	isEmpty () const
	Returns whether any data was collected.

void	write (OutputDevice &dev, long long int attributeMask, const SUMOTime period, const int numLanes, const double speedLimit, const double defaultTravelTime, const int numVehicles=-1) const
	Writes output values into the given stream.

int	getNumReady () const

void	clearFirst ()

double	getSamples () const
	Returns the number of collected sample seconds.

Detailed Description

Data structure for mean (aggregated) edge/lane values for tracked vehicles.

Definition at line 202 of file MSMeanData.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

◆ MeanDataValueTracker()

MSMeanData::MeanDataValueTracker::MeanDataValueTracker	(	MSLane *const	lane,
		const double	length,
		const MSMeanData *const	parent
	)

Constructor.

Definition at line 288 of file MSMeanData.cpp.

References MSMeanData::createValues(), and myCurrentData.

◆ ~MeanDataValueTracker()

MSMeanData::MeanDataValueTracker::~MeanDataValueTracker ( )

virtual

Destructor.

Definition at line 296 of file MSMeanData.cpp.

Member Function Documentation

◆ addTo()

void MSMeanData::MeanDataValueTracker::addTo ( MSMeanData::MeanDataValues & val ) const

virtual

Add the values of this to the given one and store them there.

Parameters

[in] val The meandata to add to

Implements MSMeanData::MeanDataValues.

Definition at line 326 of file MSMeanData.cpp.

References MSMeanData::MeanDataValues::addTo().

◆ clearFirst()

void MSMeanData::MeanDataValueTracker::clearFirst ( )

◆ getAttributeValue()

virtual double MSMeanData::MeanDataValues::getAttributeValue	(	SumoXMLAttr	a,
		const SUMOTime	period,
		const double	numLanes,
		const double	speedLimit
	)		const

inlinevirtualinherited

return attribute value

Reimplemented in MSMeanData_Net::MSLaneMeanDataValues.

Definition at line 169 of file MSMeanData.h.

References UNUSED_PARAMETER.

Referenced by MSMeanData_Net::getAttributeValue().

Here is the caller graph for this function:

◆ getDescription()

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

inlineinherited

Definition at line 280 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 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:

◆ getLaneLength()

double MSMeanData::MeanDataValues::getLaneLength ( ) const

inlineinherited

Definition at line 164 of file MSMeanData.h.

References MSMeanData::MeanDataValues::myLaneLength.

◆ getNumReady()

int MSMeanData::MeanDataValueTracker::getNumReady ( ) const

Definition at line 391 of file MSMeanData.cpp.

◆ getResetTime()

SUMOTime MSMeanData::MeanDataValues::getResetTime ( ) const

inlineinherited

Definition at line 160 of file MSMeanData.h.

References MSMeanData::MeanDataValues::resetTime.

◆ getSamples()

double MSMeanData::MeanDataValueTracker::getSamples ( ) const

virtual

Returns the number of collected sample seconds.

Returns: the number of collected sample seconds

Reimplemented from MSMeanData::MeanDataValues.

Definition at line 405 of file MSMeanData.cpp.

◆ getTravelledDistance()

double MSMeanData::MeanDataValues::getTravelledDistance ( ) const

inlineinherited

Returns the total travelled distance.

Returns: the total travelled distance

Definition at line 156 of file MSMeanData.h.

References MSMeanData::MeanDataValues::travelledDistance.

Referenced by MSCalibrator::currentSpeed(), LIBSUMO_NAMESPACE::InductionLoop::getIntervalMeanSpeed(), and MSCalibrator::writeXMLOutput().

Here is the caller graph for this function:

◆ isEmpty()

bool MSMeanData::MeanDataValueTracker::isEmpty ( ) const

virtual

Returns whether any data was collected.

Returns: whether no data was collected

Reimplemented from MSMeanData::MeanDataValues.

Definition at line 371 of file MSMeanData.cpp.

◆ isParkingRerouter()

virtual bool MSMoveReminder::isParkingRerouter ( ) const

inlinevirtualinherited

Reimplemented in MSTriggeredRerouter.

Definition at line 285 of file MSMoveReminder.h.

◆ notifyEnter()

bool MSMeanData::MeanDataValueTracker::notifyEnter	(	SUMOTrafficObject &	veh,
		MSMoveReminder::Notification	reason,
		const MSLane *	enteredLane = `0`
	)

virtual

Computes current values and adds them to their sums.

The fraction of time the vehicle is on the lane is computed and used as a weight for the vehicle's current values. The "emitted" field is incremented, additionally.

Parameters

[in]	veh	The entering vehicle.
[in]	reason	how the vehicle enters the lane

See also: MSMoveReminder::notifyEnter

Returns: Always true

Reimplemented from MSMeanData::MeanDataValues.

Definition at line 347 of file MSMeanData.cpp.

References Named::getID(), MSMoveReminder::NOTIFICATION_SEGMENT, SIMTIME, and UNUSED_PARAMETER.

◆ 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 183 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

◆ notifyLeave()

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

virtual

Called if the vehicle leaves the reminder's lane.

Parameters

	veh	The leaving vehicle.
[in]	lastPos	Position on the lane when leaving.
[in]	isArrival	whether the vehicle arrived at its destination
[in]	isLaneChange	whether the vehicle changed from the lane

See also: MSMoveReminder; MSMoveReminder::notifyLeave

Reimplemented from MSMeanData::MeanDataValues.

Definition at line 338 of file MSMeanData.cpp.

References MSMoveReminder::NOTIFICATION_SEGMENT.

◆ 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 228 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

◆ notifyMove()

bool MSMeanData::MeanDataValues::notifyMove	(	SUMOTrafficObject &	veh,
		double	oldPos,
		double	newPos,
		double	newSpeed
	)

virtualinherited

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 from MSMoveReminder.

Definition at line 87 of file MSMeanData.cpp.

References Named::getID(), MSVehicleType::getLength(), SUMOTrafficObject::getPreviousSpeed(), SUMOTrafficObject::getVehicleType(), MSGlobals::gNumSimThreads, MSGlobals::gSemiImplicitEulerUpdate, SUMOTrafficObject::hasArrived(), MAX2(), MIN2(), MIN4(), MSCFModel::passingTime(), MSCFModel::speedAfterTime(), TL, TS, WRITE_ERROR, and WRITE_ERRORF.

◆ notifyMoveInternal()

void MSMeanData::MeanDataValueTracker::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
	)

virtual

Internal notification about the vehicle moves.

See also: MSMoveReminder::notifyMoveInternal().

Reimplemented from MSMoveReminder.

Definition at line 332 of file MSMeanData.cpp.

◆ 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_Routing, and MSDevice_Vehroutes.

Definition at line 192 of file MSMoveReminder.h.

◆ removeFromVehicleUpdateValues()

void MSMoveReminder::removeFromVehicleUpdateValues ( SUMOTrafficObject & veh )

protectedinherited

Definition at line 89 of file MSMoveReminder.cpp.

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

Referenced by MSMoveReminder::updateDetector().

Here is the caller graph for this function:

◆ reset()

void MSMeanData::MeanDataValueTracker::reset ( bool afterWrite )

virtual

Resets values so they may be used for the next interval.

Implements MSMeanData::MeanDataValues.

Definition at line 313 of file MSMeanData.cpp.

◆ setDescription()

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

inlineinherited

Definition at line 276 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:

◆ update()

void MSMeanData::MeanDataValues::update ( )

virtualinherited

Called if a per timestep update is needed. Default does nothing.

Reimplemented in MSMeanData_Harmonoise::MSLaneMeanDataValues.

Definition at line 275 of file MSMeanData.cpp.

◆ 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 SUMOTrafficObject::getNumericalID(), MSMoveReminder::myLastVehicleUpdateValues, MSMoveReminder::notifyMoveInternal(), MSMoveReminder::removeFromVehicleUpdateValues(), and STEPS2TIME.

Referenced by MEVehicle::updateDetectorForWriting().

Here is the caller graph for this function:

◆ write()

void MSMeanData::MeanDataValueTracker::write	(	OutputDevice &	dev,
		long long int	attributeMask,
		const SUMOTime	period,
		const int	numLanes,
		const double	speedLimit,
		const double	defaultTravelTime,
		const int	numVehicles = `-1`
	)		const

virtual

Writes output values into the given stream.

Parameters

[in]	dev	The output device to write the data into
[in]	period	Length of the period the data were gathered
[in]	numLanes	The total number of lanes for which the data was collected

Exceptions

IOError If an error on writing occurs (!!! not yet implemented)

Implements MSMeanData::MeanDataValues.

Definition at line 377 of file MSMeanData.cpp.

Field Documentation

◆ myCurrentData

std::list<TrackerEntry*> MSMeanData::MeanDataValueTracker::myCurrentData

private

The currently active meandata "intervals".

Definition at line 301 of file MSMeanData.h.

Referenced by MeanDataValueTracker().

◆ myDescription

std::string MSMoveReminder::myDescription

protectedinherited

a description of this moveReminder

Definition at line 297 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 295 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().

◆ myLaneLength

const double MSMeanData::MeanDataValues::myLaneLength

protectedinherited

The length of the lane / edge the data collector is on.

Definition at line 182 of file MSMeanData.h.

Referenced by MSMeanData::MeanDataValues::getLaneLength().

◆ myLastVehicleUpdateValues

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

privateinherited

Definition at line 305 of file MSMoveReminder.h.

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

◆ myParent

const MSMeanData* const MSMeanData::MeanDataValues::myParent

protectedinherited

The meandata parent.

Definition at line 179 of file MSMeanData.h.

◆ myTrackedData

std::map<const SUMOTrafficObject*, TrackerEntry*> MSMeanData::MeanDataValueTracker::myTrackedData

private

The map of vehicles to data entries.

Definition at line 298 of file MSMeanData.h.

◆ resetTime

SUMOTime MSMeanData::MeanDataValues::resetTime

protectedinherited

time at which collection was reset;

Definition at line 194 of file MSMeanData.h.

Referenced by MSMeanData::MeanDataValues::getResetTime().

◆ sampleSeconds

double MSMeanData::MeanDataValues::sampleSeconds

protectedinherited

Definition at line 187 of file MSMeanData.h.

Referenced by MSMeanData_Amitran::MSLaneMeanDataValues::addTo(), MSMeanData_Emissions::MSLaneMeanDataValues::addTo(), MSMeanData_Harmonoise::MSLaneMeanDataValues::addTo(), and MSMeanData_Net::MSLaneMeanDataValues::addTo().

◆ travelledDistance

double MSMeanData::MeanDataValues::travelledDistance

protectedinherited

The sum of the distances the vehicles travelled.

Definition at line 190 of file MSMeanData.h.

Referenced by MSMeanData_Amitran::MSLaneMeanDataValues::addTo(), MSMeanData_Emissions::MSLaneMeanDataValues::addTo(), MSMeanData_Harmonoise::MSLaneMeanDataValues::addTo(), MSMeanData_Net::MSLaneMeanDataValues::addTo(), and MSMeanData::MeanDataValues::getTravelledDistance().

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...

Data Structures

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Methods inherited from MSMoveReminder

Detailed Description

Member Enumeration Documentation

◆ Notification

Constructor & Destructor Documentation

◆ MeanDataValueTracker()

◆ ~MeanDataValueTracker()

Member Function Documentation

◆ addTo()

◆ clearFirst()

◆ getAttributeValue()

◆ getDescription()

◆ getLane()

◆ getLaneLength()

◆ getNumReady()

◆ getResetTime()

◆ getSamples()

◆ getTravelledDistance()

◆ isEmpty()

◆ isParkingRerouter()

◆ notifyEnter()

◆ notifyIdle()

◆ notifyLeave()

◆ notifyLeaveBack()

◆ notifyMove()

◆ notifyMoveInternal()

◆ notifyParking()

◆ notifyStopEnded()

◆ removeFromVehicleUpdateValues()

◆ reset()

◆ setDescription()

◆ update()

◆ updateDetector()

◆ write()

Field Documentation

◆ myCurrentData

◆ myDescription

◆ myLane

◆ myLaneLength

◆ myLastVehicleUpdateValues

◆ myParent

◆ myTrackedData

◆ resetTime

◆ sampleSeconds

◆ travelledDistance