SUMO - Simulation of Urban MObility
MSMeanData_Net::MSLaneMeanDataValues Class Reference

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

#include <MSMeanData_Net.h>

Inheritance diagram for MSMeanData_Net::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.
const MSLanegetLane () const
 Returns the lane the reminder works on.
virtual SUMOReal getSamples () const
 Returns the number of collected sample seconds.
bool isEmpty () const
 Returns whether any data was collected.
 MSLaneMeanDataValues (MSLane *const lane, const SUMOReal length, const bool doAdd, const std::set< std::string > *const vTypes=0, const MSMeanData_Net *parent=0)
 Constructor.
bool notifyMove (SUMOVehicle &veh, SUMOReal oldPos, SUMOReal newPos, SUMOReal newSpeed)
 Checks whether the reminder still has to be notified about the vehicle moves.
void reset (bool afterWrite=false)
 Resets values so they may be used for the next interval.
virtual void update ()
 Called if a per timestep update is needed. Default does nothing.
bool vehicleApplies (const SUMOVehicle &veh) const
 Tests whether the vehicles type is to be regarded.
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.
virtual ~MSLaneMeanDataValues ()
 Destructor.
Methods inherited from MSMoveReminder
bool notifyLeave (SUMOVehicle &veh, SUMOReal lastPos, MSMoveReminder::Notification reason)
 Called if the vehicle leaves the reminder's lane.
bool notifyEnter (SUMOVehicle &veh, MSMoveReminder::Notification reason)
 Computes current values and adds them to their sums.

Protected Member Functions

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

Protected Attributes

MSLane *const myLane
 Lane on which the reminder works.
const SUMOReal myLaneLength
 The length of the lane / edge the data collector is on.

Private Attributes

const MSMeanData_NetmyParent
 The meandata parent.

Collected values

The number of sampled vehicle movements (in s)

SUMOReal travelledDistance
 The sum of the distances the vehicles travelled.
SUMOReal sampleSeconds

Collected values

The number of vehicles that were emitted on the lane

unsigned nVehDeparted
unsigned nVehArrived
 The number of vehicles that finished on the lane.
unsigned nVehEntered
 The number of vehicles that entered this lane within the sample interval.
unsigned nVehLeft
 The number of vehicles that left this lane within the sample interval.
unsigned nVehLaneChangeFrom
 The number of vehicles that changed from this lane.
unsigned nVehLaneChangeTo
 The number of vehicles that changed to this lane.
SUMOReal waitSeconds
 The number of vehicle probes with small speed.
SUMOReal vehLengthSum
 The sum of the lengths the vehicles had.

Detailed Description

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

Structure holding values that describe the flow and other physical properties aggregated over some seconds.

Definition at line 74 of file MSMeanData_Net.h.


Member Enumeration Documentation

enum MSMoveReminder::Notification [inherited]

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 93 of file MSMoveReminder.h.


Constructor & Destructor Documentation

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

Constructor.

Parameters:
[in]lengthThe length of the object for which the data gets collected

Definition at line 59 of file MSMeanData_Net.cpp.

Destructor.

Definition at line 69 of file MSMeanData_Net.cpp.


Member Function Documentation

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 89 of file MSMeanData_Net.cpp.

References nVehArrived, nVehDeparted, nVehEntered, nVehLaneChangeFrom, nVehLaneChangeTo, nVehLeft, MSMeanData::MeanDataValues::sampleSeconds, MSMeanData::MeanDataValues::travelledDistance, vehLengthSum, and waitSeconds.

SUMOReal MSMeanData::MeanDataValues::getSamples ( ) const [virtual, inherited]

Returns the number of collected sample seconds.

Returns:
the number of collected sample seconds

Reimplemented in MSMeanData::MeanDataValueTracker.

Definition at line 134 of file MSMeanData.cpp.

Referenced by MSMeanData::writePrefix().

Returns whether any data was collected.

