Eclipse SUMO - Simulation of Urban MObility
MSMeanData::MeanDataValues Class Referenceabstract

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

#include <MSMeanData.h>

Inheritance diagram for MSMeanData::MeanDataValues:
Collaboration diagram for MSMeanData::MeanDataValues:

Public Types

enum  Notification {
  NOTIFICATION_DEPARTED, NOTIFICATION_JUNCTION, NOTIFICATION_SEGMENT, NOTIFICATION_LANE_CHANGE,
  NOTIFICATION_TELEPORT, NOTIFICATION_PARKING, NOTIFICATION_ARRIVED, NOTIFICATION_VAPORIZED,
  NOTIFICATION_TELEPORT_ARRIVED, NOTIFICATION_PARKING_REROUTE
}
 Definition of a vehicle state. More...
 

Public Member Functions

virtual void addTo (MeanDataValues &val) const =0
 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...
 
virtual bool isEmpty () const
 Returns whether any data was collected. More...
 
 MeanDataValues (MSLane *const lane, const double length, const bool doAdd, const MSMeanData *const parent)
 Constructor. More...
 
virtual bool notifyEnter (SUMOTrafficObject &veh, MSMoveReminder::Notification reason, const MSLane *enteredLane=0)
 Called if the vehicle enters the reminder's lane. More...
 
virtual bool notifyLeave (SUMOTrafficObject &veh, double lastPos, MSMoveReminder::Notification reason, const MSLane *enteredLane=0)
 Called if the vehicle leaves the reminder's lane. 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...
 
virtual void notifyMoveInternal (const SUMOTrafficObject &veh, const double frontOnLane, const double timeOnLane, const double meanSpeedFrontOnLane, const double meanSpeedVehicleOnLane, const double travelledDistanceFrontOnLane, const double travelledDistanceVehicleOnLane, const double meanLengthOnLane)
 Internal notification about the vehicle moves. More...
 
virtual void reset (bool afterWrite=false)=0
 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 void write (OutputDevice &dev, const SUMOTime period, const double numLanes, const double defaultTravelTime, const int numVehicles=-1) const =0
 Writes output values into the given stream. More...
 
virtual ~MeanDataValues ()
 Destructor. More...
 
Interface methods, to be derived by subclasses
void updateDetector (SUMOTrafficObject &veh, double entryPos, double leavePos, SUMOTime entryTime, SUMOTime currentTime, SUMOTime leaveTime, bool cleanUp)
 

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...
 
const MSMeanData *const myParent
 The meandata parent. 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
 

Detailed Description

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

Structure holding values that describe the emissions (XXX: emissions?) aggregated, refs. #2579 over some seconds.

Definition at line 69 of file MSMeanData.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_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.

NOTIFICATION_PARKING_REROUTE 

The vehicle needs another parking area.

Definition at line 89 of file MSMoveReminder.h.

Constructor & Destructor Documentation

◆ MeanDataValues()

MSMeanData::MeanDataValues::MeanDataValues ( MSLane *const  lane,
const double  length,
const bool  doAdd,
const MSMeanData *const  parent 
)

Constructor.

Definition at line 58 of file MSMeanData.cpp.

◆ ~MeanDataValues()

MSMeanData::MeanDataValues::~MeanDataValues ( )
virtual

Destructor.

Definition at line 68 of file MSMeanData.cpp.

Member Function Documentation

◆ addTo()

virtual void MSMeanData::MeanDataValues::addTo ( MeanDataValues val) const
pure virtual

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

Parameters
[in]valThe meandata to add to

Implemented in MSMeanData::MeanDataValueTracker, MSMeanData_Net::MSLaneMeanDataValues, MSMeanData_Amitran::MSLaneMeanDataValues, MSMeanData_Emissions::MSLaneMeanDataValues, and MSMeanData_Harmonoise::MSLaneMeanDataValues.

Referenced by MSMeanData::writeEdge().

◆ getDescription()

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

Definition at line 228 of file MSMoveReminder.h.

References MSMoveReminder::myDescription.

◆ getLane()

const MSLane* MSMoveReminder::getLane ( ) const
inlineinherited

◆ getSamples()

double MSMeanData::MeanDataValues::getSamples ( ) const
virtual

Returns the number of collected sample seconds.

Returns
the number of collected sample seconds

Reimplemented in MSMeanData::MeanDataValueTracker.

Definition at line 275 of file MSMeanData.cpp.

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

◆ getTravelledDistance()

double MSMeanData::MeanDataValues::getTravelledDistance ( ) const
inline

Returns the total travelled distance.

Returns
the total travelled distance

Definition at line 159 of file MSMeanData.h.

References travelledDistance.

