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

#include <MSMeanData.h>

Inheritance diagram for MSMeanData::MeanDataValues:

Collaboration diagram for MSMeanData::MeanDataValues:

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

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

const std::string &	getDescription () const

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

double	getLaneLength () const

SUMOTime	getResetTime () const

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

double	getTravelledDistance () const
	Returns the total travelled distance. More...

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

virtual bool	isParkingRerouter () const

	MeanDataValues (MSLane const lane, const double length, const bool doAdd, const MSMeanData const parent)
	Constructor. More...

virtual bool	notifyEnter (SUMOTrafficObject &veh, MSMoveReminder::Notification reason, const MSLane *enteredLane=0)
	Called if the vehicle enters the reminder's lane. More...

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

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

virtual void	reset (bool afterWrite=false)=0
	Resets values so they may be used for the next interval. More...

void	setDescription (const std::string &description)

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

virtual 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 =0
	Writes output values into the given stream. More...

virtual	~MeanDataValues ()
	Destructor. More...

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

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

const MSMeanData *const	myParent
	The meandata parent. More...

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

double	travelledDistance
	The sum of the distances the vehicles travelled. More...

SUMOTime	resetTime
	time at which collection was reset; More...

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

Detailed Description

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

Structure holding values that describe the emissions (XXX: emissions?) aggregated, refs. #2579 over some seconds.

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

◆ MeanDataValues()

MSMeanData::MeanDataValues::MeanDataValues	(	MSLane *const	lane,
		const double	length,
		const bool	doAdd,
		const MSMeanData *const	parent
	)

Constructor.

Definition at line 60 of file MSMeanData.cpp.

◆ ~MeanDataValues()

MSMeanData::MeanDataValues::~MeanDataValues ( )

virtual

Destructor.

Definition at line 70 of file MSMeanData.cpp.

Member Function Documentation

◆ addTo()

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

pure virtual

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

Parameters

[in] val The meandata to add to

Implemented in MSMeanData_Net::MSLaneMeanDataValues, MSMeanData_Harmonoise::MSLaneMeanDataValues, MSMeanData_Emissions::MSLaneMeanDataValues, MSMeanData_Amitran::MSLaneMeanDataValues, and MSMeanData::MeanDataValueTracker.

Referenced by MSMeanData::writeEdge().

Here is the caller graph for this function:

◆ getAttributeValue()

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

inlinevirtual

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

◆ getLaneLength()

double MSMeanData::MeanDataValues::getLaneLength ( ) const

inline

Definition at line 164 of file MSMeanData.h.

References myLaneLength.

◆ getResetTime()

SUMOTime MSMeanData::MeanDataValues::getResetTime ( ) const

inline

Definition at line 160 of file MSMeanData.h.

References resetTime.

◆ getSamples()

double MSMeanData::MeanDataValues::getSamples ( ) const

virtual

Returns the number of collected sample seconds.

Returns: the number of collected sample seconds

Reimplemented in MSMeanData::MeanDataValueTracker.

Definition at line 280 of file MSMeanData.cpp.

Referenced by MSCalibrator::currentSpeed(), MSMeanData::writePrefix(), MEInductLoop::writeXMLOutput(), and MSCalibrator::writeXMLOutput().

Here is the caller graph for this function:

◆ getTravelledDistance()

double MSMeanData::MeanDataValues::getTravelledDistance ( ) const

inline

Returns the total travelled distance.

Returns: the total travelled distance

Definition at line 156 of file MSMeanData.h.

References travelledDistance.

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

Here is the caller graph for this function:

◆ isEmpty()

bool MSMeanData::MeanDataValues::isEmpty ( ) const

virtual

Returns whether any data was collected.

Returns: whether no data was collected

Reimplemented in MSMeanData_Net::MSLaneMeanDataValues, MSMeanData_Amitran::MSLaneMeanDataValues, and MSMeanData::MeanDataValueTracker.

Definition at line 269 of file MSMeanData.cpp.

Referenced by MSMeanData::writePrefix(), and MSMeanData_Amitran::writePrefix().

Here is the caller graph for this function:

