SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
MSMeanData::MeanDataValueTracker Class Reference

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

#include <MSMeanData.h>

Inheritance diagram for MSMeanData::MeanDataValueTracker:
MSMeanData::MeanDataValues MSMoveReminder

Data Structures

class  TrackerEntry
 

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...
 
void clearFirst ()
 
const std::string & getDescription () const
 
const MSLanegetLane () const
 Returns the lane the reminder works on. More...
 
int getNumReady () const
 
SUMOReal getSamples () const
 Returns the number of collected sample seconds. More...
 
bool isEmpty () const
 Returns whether any data was collected. More...
 
 MeanDataValueTracker (MSLane *const lane, const SUMOReal length, const std::set< std::string > *const vTypes=0, const MSMeanData *const parent=0)
 Constructor. 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)
 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 ~MeanDataValueTracker ()
 Destructor. More...
 
Methods inherited from MSMoveReminder
void notifyMoveInternal (SUMOVehicle &veh, SUMOReal timeOnLane, SUMOReal speed)
 Internal notification about the vehicle moves. More...
 
bool notifyLeave (SUMOVehicle &veh, SUMOReal lastPos, MSMoveReminder::Notification reason)
 Called if the vehicle leaves the reminder's lane. More...
 
bool notifyEnter (SUMOVehicle &veh, MSMoveReminder::Notification reason)
 Computes current values and adds them to their sums. 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

std::list< TrackerEntry * > myCurrentData
 The currently active meandata "intervals". More...
 
const MSMeanDatamyParent
 The meandata parent. More...
 
std::map< SUMOVehicle
*, TrackerEntry * > 
myTrackedData
 The map of vehicles to data entries. 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 for tracked vehicles.

Definition at line 195 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::MeanDataValueTracker::MeanDataValueTracker ( MSLane *const  lane,
const SUMOReal  length,
const std::set< std::string > *const  vTypes = 0,
const MSMeanData *const  parent = 0 
)

Constructor.

Definition at line 150 of file MSMeanData.cpp.

References MSMeanData::createValues(), and myCurrentData.

MSMeanData::MeanDataValueTracker::~MeanDataValueTracker ( )
virtual

Destructor.

Definition at line 159 of file MSMeanData.cpp.

Member Function Documentation

void MSMeanData::MeanDataValueTracker::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 174 of file MSMeanData.cpp.

void MSMeanData::MeanDataValueTracker::clearFirst ( )
const std::string& MSMoveReminder::getDescription ( ) const
inlineinherited

Definition at line 215 of file MSMoveReminder.h.

References MSMoveReminder::myDescription.

int MSMeanData::MeanDataValueTracker::getNumReady ( ) const

Definition at line 232 of file MSMeanData.cpp.

SUMOReal MSMeanData::MeanDataValueTracker::getSamples ( ) const
virtual

Returns the number of collected sample seconds.

Returns
the number of collected sample seconds

Reimplemented from MSMeanData::MeanDataValues.

Definition at line 246 of file MSMeanData.cpp.

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

Returns whether any data was collected.

Returns
whether no data was collected

Reimplemented from MSMeanData::MeanDataValues.

Definition at line 214 of file MSMeanData.cpp.

bool MSMeanData::MeanDataValueTracker::notifyEnter ( SUMOVehicle veh,
MSMoveReminder::Notification  reason 
)
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 entering vehicle.
[in]reasonhow the vehicle enters the lane
See also
MSMoveReminder::notifyEnter
Returns
Always true

Reimplemented from MSMeanData::MeanDataValues.

Definition at line 195 of file MSMeanData.cpp.

References MSMoveReminder::NOTIFICATION_SEGMENT.

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

References MSMoveReminder::NOTIFICATION_SEGMENT.

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::MeanDataValueTracker::notifyMoveInternal ( SUMOVehicle veh,
SUMOReal  timeOnLane,
SUMOReal  speed 
)
virtual

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

void MSMeanData::MeanDataValueTracker::reset ( bool  afterWrite)
virtual

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

Implements MSMeanData::MeanDataValues.

Definition at line 164 of file MSMeanData.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::MeanDataValueTracker::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]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 220 of file MSMeanData.cpp.

Field Documentation

std::list<TrackerEntry*> MSMeanData::MeanDataValueTracker::myCurrentData
private

The currently active meandata "intervals".

Definition at line 297 of file MSMeanData.h.

Referenced by MeanDataValueTracker().

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

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* MSMeanData::MeanDataValueTracker::myParent
private

The meandata parent.

Definition at line 300 of file MSMeanData.h.

std::map<SUMOVehicle*, TrackerEntry*> MSMeanData::MeanDataValueTracker::myTrackedData
private

The map of vehicles to data entries.

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


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