Returns:
whether no data was collected

Reimplemented from MSMeanData::MeanDataValues.

Definition at line 159 of file MSMeanData_Net.cpp.

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 vehicle that enters the lane
[in]vehThe entering vehicle.
[in]reasonhow the vehicle enters the lane
Returns:
Always true
See also:
MSMoveReminder::notifyEnter
MSMoveReminder::Notification

Reimplemented from MSMeanData::MeanDataValues.

Definition at line 141 of file MSMeanData_Net.cpp.

References MSMoveReminder::NOTIFICATION_DEPARTED, MSMoveReminder::NOTIFICATION_LANE_CHANGE, and MSMoveReminder::NOTIFICATION_SEGMENT.

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 116 of file MSMeanData_Net.cpp.

References MSGlobals::gUseMesoSim, MSMoveReminder::NOTIFICATION_ARRIVED, MSMoveReminder::NOTIFICATION_JUNCTION, MSMoveReminder::NOTIFICATION_LANE_CHANGE, and MSMoveReminder::NOTIFICATION_SEGMENT.

bool MSMeanData::MeanDataValues::notifyMove ( SUMOVehicle veh,
SUMOReal  oldPos,
SUMOReal  newPos,
SUMOReal  newSpeed 
) [virtual, inherited]

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

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

void MSMeanData_Net::MSLaneMeanDataValues::notifyMoveInternal ( SUMOVehicle veh,
SUMOReal  timeOnLane,
SUMOReal  speed 
) [protected, 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 105 of file MSMeanData_Net.cpp.

References MSVehicleType::getLength(), SUMOVehicle::getVehicleType(), and MSMeanData_Net::myHaltSpeed.

void MSMeanData_Net::MSLaneMeanDataValues::reset ( bool  afterWrite = false) [virtual]

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

Implements MSMeanData::MeanDataValues.

Definition at line 74 of file MSMeanData_Net.cpp.

void MSMeanData::MeanDataValues::update ( ) [virtual, inherited]

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

Reimplemented in MSMeanData_Harmonoise::MSLaneMeanDataValues.

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

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

void MSMeanData_Net::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]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 165 of file MSMeanData_Net.cpp.

References OutputDevice::closeTag(), MIN2(), STEPS2TIME, and SUMOReal.


Field Documentation

MSLane* const MSMoveReminder::myLane [protected, inherited]
const SUMOReal MSMeanData::MeanDataValues::myLaneLength [protected, inherited]

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

Definition at line 173 of file MSMeanData.h.

The meandata parent.

Definition at line 184 of file MSMeanData_Net.h.

The number of vehicles that finished on the lane.

Definition at line 161 of file MSMeanData_Net.h.

Referenced by addTo().

Definition at line 158 of file MSMeanData_Net.h.

Referenced by addTo().

The number of vehicles that entered this lane within the sample interval.

Definition at line 164 of file MSMeanData_Net.h.

Referenced by addTo().

The number of vehicles that changed from this lane.

Definition at line 171 of file MSMeanData_Net.h.

Referenced by addTo().

The number of vehicles that changed to this lane.

Definition at line 174 of file MSMeanData_Net.h.

Referenced by addTo().

The number of vehicles that left this lane within the sample interval.

Definition at line 167 of file MSMeanData_Net.h.

Referenced by addTo().

The sum of the distances the vehicles travelled.

Definition at line 181 of file MSMeanData.h.

Referenced by MSMeanData_Harmonoise::MSLaneMeanDataValues::addTo(), MSMeanData_HBEFA::MSLaneMeanDataValues::addTo(), and addTo().

The sum of the lengths the vehicles had.

Definition at line 180 of file MSMeanData_Net.h.

Referenced by addTo().

The number of vehicle probes with small speed.

Definition at line 177 of file MSMeanData_Net.h.

Referenced by addTo().


The documentation for this class was generated from the following files:
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Defines