Referenced by MSCalibrator::currentSpeed(), and MSCalibrator::writeXMLOutput().

◆ isEmpty()

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

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

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

◆ notifyEnter()

bool MSMeanData::MeanDataValues::notifyEnter ( SUMOTrafficObject veh,
MSMoveReminder::Notification  reason,
const MSLane enteredLane = 0 
)
virtual

Called if the vehicle enters the reminder's lane.

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

Reimplemented from MSMoveReminder.

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

Definition at line 73 of file MSMeanData.cpp.

References SUMOTrafficObject::getID(), Named::getID(), SIMTIME, and UNUSED_PARAMETER.

◆ notifyLeave()

bool MSMeanData::MeanDataValues::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]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 255 of file MSMeanData.cpp.

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

◆ notifyMove()

bool MSMeanData::MeanDataValues::notifyMove ( SUMOTrafficObject veh,
double  oldPos,
double  newPos,
double  newSpeed 
)
virtual

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

◆ notifyMoveInternal()

virtual void MSMoveReminder::notifyMoveInternal ( const SUMOTrafficObject veh,
const double  frontOnLane,
const double  timeOnLane,
const double  meanSpeedFrontOnLane,
const double  meanSpeedVehicleOnLane,
const double  travelledDistanceFrontOnLane,
const double  travelledDistanceVehicleOnLane,
const double  meanLengthOnLane 
)
inlinevirtualinherited

Internal notification about the vehicle moves.

Note
meso uses this though it never calls notifyMove()

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]frontOnLanetime the front of the vehicle spent on the lane.
[in]timeOnLanetime some part of the vehicle spent on the lane.
[in]meanSpeedFrontOnLaneAverage speed for the time that the front is on the lane.
[in]meanSpeedVehicleOnLaneAverage speed for the time that the vehicle is on the lane (with front or back).
[in]travelledDistanceFrontOnLanedistance travelled while overlapping with the lane.
[in]travelledDistanceVehicleOnLanedistance travelled while front was on the lane.
[in]meanLengthOnLanethe average length of the vehicle's part on the lane during the last step (==complete length in meso case)

Reimplemented in MSMeanData_Amitran::MSLaneMeanDataValues, MSMeanData_Emissions::MSLaneMeanDataValues, MSMeanData_Harmonoise::MSLaneMeanDataValues, MSMeanData_Net::MSLaneMeanDataValues, MSDevice_Tripinfo, MSDevice_Transportable, and MSMeanData::MeanDataValueTracker.

Definition at line 206 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

Referenced by MSMoveReminder::updateDetector().

◆ removeFromVehicleUpdateValues()

void MSMoveReminder::removeFromVehicleUpdateValues ( SUMOTrafficObject veh)
protectedinherited

◆ reset()

virtual void MSMeanData::MeanDataValues::reset ( bool  afterWrite = false)
pure virtual

◆ setDescription()

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

◆ update()

void MSMeanData::MeanDataValues::update ( )
virtual

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

Reimplemented in MSMeanData_Harmonoise::MSLaneMeanDataValues.

Definition at line 270 of file MSMeanData.cpp.

◆ updateDetector()

void MSMoveReminder::updateDetector ( SUMOTrafficObject veh,
double  entryPos,
double  leavePos,
SUMOTime  entryTime,
SUMOTime  currentTime,
SUMOTime  leaveTime,
bool  cleanUp 
)
inherited

◆ write()

virtual void MSMeanData::MeanDataValues::write ( OutputDevice dev,
const SUMOTime  period,
const double  numLanes,
const double  defaultTravelTime,
const int  numVehicles = -1 
) const
pure 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)

Implemented in MSMeanData::MeanDataValueTracker, MSMeanData_Net::MSLaneMeanDataValues, MSMeanData_Amitran::MSLaneMeanDataValues, MSMeanData_Harmonoise::MSLaneMeanDataValues, and MSMeanData_Emissions::MSLaneMeanDataValues.

Referenced by MSMeanData::writeEdge().

Field Documentation

◆ myDescription

std::string MSMoveReminder::myDescription
protectedinherited

a description of this moveReminder

Definition at line 240 of file MSMoveReminder.h.

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

◆ myLane

◆ myLaneLength

const double MSMeanData::MeanDataValues::myLaneLength
protected

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

Definition at line 168 of file MSMeanData.h.

◆ myLastVehicleUpdateValues

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

◆ myParent

const MSMeanData* const MSMeanData::MeanDataValues::myParent
protected

The meandata parent.

Definition at line 165 of file MSMeanData.h.

◆ sampleSeconds

◆ travelledDistance

double MSMeanData::MeanDataValues::travelledDistance
protected

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