Eclipse SUMO - Simulation of Urban MObility
MSMeanData_Net::MSLaneMeanDataValues Class Reference

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

#include <MSMeanData_Net.h>

Inheritance diagram for MSMeanData_Net::MSLaneMeanDataValues:
[legend]
Collaboration diagram for MSMeanData_Net::MSLaneMeanDataValues:
[legend]

Public Types

enum  Notification {
  NOTIFICATION_DEPARTED , NOTIFICATION_JUNCTION , NOTIFICATION_SEGMENT , NOTIFICATION_LANE_CHANGE ,
  NOTIFICATION_TELEPORT , 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
}
 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 double getSamples () const
 Returns the number of collected sample seconds. More...
 
double getTravelledDistance () const
 Returns the total travelled distance. More...
 
 MSLaneMeanDataValues (MSLane *const lane, const double length, const bool doAdd, const MSMeanData_Net *parent)
 Constructor. 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...
 
virtual ~MSLaneMeanDataValues ()
 Destructor. More...
 
Interface methods, to be derived by subclasses
virtual bool notifyIdle (SUMOTrafficObject &veh)
 Computes idling emission values and adds them to the emission sums. More...
 
void updateDetector (SUMOTrafficObject &veh, double entryPos, double leavePos, SUMOTime entryTime, SUMOTime currentTime, SUMOTime leaveTime, bool cleanUp)
 

Static Public Member Functions

template<class T >
static void checkWriteAttribute (OutputDevice &dev, long long int attributeMask, const SumoXMLAttr attr, const T &val)
 write attribute if it passed the attribute mask check More...
 

Protected Member Functions

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...
 
Collected values

The number of sampled vehicle movements (in s)

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

Private Attributes

std::map< SUMOTrafficObject *, std::pair< SUMOTime, double > > myLastVehicleUpdateValues
 

Collected values

The number of vehicles that were emitted on the lane

int nVehDeparted
 
int nVehArrived
 The number of vehicles that finished on the lane. More...
 
int nVehEntered
 The number of vehicles that entered this lane within the sample interval. More...
 
int nVehLeft
 The number of vehicles that left this lane within the sample interval. More...
 
int nVehVaporized
 The number of vehicles that left this lane within the sample interval. More...
 
double waitSeconds
 The number of vehicle probes with small speed. More...
 
double timeLoss
 The time loss accrued by vehicle probes. More...
 
int nVehLaneChangeFrom
 The number of vehicles that changed from this lane. More...
 
int nVehLaneChangeTo
 The number of vehicles that changed to this lane. More...
 
double frontSampleSeconds
 The number of vehicle probes regarding the vehicle front. More...
 
double frontTravelledDistance
 The travelled distance regarding the vehicle front. More...
 
double vehLengthSum
 The sum of the lengths the vehicles had. More...
 
double occupationSum
 The sum of the occupation of the lane. More...
 
