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:
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...
 
virtual 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_Emissions *parent=0)
 Constructor. More...
 
virtual bool notifyEnter (SUMOVehicle &veh, MSMoveReminder::Notification reason)
 Called if the vehicle enters the reminder's lane. More...
 
virtual bool notifyLeave (SUMOVehicle &veh, SUMOReal lastPos, MSMoveReminder::Notification reason)
 Called if the vehicle leaves the reminder's lane. 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...
 
void setDescription (const std::string &description)
 
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...
 

Protected Member Functions

void notifyMoveInternal (SUMOVehicle &veh, SUMOReal timeOnLane, SUMOReal speed)
 Internal notification about the vehicle moves. More...
 

Protected Attributes

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...
 
const std::set< std::string > *const myVehicleTypes
 The vehicle types to look for (0 or empty means all) More...
 

Private Attributes

PollutantsInterface::Emissions myEmissions
 Collected values. More...
 
const MSMeanData_EmissionsmyParent
 The meandata parent. More...
 

Collected values

The number of sampled vehicle movements (in s)

SUMOReal sampleSeconds
 
SUMOReal travelledDistance
 The sum of the distances the vehicles travelled. 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 72 of file MSMeanData_Emissions.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 95 of file MSMoveReminder.h.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 53 of file MSMeanData_Emissions.cpp.

MSMeanData_Emissions::MSLaneMeanDataValues::~MSLaneMeanDataValues ( )
virtual

Destructor.

Definition at line 61 of file MSMeanData_Emissions.cpp.

Member Function Documentation

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 74 of file MSMeanData_Emissions.cpp.

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

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

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

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

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

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

bool MSMeanData::MeanDataValues::notifyEnter ( SUMOVehicle veh,
MSMoveReminder::Notification  reason 
)
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, MSMeanData_Amitran::MSLaneMeanDataValues, and MSMeanData_Harmonoise::MSLaneMeanDataValues.

Definition at line 78 of file MSMeanData.cpp.

References UNUSED_PARAMETER.

bool MSMeanData::MeanDataValues::notifyLeave ( SUMOVehicle veh,
SUMOReal  lastPos,
MSMoveReminder::Notification  reason 
)
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 113 of file MSMeanData.cpp.

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

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

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

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

References PollutantsInterface::computeAll(), SUMOVehicle::getAcceleration(), MSVehicleType::getEmissionClass(), SUMOVehicle::getSlope(), and SUMOVehicle::getVehicleType().

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 66 of file MSMeanData_Emissions.cpp.

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

Definition at line 211 of file MSMoveReminder.h.

References MSMoveReminder::myDescription.

Referenced by MSMeanData::init(), and MSCalibrator::MSCalibrator().

void MSMeanData::MeanDataValues::update ( )
virtualinherited

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

Reimplemented in MSMeanData_Harmonoise::MSLaneMeanDataValues.

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

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

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

References OutputDevice::closeTag(), PollutantsInterface::CO, PollutantsInterface::CO2, PollutantsInterface::computeDefault(), PollutantsInterface::FUEL, MSVehicleType::getCarFollowModel(), MSVehicleType::getEmissionClass(), MSNet::getInstance(), MSCFModel::getMaxAccel(), MSVehicleType::getMaxSpeed(), MSNet::getVehicleControl(), MSVehicleControl::getVType(), PollutantsInterface::HC, MIN2(), PollutantsInterface::NO_X, PollutantsInterface::PM_X, OutputDevice::realString(), STEPS2TIME, and SUMOReal.

Field Documentation

std::string MSMoveReminder::myDescription
protectedinherited

a description of this moveReminder

Definition at line 229 of file MSMoveReminder.h.

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

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

Collected values.

Definition at line 125 of file MSMeanData_Emissions.h.

Referenced by addTo().

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

const MSMeanData_Emissions* MSMeanData_Emissions::MSLaneMeanDataValues::myParent
private

The meandata parent.

Definition at line 127 of file MSMeanData_Emissions.h.

const std::set<std::string>* const MSMeanData::MeanDataValues::myVehicleTypes
protectedinherited

The vehicle types to look for (0 or empty means all)

Definition at line 186 of file MSMeanData.h.

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

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