SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MSMeanData::MeanDataValues Class Referenceabstract

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

#include <MSMeanData.h>

Inheritance diagram for MSMeanData::MeanDataValues:
MSMoveReminder MSMeanData::MeanDataValueTracker MSMeanData_Amitran::MSLaneMeanDataValues MSMeanData_Emissions::MSLaneMeanDataValues MSMeanData_Harmonoise::MSLaneMeanDataValues MSMeanData_Net::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
}
 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 SUMOReal getSamples () const
 Returns the number of collected sample seconds. More...
 
virtual bool isEmpty () const
 Returns whether any data was collected. More...
 
 MeanDataValues (MSLane *const lane, const SUMOReal length, const bool doAdd, const std::set< std::string > *const vTypes=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...
 
virtual void notifyMoveInternal (SUMOVehicle &veh, SUMOReal timeOnLane, SUMOReal speed)
 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...
 
bool vehicleApplies (const SUMOVehicle &veh) const
 Tests whether the vehicles type is to be regarded. More...
 
virtual void write (OutputDevice &dev, const SUMOTime period, const SUMOReal numLanes, const SUMOReal defaultTravelTime, const int numVehicles=-1) const =0
 Writes output values into the given stream. More...
 
virtual ~MeanDataValues ()
 Destructor. 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...
 

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 75 of file MSMeanData.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::MeanDataValues::MeanDataValues ( MSLane *const  lane,
const SUMOReal  length,
const bool  doAdd,
const std::set< std::string > *const  vTypes = 0 
)

Constructor.

Definition at line 63 of file MSMeanData.cpp.

MSMeanData::MeanDataValues::~MeanDataValues ( )
virtual

Destructor.

Definition at line 73 of file MSMeanData.cpp.

Member Function Documentation

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

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

Definition at line 214 of file MSMoveReminder.h.

References MSMoveReminder::myDescription.

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

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

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

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

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

References MSMoveReminder::NOTIFICATION_JUNCTION.

bool MSMeanData::MeanDataValues::notifyMove ( SUMOVehicle veh,
SUMOReal  oldPos,
SUMOReal  newPos,
SUMOReal  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 SUMOVehicle::getID(), MSVehicleType::getLength(), SUMOVehicle::getVehicleType(), SUMOVehicle::hasArrived(), SUMOReal, TS, and WRITE_ERROR.

virtual void MSMoveReminder::notifyMoveInternal ( SUMOVehicle veh,
SUMOReal  timeOnLane,
SUMOReal  speed 
)
inlinevirtualinherited

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 in MSMeanData::MeanDataValueTracker, MSMeanData_Net::MSLaneMeanDataValues, MSMeanData_Harmonoise::MSLaneMeanDataValues, MSMeanData_Amitran::MSLaneMeanDataValues, and MSMeanData_Emissions::MSLaneMeanDataValues.

Definition at line 202 of file MSMoveReminder.h.

References UNUSED_PARAMETER.

virtual void MSMeanData::MeanDataValues::reset ( bool  afterWrite = false)
pure virtual
void MSMoveReminder::setDescription ( const std::string &  description)
inlineinherited

Definition at line 210 of file MSMoveReminder.h.

References MSMoveReminder::myDescription.

Referenced by MSCalibrator::MSCalibrator().

void MSMeanData::MeanDataValues::update ( )
virtual

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

Reimplemented in MSMeanData_Harmonoise::MSLaneMeanDataValues.

Definition at line 132 of file MSMeanData.cpp.

bool MSMeanData::MeanDataValues::vehicleApplies ( const SUMOVehicle veh) const

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

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

virtual void MSMeanData::MeanDataValues::write ( OutputDevice dev,
const SUMOTime  period,
const SUMOReal  numLanes,
const SUMOReal  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

std::string MSMoveReminder::myDescription
protectedinherited

a description of this moveReminder

Definition at line 223 of file MSMoveReminder.h.

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

MSLane* const MSMoveReminder::myLane
protectedinherited
const SUMOReal MSMeanData::MeanDataValues::myLaneLength
protected

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

Definition at line 172 of file MSMeanData.h.

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

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

Definition at line 185 of file MSMeanData.h.


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