MSMeanData_Emissions::MSLaneMeanDataValues Class Reference

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

#include <MSMeanData_Emissions.h>

Inheritance diagram for MSMeanData_Emissions::MSLaneMeanDataValues:

Collaboration diagram for MSMeanData_Emissions::MSLaneMeanDataValues:

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 Member Functions
void	addTo (MSMeanData::MeanDataValues &val) const
	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
	MSLaneMeanDataValues (MSLane *const lane, const double length, const bool doAdd, const MSMeanData_Emissions *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...
void	reset (bool afterWrite=false)
	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...
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. More...
virtual	~MSLaneMeanDataValues ()
	Destructor. More...
Interface methods, to be derived by subclasses
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
bool	notifyIdle (SUMOTrafficObject &veh)
	Computes idling emission values and adds them to the aggregate emission sums. More...
void	notifyMoveInternal (const SUMOTrafficObject &veh, const double, const double timeOnLane, const double, const double meanSpeedVehicleOnLane, const double travelledDistanceFrontOnLane, const double travelledDistanceVehicleOnLane, const double)
	Internal notification about the vehicle moves. More...
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
PollutantsInterface::Emissions	myEmissions
	Collected values. More...
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 aggregated over some seconds.

Definition at line 62 of file MSMeanData_Emissions.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

MSLaneMeanDataValues()

MSMeanData_Emissions::MSLaneMeanDataValues::MSLaneMeanDataValues	(	MSLane *const	lane,
		const double	length,
		const bool	doAdd,
		const MSMeanData_Emissions *	parent
	)

Constructor.

Definition at line 41 of file MSMeanData_Emissions.cpp.

~MSLaneMeanDataValues()

MSMeanData_Emissions::MSLaneMeanDataValues::~MSLaneMeanDataValues ( )

virtual

Destructor.

Definition at line 48 of file MSMeanData_Emissions.cpp.

Member Function Documentation

addTo()

void MSMeanData_Emissions::MSLaneMeanDataValues::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 62 of file MSMeanData_Emissions.cpp.

References PollutantsInterface::Emissions::addScaled(), myEmissions, MSMeanData::MeanDataValues::sampleSeconds, and MSMeanData::MeanDataValues::travelledDistance.

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

inlineinherited

Definition at line 164 of file MSMeanData.h.

References MSMeanData::MeanDataValues::myLaneLength.

getResetTime()

SUMOTime MSMeanData::MeanDataValues::getResetTime ( ) const

inlineinherited

Definition at line 160 of file MSMeanData.h.

References MSMeanData::MeanDataValues::resetTime.

getSamples()

double MSMeanData::MeanDataValues::getSamples ( ) const

virtualinherited

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

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::MeanDataValues::isEmpty ( ) const

virtualinherited

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  )

virtualinherited

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

bool MSMeanData_Emissions::MSLaneMeanDataValues::notifyIdle ( SUMOTrafficObject &  veh )

protectedvirtual

Computes idling emission values and adds them to the aggregate emission sums.

Idling implied by zero velocity, acceleration and slope

Parameters

[in]

veh

The vehicle

See also

MSMoveReminder::notifyMove

PollutantsInterface

Reimplemented from MSMoveReminder.

Definition at line 87 of file MSMeanData_Emissions.cpp.

References PollutantsInterface::computeAll(), MSVehicleType::getEmissionClass(), SUMOVehicle::getEmissionParameters(), SUMOTrafficObject::getVehicleType(), SUMOTrafficObject::isVehicle(), and TS.

notifyLeave()

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

virtualinherited

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  )

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_Emissions::MSLaneMeanDataValues::notifyMoveInternal ( const SUMOTrafficObject &  veh, const double  frontOnLane, const double  timeOnLane, const double  meanSpeedFrontOnLane, const double  meanSpeedVehicleOnLane, const double  travelledDistanceFrontOnLane, const double  travelledDistanceVehicleOnLane, const double    )

protectedvirtual

Internal notification about the vehicle moves.

See also

MSMoveReminder::notifyMoveInternal()

Reimplemented from MSMoveReminder.

Definition at line 71 of file MSMeanData_Emissions.cpp.

References PollutantsInterface::computeAll(), SUMOTrafficObject::getAcceleration(), MSVehicleType::getEmissionClass(), SUMOVehicle::getEmissionParameters(), SUMOTrafficObject::getSlope(), SUMOTrafficObject::getVehicleType(), and SUMOTrafficObject::isVehicle().

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

void MSMeanData_Emissions::MSLaneMeanDataValues::reset ( bool  afterWrite = false )

virtual

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

Implements MSMeanData::MeanDataValues.

Definition at line 53 of file MSMeanData_Emissions.cpp.

References SIMSTEP.

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

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

Referenced by MEVehicle::updateDetectorForWriting().

Here is the caller graph for this function:

write()

void MSMeanData_Emissions::MSLaneMeanDataValues::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]	prefix	The xml prefix to write (mostly the lane / edge id)
[in]	numLanes	The total number of lanes for which the data was collected
[in]	length	The length of the object for which the data was collected

Exceptions

IOError

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

Implements MSMeanData::MeanDataValues.

Definition at line 98 of file MSMeanData_Emissions.cpp.

References OutputDevice::closeTag(), PollutantsInterface::CO, PollutantsInterface::CO2, PollutantsInterface::computeDefault(), PollutantsInterface::ELEC, PollutantsInterface::FUEL, MSVehicleType::getCarFollowModel(), MSVehicleType::getEmissionClass(), MSVehicleType::getEmissionParameters(), MSNet::getInstance(), MSCFModel::getMaxAccel(), MSVehicleType::getMaxSpeed(), MSNet::getVehicleControl(), MSVehicleControl::getVType(), PollutantsInterface::HC, MIN2(), PollutantsInterface::NO_X, PollutantsInterface::PM_X, OutputDevice::realString(), STEPS2TIME, SUMO_ATTR_CO2_ABS, SUMO_ATTR_CO2_NORMED, SUMO_ATTR_CO2_PERVEH, SUMO_ATTR_CO_ABS, SUMO_ATTR_CO_NORMED, SUMO_ATTR_CO_PERVEH, SUMO_ATTR_ELECTRICITY_ABS, SUMO_ATTR_ELECTRICITY_NORMED, SUMO_ATTR_ELECTRICITY_PERVEH, SUMO_ATTR_FUEL_ABS, SUMO_ATTR_FUEL_NORMED, SUMO_ATTR_FUEL_PERVEH, SUMO_ATTR_HC_ABS, SUMO_ATTR_HC_NORMED, SUMO_ATTR_HC_PERVEH, SUMO_ATTR_NOX_ABS, SUMO_ATTR_NOX_NORMED, SUMO_ATTR_NOX_PERVEH, SUMO_ATTR_PMX_ABS, SUMO_ATTR_PMX_NORMED, SUMO_ATTR_PMX_PERVEH, SUMO_ATTR_TRAVELTIME, and OutputDevice::writeOptionalAttr().

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

myEmissions

PollutantsInterface::Emissions MSMeanData_Emissions::MSLaneMeanDataValues::myEmissions

private

Collected values.

Definition at line 117 of file MSMeanData_Emissions.h.

Referenced by addTo().

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

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

protectedinherited

The meandata parent.

Definition at line 179 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(), 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(), addTo(), MSMeanData_Harmonoise::MSLaneMeanDataValues::addTo(), MSMeanData_Net::MSLaneMeanDataValues::addTo(), and MSMeanData::MeanDataValues::getTravelledDistance().

---

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

• MSMeanData_Emissions.h
• MSMeanData_Emissions.cpp