◆ isParkingRerouter()

virtual bool MSMoveReminder::isParkingRerouter ( ) const

inlinevirtualinherited

Reimplemented in MSTriggeredRerouter.

Definition at line 266 of file MSMoveReminder.h.

◆ notifyEnter()

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

virtual

Called if the vehicle enters the reminder's lane.

Parameters

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

See also: MSMoveReminder; MSMoveReminder::notifyEnter; MSMoveReminder::Notification

Reimplemented from MSMoveReminder.

Reimplemented in MSMeanData_Net::MSLaneMeanDataValues, MSMeanData_Amitran::MSLaneMeanDataValues, and MSMeanData::MeanDataValueTracker.

Definition at line 75 of file MSMeanData.cpp.

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

Definition at line 183 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

◆ notifyLeave()

bool MSMeanData::MeanDataValues::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]	reason	how the vehicle leaves the lane

See also: MSMoveReminder; MSMoveReminder::notifyLeave

Reimplemented from MSMoveReminder.

Reimplemented in MSMeanData_Net::MSLaneMeanDataValues, and MSMeanData::MeanDataValueTracker.

Definition at line 260 of file MSMeanData.cpp.

References MSGlobals::gUseMesoSim, and MSMoveReminder::NOTIFICATION_JUNCTION.

◆ notifyMove()

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

virtual

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()

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.

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

◆ reset()

virtual void MSMeanData::MeanDataValues::reset ( bool afterWrite = false )

pure virtual

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

Implemented in MSMeanData_Net::MSLaneMeanDataValues, MSMeanData_Harmonoise::MSLaneMeanDataValues, MSMeanData_Emissions::MSLaneMeanDataValues, MSMeanData_Amitran::MSLaneMeanDataValues, and MSMeanData::MeanDataValueTracker.

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

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:

◆ update()

void MSMeanData::MeanDataValues::update ( )

virtual

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

Referenced by MEVehicle::updateDetectorForWriting().

Here is the caller graph for this function:

◆ write()

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

pure 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)

Implemented in MSMeanData_Net::MSLaneMeanDataValues, MSMeanData_Harmonoise::MSLaneMeanDataValues, MSMeanData_Emissions::MSLaneMeanDataValues, MSMeanData_Amitran::MSLaneMeanDataValues, and MSMeanData::MeanDataValueTracker.

Referenced by MSMeanData::writeAggregated(), and MSMeanData::writeEdge().

Here is the caller graph for this function:

Field Documentation

◆ 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().

◆ myLaneLength

const double MSMeanData::MeanDataValues::myLaneLength

protected

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

Definition at line 182 of file MSMeanData.h.

Referenced by getLaneLength().

◆ 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().

◆ myParent

const MSMeanData* const MSMeanData::MeanDataValues::myParent

protected

The meandata parent.

Definition at line 179 of file MSMeanData.h.

◆ resetTime

SUMOTime MSMeanData::MeanDataValues::resetTime

protected

time at which collection was reset;

Definition at line 194 of file MSMeanData.h.

Referenced by getResetTime().

◆ sampleSeconds

double MSMeanData::MeanDataValues::sampleSeconds

protected

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

protected

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Notification

Constructor & Destructor Documentation

◆ MeanDataValues()

◆ ~MeanDataValues()

Member Function Documentation

◆ addTo()

◆ getAttributeValue()

◆ getDescription()

◆ getLane()

◆ getLaneLength()

◆ getResetTime()

◆ getSamples()

◆ getTravelledDistance()

◆ isEmpty()

◆ isParkingRerouter()

◆ notifyEnter()

◆ notifyIdle()

◆ notifyLeave()

◆ notifyMove()

◆ notifyMoveInternal()

◆ notifyParking()

◆ notifyStopEnded()

◆ removeFromVehicleUpdateValues()

◆ reset()

◆ setDescription()

◆ update()

◆ updateDetector()

◆ write()

Field Documentation

◆ myDescription

◆ myLane

◆ myLaneLength

◆ myLastVehicleUpdateValues

◆ myParent

◆ resetTime

◆ sampleSeconds

◆ travelledDistance