SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MSMeanData_Net::MSLaneMeanDataValues Class Reference

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

#include <MSMeanData_Net.h>

Inheritance diagram for MSMeanData_Net::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 of this to the given one and store them there. 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...
 
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_Net *parent=0)
 Constructor. 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...
 
virtual void update ()
 Called if a per timestep update is needed. Default does nothing. 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 notifyLeave (SUMOVehicle &veh, SUMOReal lastPos, MSMoveReminder::Notification reason)
 Called if the vehicle leaves the reminder's lane. More...
 
bool notifyEnter (SUMOVehicle &veh, MSMoveReminder::Notification reason)
 Computes current 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

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

Private Attributes

const MSMeanData_NetmyParent
 The meandata parent. More...
 

Collected values

The number of sampled vehicle movements (in s)

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

Collected values

The number of vehicles that were emitted on the lane

unsigned nVehDeparted
 
unsigned nVehArrived
 The number of vehicles that finished on the lane. More...
 
unsigned nVehEntered
 The number of vehicles that entered this lane within the sample interval. More...
 
unsigned nVehLeft
 The number of vehicles that left this lane within the sample interval. More...
 
unsigned nVehVaporized
 The number of vehicles that left this lane within the sample interval. More...
 
SUMOReal waitSeconds
 The number of vehicle probes with small speed. More...
 
unsigned nVehLaneChangeFrom
 The number of vehicles that changed from this lane. More...
 
unsigned nVehLaneChangeTo
 The number of vehicles that changed to this lane. More...
 
SUMOReal vehLengthSum
 The sum of the lengths the vehicles had. More...
 

Detailed Description

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

Structure holding values that describe the flow and other physical properties aggregated over some seconds.

Definition at line 73 of file MSMeanData_Net.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 94 of file MSMoveReminder.h.

Constructor & Destructor Documentation

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

Constructor.

Parameters
[in]lengthThe length of the object for which the data gets collected

Definition at line 59 of file MSMeanData_Net.cpp.

MSMeanData_Net::MSLaneMeanDataValues::~MSLaneMeanDataValues ( )
virtual

Destructor.

Definition at line 71 of file MSMeanData_Net.cpp.

Member Function Documentation

void MSMeanData_Net::MSLaneMeanDataValues::addTo ( MSMeanData::MeanDataValues val) const
virtual

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

Parameters
[in]valThe meandata to add to

Implements MSMeanData::MeanDataValues.

Definition at line 92 of file MSMeanData_Net.cpp.

References nVehArrived, nVehDeparted, nVehEntered, nVehLaneChangeFrom, nVehLaneChangeTo, nVehLeft, nVehVaporized, MSMeanData::MeanDataValues::sampleSeconds, MSMeanData::MeanDataValues::travelledDistance, vehLengthSum, and waitSeconds.

const std::string& MSMoveReminder::getDescription ( ) const
inlineinherited

Definition at line 210 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 136 of file MSMeanData.cpp.

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

bool MSMeanData_Net::MSLaneMeanDataValues::isEmpty ( ) const
virtual

Returns whether any data was collected.

Returns
whether no data was collected

Reimplemented from MSMeanData::MeanDataValues.

Definition at line 166 of file MSMeanData_Net.cpp.

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

Computes current 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 values. The "emitted" field is incremented, additionally.

