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

#include <MSMeanData_HBEFA.h>

Inheritance diagram for MSMeanData_HBEFA::MSLaneMeanDataValues:

Public Types
enum	Notification { NOTIFICATION_DEPARTED, NOTIFICATION_JUNCTION, NOTIFICATION_SEGMENT, NOTIFICATION_LANE_CHANGE, NOTIFICATION_TELEPORT, NOTIFICATION_PARKING, NOTIFICATION_ARRIVED, NOTIFICATION_VAPORIZED, NOTIFICATION_TELEPORT_ARRIVED }
	Definition of a vehicle state. More...
Public Member Functions
void	addTo (MSMeanData::MeanDataValues &val) const throw ()
	Add the values of this to the given one and store them there.
const MSLane *	getLane () const throw ()
	Returns the lane the reminder works on.
virtual SUMOReal	getSamples () const throw ()
	Returns the number of collected sample seconds.
virtual bool	isEmpty () const throw ()
	Returns whether any data was collected.
	MSLaneMeanDataValues (MSLane const lane, const SUMOReal length, const bool doAdd, const std::set< std::string > const vTypes=0, const MSMeanData_HBEFA *parent=0) throw ()
	Constructor.
virtual bool	notifyEnter (SUMOVehicle &veh, MSMoveReminder::Notification reason) throw ()
	Called if the vehicle enters the reminder's lane.
virtual bool	notifyLeave (SUMOVehicle &veh, SUMOReal lastPos, MSMoveReminder::Notification reason) throw ()
	Called if the vehicle leaves the reminder's lane.
bool	notifyMove (SUMOVehicle &veh, SUMOReal oldPos, SUMOReal newPos, SUMOReal newSpeed) throw ()
	Checks whether the reminder still has to be notified about the vehicle moves.
void	reset (bool afterWrite=false) throw ()
	Resets values so they may be used for the next interval.
virtual void	update () throw ()
	Called if a per timestep update is needed. Default does nothing.
bool	vehicleApplies (const SUMOVehicle &veh) const throw ()
	Tests whether the vehicles type is to be regarded.
void	write (OutputDevice &dev, const SUMOTime period, const SUMOReal numLanes, const int numVehicles=-1) const throw (IOError)
	Writes output values into the given stream.
virtual	~MSLaneMeanDataValues () throw ()
	Destructor.
Protected Member Functions
void	notifyMoveInternal (SUMOVehicle &veh, SUMOReal timeOnLane, SUMOReal speed) throw ()
	Internal notification about the vehicle moves.
Protected Attributes
MSLane *const	myLane
	Lane on which the reminder works.
const SUMOReal	myLaneLength
	The length of the lane / edge the data collector is on.
Private Attributes
const MSMeanData_HBEFA *	myParent
	The meandata parent.
Collected values
Sum of CO2 emissions
SUMOReal	CO2
SUMOReal	CO
	Sum of CO emissions.
SUMOReal	HC
	Sum of HC emissions.
SUMOReal	NOx
	Sum of NOx emissions.
SUMOReal	PMx
	Sum of PMx emissions.
SUMOReal	fuel
	Sum of consumed fuel.
Collected values
The number of sampled vehicle movements (in s)
SUMOReal	sampleSeconds
SUMOReal	travelledDistance
	The sum of the distances the vehicles travelled.

Detailed Description

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

Structure holding values that describe the emissions aggregated over some seconds.

Definition at line 69 of file MSMeanData_HBEFA.h.

Member Enumeration Documentation

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_TELEPORT	The vehicle is being teleported.
NOTIFICATION_PARKING	The vehicle starts or ends parking.
NOTIFICATION_ARRIVED	The vehicle arrived at its destination (is deleted)
NOTIFICATION_VAPORIZED	The vehicle got vaporized.
NOTIFICATION_TELEPORT_ARRIVED	The vehicle was teleported out of the net.

Definition at line 89 of file MSMoveReminder.h.

Constructor & Destructor Documentation

MSMeanData_HBEFA::MSLaneMeanDataValues::MSLaneMeanDataValues	(	MSLane *const	lane,
		const SUMOReal	length,
		const bool	doAdd,
		const std::set< std::string > *const	vTypes = `0`,
		const MSMeanData_HBEFA *	parent = `0`
	)		throw ()

Constructor.

Definition at line 50 of file MSMeanData_HBEFA.cpp.

MSMeanData_HBEFA::MSLaneMeanDataValues::~MSLaneMeanDataValues ( ) throw () [virtual]

Destructor.

Definition at line 56 of file MSMeanData_HBEFA.cpp.

Member Function Documentation

