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

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

#include <MSMeanData_Emissions.h>

Inheritance diagram for MSMeanData_Emissions::MSLaneMeanDataValues:
Collaboration diagram for MSMeanData_Emissions::MSLaneMeanDataValues:

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

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...
 
virtual bool isEmpty () const
 Returns whether any data was collected. More...
 
 MSLaneMeanDataValues (MSLane *const lane, const double length, const bool doAdd, const MSMeanData_Emissions *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...
 
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...
 
void write (OutputDevice &dev, const SUMOTime period, const double numLanes, const double defaultTravelTime, const int numVehicles=-1) const
 Writes output values into the given stream. More...
 
virtual ~MSLaneMeanDataValues ()
 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 notifyMoveInternal (const SUMOTrafficObject &veh, const double, const double timeOnLane, const double, const double meanSpeedVehicleOnLane, const double travelledDistanceFrontOnLane, const double travelledDistanceVehicleOnLane, const double)
 Internal notification about the vehicle moves. More...
 
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

PollutantsInterface::Emissions myEmissions
 Collected values. More...
 

Detailed Description

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

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

Definition at line 65 of file MSMeanData_Emissions.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

◆ MSLaneMeanDataValues()

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

Constructor.

Definition at line 43 of file MSMeanData_Emissions.cpp.

◆ ~MSLaneMeanDataValues()

MSMeanData_Emissions::MSLaneMeanDataValues::~MSLaneMeanDataValues ( )
virtual

Destructor.

Definition at line 50 of file MSMeanData_Emissions.cpp.

Member Function Documentation

◆ addTo()

void MSMeanData_Emissions::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 63 of file MSMeanData_Emissions.cpp.

References PollutantsInterface::Emissions::addScaled(), myEmissions, MSMeanData::MeanDataValues::sampleSeconds, and MSMeanData::MeanDataValues::travelledDistance.

◆ getDescription()

◆ getLane()

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

References MSMeanData::MeanDataValues::sampleSeconds.

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

◆ getTravelledDistance()

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

Returns the total travelled distance.

Returns
the total travelled distance

Definition at line 159 of file MSMeanData.h.

References MSMeanData::MeanDataValues::travelledDistance.

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

◆ isEmpty()

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

References MSMeanData::MeanDataValues::sampleSeconds.

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

◆ notifyEnter()

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

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(), MSMeanData::MeanDataValues::myParent, SIMTIME, UNUSED_PARAMETER, and MSDetectorFileOutput::vehicleApplies().

◆ notifyLeave()

bool MSMeanData::MeanDataValues::notifyLeave ( SUMOTrafficObject veh,
double  lastPos,
MSMoveReminder::Notification  reason,
const MSLane enteredLane = 0 
)
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 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 
)
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 SUMOTrafficObject::getID(), Named::getID(), MSMoveReminder::getLane(), MSVehicleType::getLength(), SUMOTrafficObject::getPreviousSpeed(), SUMOTrafficObject::getVehicleType(), MSGlobals::gSemiImplicitEulerUpdate, SUMOTrafficObject::hasArrived(), MAX2(), MIN2(), MIN4(), MSMoveReminder::myLane, MSMeanData::MeanDataValues::myLaneLength, MSMoveReminder::notifyMoveInternal(), NUMERICAL_EPS, MSCFModel::passingTime(), MSCFModel::speedAfterTime(), TS, and WRITE_ERROR.

◆ notifyMoveInternal()

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

◆ removeFromVehicleUpdateValues()

void MSMoveReminder::removeFromVehicleUpdateValues ( SUMOTrafficObject veh)
protectedinherited

◆ reset()

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

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

Implements MSMeanData::MeanDataValues.

Definition at line 55 of file MSMeanData_Emissions.cpp.

References myEmissions, MSMeanData::MeanDataValues::sampleSeconds, and MSMeanData::MeanDataValues::travelledDistance.

◆ setDescription()

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

◆ 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 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()

void MSMeanData_Emissions::MSLaneMeanDataValues::write ( OutputDevice dev,
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]prefixThe xml prefix to write (mostly the lane / edge id)
[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 83 of file MSMeanData_Emissions.cpp.

References OutputDevice::closeTag(), PollutantsInterface::CO, PollutantsInterface::Emissions::CO, PollutantsInterface::CO2, PollutantsInterface::Emissions::CO2, PollutantsInterface::computeDefault(), PollutantsInterface::ELEC, PollutantsInterface::Emissions::electricity, PollutantsInterface::FUEL, PollutantsInterface::Emissions::fuel, MSVehicleType::getCarFollowModel(), MSVehicleType::getEmissionClass(), MSNet::getInstance(), MSCFModel::getMaxAccel(), MSVehicleType::getMaxSpeed(), MSMeanData::getMaxTravelTime(), MSMeanData::getMinSamples(), MSNet::getVehicleControl(), MSVehicleControl::getVType(), PollutantsInterface::HC, PollutantsInterface::Emissions::HC, MIN2(), myEmissions, MSMeanData::MeanDataValues::myLaneLength, MSMeanData::MeanDataValues::myParent, PollutantsInterface::NO_X, PollutantsInterface::Emissions::NOx, PollutantsInterface::PM_X, PollutantsInterface::Emissions::PMx, OutputDevice::realString(), MSMeanData::MeanDataValues::sampleSeconds, STEPS2TIME, and MSMeanData::MeanDataValues::travelledDistance.

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().

◆ myEmissions

PollutantsInterface::Emissions MSMeanData_Emissions::MSLaneMeanDataValues::myEmissions
private

Collected values.

Definition at line 109 of file MSMeanData_Emissions.h.

Referenced by addTo(), notifyMoveInternal(), reset(), and write().

◆ myLane

◆ myLaneLength

const double MSMeanData::MeanDataValues::myLaneLength
protectedinherited

◆ myParent

◆ sampleSeconds

◆ travelledDistance


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