SUMO - Simulation of Urban MObility
MSMeanData_Harmonoise::MSLaneMeanDataValues Class Reference

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

#include <MSMeanData_Harmonoise.h>

Inheritance diagram for MSMeanData_Harmonoise::MSLaneMeanDataValues:
MSMeanData::MeanDataValues MSMoveReminder

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
 Add the values to this meanData. More...
 
const std::string & getDescription () const
 
const MSLanegetLane () const
 Returns the lane the reminder works on. More...
 
virtual SUMOReal getSamples () const
 Returns the number of collected sample seconds. More...
 
virtual bool isEmpty () const
 Returns whether any data was collected. More...
 
 MSLaneMeanDataValues (MSLane *const lane, const SUMOReal length, const bool doAdd, const std::set< std::string > *const vTypes=0, const MSMeanData_Harmonoise *parent=0)
 Constructor. More...
 
virtual bool notifyLeave (SUMOVehicle &veh, SUMOReal lastPos, MSMoveReminder::Notification reason)
 Called if the vehicle leaves the reminder's lane. More...
 
bool notifyMove (SUMOVehicle &veh, SUMOReal oldPos, SUMOReal newPos, SUMOReal 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)
 
void update ()
 Computes the noise in the last time step. More...
 
bool vehicleApplies (const SUMOVehicle &veh) const
 Tests whether the vehicles type is to be regarded. More...
 
void write (OutputDevice &dev, const SUMOTime period, const SUMOReal numLanes, const SUMOReal defaultTravelTime, const int numVehicles=-1) const
 Writes output values into the given stream. More...
 
virtual ~MSLaneMeanDataValues ()
 Destructor. More...
 
Methods inherited from MSMoveReminder.
bool notifyEnter (SUMOVehicle &veh, MSMoveReminder::Notification reason)
 Computes current emission values and adds them to their sums. More...
 

Protected Member Functions

void notifyMoveInternal (SUMOVehicle &veh, SUMOReal timeOnLane, SUMOReal speed)
 Internal notification about the vehicle moves. More...
 

Protected Attributes

std::string myDescription
 a description of this moveReminder More...
 
MSLane *const myLane
 Lane on which the reminder works. More...
 
const SUMOReal myLaneLength
 The length of the lane / edge the data collector is on. More...
 
const std::set< std::string > *const myVehicleTypes
 The vehicle types to look for (0 or empty means all) More...
 

Private Attributes

const MSMeanData_HarmonoisemyParent
 The meandata parent. More...
 
Collected values
SUMOReal currentTimeN
 Sum of produced noise at this time step(pow(10, (<NOISE>/10.))) More...
 
SUMOReal meanNTemp
 Sum of produced noise over time (pow(10, (<NOISE>/10.))) More...
 

Collected values

The number of sampled vehicle movements (in s)

SUMOReal sampleSeconds
 
SUMOReal travelledDistance
 The sum of the distances the vehicles travelled. More...
 

Detailed Description

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

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

Definition at line 69 of file MSMeanData_Harmonoise.h.

Member Enumeration Documentation

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

Constructor & Destructor Documentation

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

Constructor.

Definition at line 53 of file MSMeanData_Harmonoise.cpp.

MSMeanData_Harmonoise::MSLaneMeanDataValues::~MSLaneMeanDataValues ( )
virtual

Destructor.

Definition at line 59 of file MSMeanData_Harmonoise.cpp.

Member Function Documentation

void MSMeanData_Harmonoise::MSLaneMeanDataValues::addTo ( MSMeanData::MeanDataValues val) const
virtual
const std::string& MSMoveReminder::getDescription ( ) const
inlineinherited

Definition at line 215 of file MSMoveReminder.h.

References MSMoveReminder::myDescription.

SUMOReal 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 142 of file MSMeanData.cpp.

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

bool MSMeanData::MeanDataValues::isEmpty ( ) const
virtualinherited

Returns whether any data was collected.

Returns
whether no data was collected

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

Definition at line 131 of file MSMeanData.cpp.

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

bool MSMeanData_Harmonoise::MSLaneMeanDataValues::notifyEnter ( SUMOVehicle veh,
MSMoveReminder::Notification  reason 
)
virtual

Computes current emission 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 emission values which are computed using the current velocity and acceleration.

Parameters
[in]vehThe entering vehicle.
[in]reasonhow the vehicle enters the lane
Returns
Always true
See also
MSMoveReminder::notifyEnter
MSMoveReminder::Notification

Reimplemented from MSMeanData::MeanDataValues.

Definition at line 99 of file MSMeanData_Harmonoise.cpp.

bool MSMeanData::MeanDataValues::notifyLeave ( SUMOVehicle veh,
SUMOReal  lastPos,
MSMoveReminder::Notification  reason 
)
virtualinherited

Called if the vehicle leaves the reminder's lane.

Parameters
vehThe leaving vehicle.
[in]lastPosPosition on the lane when leaving.
[in]reasonhow the vehicle leaves the lane
See also
MSMoveReminder
MSMoveReminder::notifyLeave