void MSMeanData_HBEFA::MSLaneMeanDataValues::addTo ( MSMeanData::MeanDataValues & val ) const throw () [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 74 of file MSMeanData_HBEFA.cpp.

References CO, CO2, fuel, HC, NOx, PMx, MSMeanData::MeanDataValues::sampleSeconds, and MSMeanData::MeanDataValues::travelledDistance.

const MSLane* MSMoveReminder::getLane ( ) const throw () [inline, inherited]

Returns the lane the reminder works on.

Returns:: The lane the reminder works on.

Definition at line 83 of file MSMoveReminder.h.

References MSMoveReminder::myLane.

Referenced by GUIInstantInductLoop::buildDetectorGUIRepresentation(), GUIInductLoop::buildDetectorGUIRepresentation(), TraCIServerAPI_InductionLoop::processGet(), and MSMeanData::writeEdge().

SUMOReal MSMeanData::MeanDataValues::getSamples ( ) const throw () [virtual, inherited]

Returns the number of collected sample seconds.

Returns:: the number of collected sample seconds

Reimplemented in MSMeanData::MeanDataValueTracker.

Definition at line 129 of file MSMeanData.cpp.

bool MSMeanData::MeanDataValues::isEmpty ( ) const throw () [virtual, inherited]

Returns whether any data was collected.

Returns:: whether no data was collected

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

Definition at line 118 of file MSMeanData.cpp.

bool MSMeanData::MeanDataValues::notifyEnter	(	SUMOVehicle &	veh,
		MSMoveReminder::Notification	reason
	)		throw () `[virtual, inherited]`

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::MeanDataValueTracker, MSMeanData_Harmonoise::MSLaneMeanDataValues, and MSMeanData_Net::MSLaneMeanDataValues.

Definition at line 72 of file MSMeanData.cpp.

References UNUSED_PARAMETER.

bool MSMeanData::MeanDataValues::notifyLeave	(	SUMOVehicle &	veh,
		SUMOReal	lastPos,
		MSMoveReminder::Notification	reason
	)		throw () `[virtual, inherited]`

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::MeanDataValueTracker, and MSMeanData_Net::MSLaneMeanDataValues.

Definition at line 105 of file MSMeanData.cpp.

References MSMoveReminder::NOTIFICATION_JUNCTION.

bool MSMeanData::MeanDataValues::notifyMove	(	SUMOVehicle &	veh,
		SUMOReal	oldPos,
		SUMOReal	newPos,
		SUMOReal	newSpeed
	)		throw () `[virtual, inherited]`

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 it's 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 79 of file MSMeanData.cpp.

References SUMOReal, TS, and WRITE_ERROR.

void MSMeanData_HBEFA::MSLaneMeanDataValues::notifyMoveInternal	(	SUMOVehicle &	veh,
		SUMOReal	timeOnLane,
		SUMOReal	speed
	)		throw () `[protected, virtual]`

Internal notification 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 it's reminder-container.

Parameters:

[in]	veh	Vehicle that asks this reminder.
[in]	timeOnLane	time the vehicle spent on the lane.
[in]	speed	Moving speed.

Reimplemented from MSMoveReminder.

Definition at line 88 of file MSMeanData_HBEFA.cpp.

References HelpersHBEFA::computeCO(), HelpersHBEFA::computeCO2(), HelpersHBEFA::computeFuel(), HelpersHBEFA::computeHC(), HelpersHBEFA::computeNOx(), and HelpersHBEFA::computePMx().

void MSMeanData_HBEFA::MSLaneMeanDataValues::reset ( bool afterWrite = false ) throw () [virtual]

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

Implements MSMeanData::MeanDataValues.

Definition at line 61 of file MSMeanData_HBEFA.cpp.

void MSMeanData::MeanDataValues::update ( ) throw () [virtual, inherited]

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

Reimplemented in MSMeanData_Harmonoise::MSLaneMeanDataValues.

Definition at line 124 of file MSMeanData.cpp.

bool MSMeanData::MeanDataValues::vehicleApplies ( const SUMOVehicle & veh ) const throw () [inherited]

Tests whether the vehicles type is to be regarded.

Parameters:

[in] veh The regarded vehicle

Returns:: whether the type of the vehicle is in the set of regarded types

Definition at line 111 of file MSMeanData.cpp.

References MSMeanData::myVehicleTypes.

void MSMeanData_HBEFA::MSLaneMeanDataValues::write	(	OutputDevice &	dev,
		const SUMOTime	period,
		const SUMOReal	numLanes,
		const int	numVehicles = `-1`
	)		const throw (IOError) `[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