double minimalVehicleLength
 minimal vehicle length in the current interval (used to determine a maximal density, see #3265) More...
 
const MSMeanData_NetmyParent
 The meandata parent. More...
 

Methods inherited from MSMoveReminder

bool notifyLeave (SUMOTrafficObject &veh, double lastPos, MSMoveReminder::Notification reason, const MSLane *enteredLane=0)
 Called if the vehicle leaves the reminder's lane. More...
 
bool notifyEnter (SUMOTrafficObject &veh, MSMoveReminder::Notification reason, const MSLane *enteredLane=0)
 Computes current values and adds them to their sums. More...
 
bool isEmpty () const
 Returns whether any data was collected. More...
 
void write (OutputDevice &dev, long long int attributeMask, const SUMOTime period, const double numLanes, const double defaultTravelTime, const int numVehicles=-1) const
 Writes output values into the given stream. More...
 
void notifyMoveInternal (const SUMOTrafficObject &veh, const double frontOnLane, const double timeOnLane, const double, const double meanSpeedVehicleOnLane, const double travelledDistanceFrontOnLane, const double travelledDistanceVehicleOnLane, const double meanLengthOnLane)
 Internal notification about the vehicle moves. 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 64 of file MSMeanData_Net.h.

Member Enumeration Documentation

◆ Notification

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

Definition at line 89 of file MSMoveReminder.h.

Constructor & Destructor Documentation

◆ MSLaneMeanDataValues()

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

Constructor.

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

Definition at line 53 of file MSMeanData_Net.cpp.

◆ ~MSLaneMeanDataValues()

MSMeanData_Net::MSLaneMeanDataValues::~MSLaneMeanDataValues ( )
virtual

Destructor.

Definition at line 67 of file MSMeanData_Net.cpp.

Member Function Documentation

◆ addTo()

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

◆ checkWriteAttribute()

template<class T >
static void MSMeanData::MeanDataValues::checkWriteAttribute ( OutputDevice dev,
long long int  attributeMask,
const SumoXMLAttr  attr,
const T &  val 
)
inlinestaticinherited

write attribute if it passed the attribute mask check

Definition at line 162 of file MSMeanData.h.

References OutputDevice::writeAttr().

Referenced by MSMeanData::writePrefix().

Here is the caller graph for this function:

◆ getDescription()

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

Definition at line 249 of file MSMoveReminder.h.

References MSMoveReminder::myDescription.

◆ getLane()

const MSLane* MSMoveReminder::getLane ( ) const
inlineinherited

◆ 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 277 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(), and MSCalibrator::writeXMLOutput().

Here is the caller graph for this function:

◆ isEmpty()

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 232 of file MSMeanData_Net.cpp.

◆ notifyEnter()

bool MSMeanData_Net::MSLaneMeanDataValues::notifyEnter ( SUMOTrafficObject veh,
MSMoveReminder::Notification  reason,
const MSLane enteredLane = 0 
)
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 206 of file MSMeanData_Net.cpp.

References Named::getID(), MSGlobals::gNumSimThreads, SUMOTrafficObject::isVehicle(), MSMoveReminder::NOTIFICATION_DEPARTED, MSMoveReminder::NOTIFICATION_LANE_CHANGE, MSMoveReminder::NOTIFICATION_SEGMENT, SIMTIME, and UNUSED_PARAMETER.

◆ notifyIdle()

virtual bool MSMoveReminder::notifyIdle ( SUMOTrafficObject veh)
inlinevirtualinherited

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

Idling implied by zero velocity, acceleration and slope

Parameters
[in]vehThe vehicle
See also
MSMoveReminder::notifyMove
PollutantsInterface

Reimplemented in MSMeanData_Emissions::MSLaneMeanDataValues, MSDevice_Tripinfo, and MSDevice_Emissions.

Definition at line 177 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

◆ notifyLeave()

bool MSMeanData_Net::MSLaneMeanDataValues::notifyLeave ( SUMOTrafficObject veh,
double  lastPos,
MSMoveReminder::Notification  reason,
const MSLane enteredLane = 0 
)
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 178 of file MSMeanData_Net.cpp.

References MSGlobals::gNumSimThreads, MSGlobals::gUseMesoSim, SUMOTrafficObject::isVehicle(), MSMoveReminder::NOTIFICATION_ARRIVED, MSMoveReminder::NOTIFICATION_JUNCTION, MSMoveReminder::NOTIFICATION_LANE_CHANGE, and MSMoveReminder::NOTIFICATION_SEGMENT.

◆ 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 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 Named::getID(), MSVehicleType::getLength(), SUMOTrafficObject::getPreviousSpeed(), SUMOTrafficObject::getVehicleType(), MSGlobals::gNumSimThreads, MSGlobals::gSemiImplicitEulerUpdate, SUMOTrafficObject::hasArrived(), MAX2(), MIN2(), MIN4(), MSCFModel::passingTime(), MSCFModel::speedAfterTime(), TS, and WRITE_ERROR.

◆ notifyMoveInternal()

void MSMeanData_Net::MSLaneMeanDataValues::notifyMoveInternal ( const SUMOTrafficObject veh,
const double  frontOnLane,
const double  timeOnLane,
const double  ,
const double  meanSpeedVehicleOnLane,
const double  travelledDistanceFrontOnLane,
const double  travelledDistanceVehicleOnLane,
const double  meanLengthOnLane 
)
protectedvirtual

◆ 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_Net::MSLaneMeanDataValues::reset ( bool  afterWrite = false)
virtual

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

Implements MSMeanData::MeanDataValues.

Definition at line 72 of file MSMeanData_Net.cpp.

References INVALID_DOUBLE.

Referenced by METriggeredCalibrator::execute(), METriggeredCalibrator::reset(), MSCalibrator::reset(), MSCalibrator::updateMeanData(), and MEInductLoop::writeXMLOutput().

Here is the caller graph for this function:

◆ setDescription()

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

Definition at line 245 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 272 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_Net::MSLaneMeanDataValues::write ( OutputDevice dev,
long long int  attributeMask,
const SUMOTime  period,
const double  numLanes,
const double  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 239 of file MSMeanData_Net.cpp.

References OutputDevice::closeTag(), MAX2(), MIN2(), SIMTIME, STEPS2TIME, SUMO_ATTR_ARRIVED, SUMO_ATTR_DENSITY, SUMO_ATTR_DEPARTED, SUMO_ATTR_ENTERED, SUMO_ATTR_LANECHANGEDFROM, SUMO_ATTR_LANECHANGEDTO, SUMO_ATTR_LANEDENSITY, SUMO_ATTR_LEFT, SUMO_ATTR_OCCUPANCY, SUMO_ATTR_OVERLAPTRAVELTIME, SUMO_ATTR_SPEED, SUMO_ATTR_TIMELOSS, SUMO_ATTR_TRAVELTIME, SUMO_ATTR_VAPORIZED, and SUMO_ATTR_WAITINGTIME.

Referenced by MEInductLoop::writeXMLOutput().

Here is the caller graph for this function:

Field Documentation

◆ frontSampleSeconds

double MSMeanData_Net::MSLaneMeanDataValues::frontSampleSeconds
private

The number of vehicle probes regarding the vehicle front.

Definition at line 178 of file MSMeanData_Net.h.

Referenced by addTo().

◆ frontTravelledDistance

double MSMeanData_Net::MSLaneMeanDataValues::frontTravelledDistance
private

The travelled distance regarding the vehicle front.

Definition at line 181 of file MSMeanData_Net.h.

Referenced by addTo().

◆ minimalVehicleLength

double MSMeanData_Net::MSLaneMeanDataValues::minimalVehicleLength
private

minimal vehicle length in the current interval (used to determine a maximal density, see #3265)

Definition at line 190 of file MSMeanData_Net.h.

Referenced by addTo().

◆ myDescription

std::string MSMoveReminder::myDescription
protectedinherited

a description of this moveReminder

Definition at line 261 of file MSMoveReminder.h.

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

◆ myLane

◆ myLaneLength

const double MSMeanData::MeanDataValues::myLaneLength
protectedinherited

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

Definition at line 173 of file MSMeanData.h.

◆ myLastVehicleUpdateValues

std::map<SUMOTrafficObject*, std::pair<SUMOTime, double> > MSMoveReminder::myLastVehicleUpdateValues
privateinherited

◆ myParent

const MSMeanData_Net* MSMeanData_Net::MSLaneMeanDataValues::myParent
private

The meandata parent.

Definition at line 195 of file MSMeanData_Net.h.

◆ nVehArrived

int MSMeanData_Net::MSLaneMeanDataValues::nVehArrived

The number of vehicles that finished on the lane.

Definition at line 153 of file MSMeanData_Net.h.

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

◆ nVehDeparted

int MSMeanData_Net::MSLaneMeanDataValues::nVehDeparted

◆ nVehEntered

int MSMeanData_Net::MSLaneMeanDataValues::nVehEntered

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

Definition at line 156 of file MSMeanData_Net.h.

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

◆ nVehLaneChangeFrom

int MSMeanData_Net::MSLaneMeanDataValues::nVehLaneChangeFrom
private

The number of vehicles that changed from this lane.

Definition at line 172 of file MSMeanData_Net.h.

Referenced by addTo().

◆ nVehLaneChangeTo

int MSMeanData_Net::MSLaneMeanDataValues::nVehLaneChangeTo
private

The number of vehicles that changed to this lane.

Definition at line 175 of file MSMeanData_Net.h.

Referenced by addTo().

◆ nVehLeft

int MSMeanData_Net::MSLaneMeanDataValues::nVehLeft

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

Definition at line 159 of file MSMeanData_Net.h.

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

◆ nVehVaporized

int MSMeanData_Net::MSLaneMeanDataValues::nVehVaporized

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

Definition at line 162 of file MSMeanData_Net.h.

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

◆ occupationSum

double MSMeanData_Net::MSLaneMeanDataValues::occupationSum
private

The sum of the occupation of the lane.

Definition at line 187 of file MSMeanData_Net.h.

Referenced by addTo().

◆ sampleSeconds

double MSMeanData::MeanDataValues::sampleSeconds
protectedinherited

◆ timeLoss

double MSMeanData_Net::MSLaneMeanDataValues::timeLoss

The time loss accrued by vehicle probes.

Definition at line 168 of file MSMeanData_Net.h.

Referenced by addTo().

◆ travelledDistance

double MSMeanData::MeanDataValues::travelledDistance
protectedinherited

◆ vehLengthSum

double MSMeanData_Net::MSLaneMeanDataValues::vehLengthSum
private

The sum of the lengths the vehicles had.

Definition at line 184 of file MSMeanData_Net.h.

Referenced by addTo().

◆ waitSeconds

double MSMeanData_Net::MSLaneMeanDataValues::waitSeconds

The number of vehicle probes with small speed.

Definition at line 165 of file MSMeanData_Net.h.

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


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