Parameters
[in]vehThe vehicle that enters the lane
[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 148 of file MSMeanData_Net.cpp.

References MSMoveReminder::NOTIFICATION_DEPARTED, MSMoveReminder::NOTIFICATION_LANE_CHANGE, and MSMoveReminder::NOTIFICATION_SEGMENT.

bool MSMeanData_Net::MSLaneMeanDataValues::notifyLeave ( SUMOVehicle veh,
SUMOReal  lastPos,
MSMoveReminder::Notification  reason 
)
virtual

Called if the vehicle leaves the reminder's lane.

Parameters
vehThe leaving vehicle.
[in]lastPosPosition on the lane when leaving.
[in]isArrivalwhether the vehicle arrived at its destination
[in]isLaneChangewhether the vehicle changed from the lane
See Also
MSMoveReminder
MSMoveReminder::notifyLeave

Reimplemented from MSMeanData::MeanDataValues.

Definition at line 120 of file MSMeanData_Net.cpp.

References MSGlobals::gUseMesoSim, MSMoveReminder::NOTIFICATION_ARRIVED, MSMoveReminder::NOTIFICATION_JUNCTION, MSMoveReminder::NOTIFICATION_LANE_CHANGE, MSMoveReminder::NOTIFICATION_SEGMENT, and MSMoveReminder::NOTIFICATION_VAPORIZED.

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

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

void MSMeanData_Net::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 109 of file MSMeanData_Net.cpp.

References MSVehicleType::getLength(), SUMOVehicle::getVehicleType(), and MSMeanData_Net::myHaltSpeed.

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

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

Implements MSMeanData::MeanDataValues.

Definition at line 76 of file MSMeanData_Net.cpp.

Referenced by MSCalibrator::reset(), and MSCalibrator::updateMeanData().

void MSMeanData::MeanDataValues::update ( )
virtualinherited

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

Reimplemented in MSMeanData_Harmonoise::MSLaneMeanDataValues.

Definition at line 131 of file MSMeanData.cpp.

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

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

void MSMeanData_Net::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
Exceptions
IOErrorIf an error on writing occurs (!!! not yet implemented)

Implements MSMeanData::MeanDataValues.

Definition at line 173 of file MSMeanData_Net.cpp.

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

Field Documentation

const std::string MSMoveReminder::myDescription
protectedinherited

a description of this moveReminder

Definition at line 219 of file MSMoveReminder.h.

Referenced by MSMoveReminder::getDescription().

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 172 of file MSMeanData.h.

const MSMeanData_Net* MSMeanData_Net::MSLaneMeanDataValues::myParent
private

The meandata parent.

Definition at line 187 of file MSMeanData_Net.h.

unsigned MSMeanData_Net::MSLaneMeanDataValues::nVehArrived

The number of vehicles that finished on the lane.

Definition at line 160 of file MSMeanData_Net.h.

Referenced by addTo(), and MSCalibrator::execute().

unsigned MSMeanData_Net::MSLaneMeanDataValues::nVehDeparted
unsigned MSMeanData_Net::MSLaneMeanDataValues::nVehEntered

The number of vehicles that entered this lane within the sample interval.

Definition at line 163 of file MSMeanData_Net.h.

Referenced by addTo(), MSCalibrator::execute(), MSCalibrator::passed(), and MSCalibrator::writeXMLOutput().

unsigned MSMeanData_Net::MSLaneMeanDataValues::nVehLaneChangeFrom
private

The number of vehicles that changed from this lane.

Definition at line 176 of file MSMeanData_Net.h.

Referenced by addTo().

unsigned MSMeanData_Net::MSLaneMeanDataValues::nVehLaneChangeTo
private

The number of vehicles that changed to this lane.

Definition at line 179 of file MSMeanData_Net.h.

Referenced by addTo().

unsigned MSMeanData_Net::MSLaneMeanDataValues::nVehLeft

The number of vehicles that left this lane within the sample interval.

Definition at line 166 of file MSMeanData_Net.h.

Referenced by addTo(), and MSCalibrator::execute().

unsigned MSMeanData_Net::MSLaneMeanDataValues::nVehVaporized

The number of vehicles that left this lane within the sample interval.

Definition at line 169 of file MSMeanData_Net.h.

Referenced by addTo(), MSCalibrator::execute(), and MSCalibrator::writeXMLOutput().

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

The sum of the distances the vehicles travelled.

Definition at line 180 of file MSMeanData.h.

Referenced by MSMeanData_Harmonoise::MSLaneMeanDataValues::addTo(), MSMeanData_HBEFA::MSLaneMeanDataValues::addTo(), addTo(), and MSCalibrator::writeXMLOutput().

SUMOReal MSMeanData_Net::MSLaneMeanDataValues::vehLengthSum
private

The sum of the lengths the vehicles had.

Definition at line 183 of file MSMeanData_Net.h.

Referenced by addTo().

SUMOReal MSMeanData_Net::MSLaneMeanDataValues::waitSeconds

The number of vehicle probes with small speed.

Definition at line 172 of file MSMeanData_Net.h.

Referenced by addTo(), and MSCalibrator::execute().


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