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 throw ()
 Add the values to this meanData.
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_Harmonoise *parent=0) throw ()
 Constructor.
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.
void update () throw ()
 Computes the noise in the last time step.
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.
Methods inherited from MSMoveReminder.
bool notifyEnter (SUMOVehicle &veh, MSMoveReminder::Notification reason) throw ()
 Computes current emission values and adds them to their sums.

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_Harmonoise * myParent
 The meandata parent.
Collected values
SUMOReal currentTimeN
 Sum of produced noise at this time step(pow(10, (<NOISE>/10.)))
SUMOReal meanNTemp
 Sum of produced noise over time (pow(10, (<NOISE>/10.)))

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 noise aggregated over some seconds.

Definition at line 68 of file MSMeanData_Harmonoise.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_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 
) throw ()

Constructor.

Definition at line 51 of file MSMeanData_Harmonoise.cpp.

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

Destructor.

Definition at line 57 of file MSMeanData_Harmonoise.cpp.


Member Function Documentation

void MSMeanData_Harmonoise::MSLaneMeanDataValues::addTo ( MSMeanData::MeanDataValues &  val) const throw () [virtual]
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_Harmonoise::MSLaneMeanDataValues::notifyEnter ( SUMOVehicle &  veh,
MSMoveReminder::Notification  reason 
) throw () [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 97 of file MSMeanData_Harmonoise.cpp.

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

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 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]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 79 of file MSMeanData.cpp.

References SUMOReal, TS, and WRITE_ERROR.

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

Reimplemented from MSMoveReminder.

Definition at line 87 of file MSMeanData_Harmonoise.cpp.

References HelpersHarmonoise::computeNoise(), and SUMOReal.

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

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

Implements MSMeanData::MeanDataValues.

Definition at line 62 of file MSMeanData_Harmonoise.cpp.

void MSMeanData_Harmonoise::MSLaneMeanDataValues::update ( ) throw () [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 80 of file MSMeanData_Harmonoise.cpp.

References HelpersHarmonoise::sum(), and SUMOReal.

bool MSMeanData::MeanDataValues::vehicleApplies ( const SUMOVehicle &  veh) const throw () [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 111 of file MSMeanData.cpp.

References MSMeanData::myVehicleTypes.

void MSMeanData_Harmonoise::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]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 103 of file MSMeanData_Harmonoise.cpp.

References MIN2(), STEPS2TIME, SUMOReal, and TS.


Field Documentation

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

Definition at line 146 of file MSMeanData_Harmonoise.h.

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

Definition at line 149 of file MSMeanData_Harmonoise.h.

Referenced by addTo().

MSLane* const MSMoveReminder::myLane [protected, inherited]

Lane on which the reminder works.

Definition at line 211 of file MSMoveReminder.h.

Referenced by MSMoveReminder::getLane().

const SUMOReal MSMeanData::MeanDataValues::myLaneLength [protected, inherited]

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

Definition at line 171 of file MSMeanData.h.

The meandata parent.

Definition at line 154 of file MSMeanData_Harmonoise.h.

The sum of the distances the vehicles travelled.

Definition at line 179 of file MSMeanData.h.

Referenced by MSMeanData_Net::MSLaneMeanDataValues::addTo(), MSMeanData_HBEFA::MSLaneMeanDataValues::addTo(), and addTo().


The documentation for this class was generated from the following files:
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Defines