Reimplemented from MSMoveReminder.

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

Definition at line 113 of file MSMeanData.cpp.

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

bool MSMeanData::MeanDataValues::notifyMove ( SUMOVehicle veh,
SUMOReal  oldPos,
SUMOReal  newPos,
SUMOReal  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 it's reminder-container.

Parameters
[in]vehVehicle that asks this reminder.
[in]oldPosPosition before move.
[in]newPosPosition after move with newSpeed.
[in]newSpeedMoving speed.
Returns
True if vehicle hasn't passed the reminder completely.

Reimplemented from MSMoveReminder.

Definition at line 85 of file MSMeanData.cpp.

References SUMOVehicle::getID(), MSVehicleType::getLength(), SUMOVehicle::getVehicleType(), SUMOVehicle::hasArrived(), SUMOReal, TS, and WRITE_ERROR.

void MSMeanData_Harmonoise::MSLaneMeanDataValues::notifyMoveInternal ( SUMOVehicle veh,
SUMOReal  timeOnLane,
SUMOReal  speed 
)
protectedvirtual

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]vehVehicle that asks this reminder.
[in]timeOnLanetime the vehicle spent on the lane.
[in]speedMoving speed.

Reimplemented from MSMoveReminder.

Definition at line 89 of file MSMeanData_Harmonoise.cpp.

References HelpersHarmonoise::computeNoise(), SUMOVehicle::getAcceleration(), MSVehicleType::getEmissionClass(), SUMOVehicle::getVehicleType(), and SUMOReal.

void MSMeanData_Harmonoise::MSLaneMeanDataValues::reset ( bool  afterWrite = false)
virtual

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

Implements MSMeanData::MeanDataValues.

Definition at line 64 of file MSMeanData_Harmonoise.cpp.

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

Definition at line 211 of file MSMoveReminder.h.

References MSMoveReminder::myDescription.

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

void MSMeanData_Harmonoise::MSLaneMeanDataValues::update ( )
virtual

Computes the noise in the last time step.

The sum of noises collected so far (in the last seen step) is built, and added to meanNTemp; currentTimeN is resetted.

Reimplemented from MSMeanData::MeanDataValues.

Definition at line 82 of file MSMeanData_Harmonoise.cpp.

References HelpersHarmonoise::sum(), and SUMOReal.

bool MSMeanData::MeanDataValues::vehicleApplies ( const SUMOVehicle veh) const
inherited

Tests whether the vehicles type is to be regarded.

Parameters
[in]vehThe regarded vehicle
Returns
whether the type of the vehicle is in the set of regarded types

Definition at line 124 of file MSMeanData.cpp.

References MSVehicleType::getID(), SUMOVehicle::getVehicleType(), and MSMeanData::myVehicleTypes.

void MSMeanData_Harmonoise::MSLaneMeanDataValues::write ( OutputDevice dev,
const SUMOTime  period,
const SUMOReal  numLanes,
const SUMOReal  defaultTravelTime,
const int  numVehicles = -1 
) const
virtual

Writes output values into the given stream.

Parameters
[in]devThe output device to write the data into
[in]periodLength of the period the data were gathered
[in]numLanesThe total number of lanes for which the data was collected
[in]lengthThe length of the object for which the data was collected
Exceptions
IOErrorIf an error on writing occurs (!!! not yet implemented)

Implements MSMeanData::MeanDataValues.

Definition at line 105 of file MSMeanData_Harmonoise.cpp.

References OutputDevice::closeTag(), MIN2(), STEPS2TIME, SUMOReal, TS, and OutputDevice::writeAttr().

Field Documentation

SUMOReal MSMeanData_Harmonoise::MSLaneMeanDataValues::currentTimeN
private

Sum of produced noise at this time step(pow(10, (<NOISE>/10.)))

Definition at line 147 of file MSMeanData_Harmonoise.h.

SUMOReal MSMeanData_Harmonoise::MSLaneMeanDataValues::meanNTemp
private

Sum of produced noise over time (pow(10, (<NOISE>/10.)))

Definition at line 150 of file MSMeanData_Harmonoise.h.

Referenced by addTo().

std::string MSMoveReminder::myDescription
protectedinherited

a description of this moveReminder

Definition at line 229 of file MSMoveReminder.h.

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

MSLane* const MSMoveReminder::myLane
protectedinherited
const SUMOReal MSMeanData::MeanDataValues::myLaneLength
protectedinherited

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

Definition at line 173 of file MSMeanData.h.

const MSMeanData_Harmonoise* MSMeanData_Harmonoise::MSLaneMeanDataValues::myParent
private

The meandata parent.

Definition at line 155 of file MSMeanData_Harmonoise.h.

const std::set<std::string>* const MSMeanData::MeanDataValues::myVehicleTypes
protectedinherited

The vehicle types to look for (0 or empty means all)

Definition at line 186 of file MSMeanData.h.

SUMOReal MSMeanData::MeanDataValues::sampleSeconds
protectedinherited
SUMOReal MSMeanData::MeanDataValues::travelledDistance
inherited

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