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

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

#include <MSMeanData_Amitran.h>

Inheritance diagram for MSMeanData_Amitran::MSLaneMeanDataValues:
Inheritance graph
Collaboration diagram for MSMeanData_Amitran::MSLaneMeanDataValues:
Collaboration graph

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...
 
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_Amitran *parent=0)
 Constructor. 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...
 
Methods inherited from MSMoveReminder
bool notifyEnter (SUMOVehicle &veh, MSMoveReminder::Notification reason)
 Computes current values and adds them to their sums. More...
 
Interface methods, to be derived by subclasses
void updateDetector (SUMOVehicle &veh, SUMOReal entryPos, SUMOReal leavePos, SUMOTime entryTime, SUMOTime currentTime, SUMOTime leaveTime, bool cleanUp)
 

Protected Member Functions

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

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

Collected values

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

unsigned amount
 
std::map< const MSVehicleType *, unsigned > typedAmount
 The number of vehicles that entered this lane within the sample interval by type. More...
 
std::map< const MSVehicleType *, SUMORealtypedSamples
 The number of sampled vehicle movements by type (in s) More...
 
std::map< const MSVehicleType *, SUMORealtypedTravelDistance
 The sum of the distances the vehicles travelled by type. 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 flow and other physical properties aggregated over some seconds.

Definition at line 73 of file MSMeanData_Amitran.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_Amitran::MSLaneMeanDataValues::MSLaneMeanDataValues ( MSLane *const  lane,
const SUMOReal  length,
const bool  doAdd,
const std::set< std::string > *const  vTypes = 0,
const MSMeanData_Amitran parent = 0 
)

Constructor.

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

Definition at line 53 of file MSMeanData_Amitran.cpp.

MSMeanData_Amitran::MSLaneMeanDataValues::~MSLaneMeanDataValues ( )
virtual

Destructor.

Definition at line 61 of file MSMeanData_Amitran.cpp.

Member Function Documentation

void MSMeanData_Amitran::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 75 of file MSMeanData_Amitran.cpp.

References amount, MSMeanData::MeanDataValues::sampleSeconds, MSMeanData::MeanDataValues::travelledDistance, typedAmount, typedSamples, and typedTravelDistance.

const std::string& MSMoveReminder::getDescription ( ) const
inlineinherited
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 138 of file MSMeanData.cpp.

References MSMeanData::MeanDataValues::sampleSeconds.

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

bool MSMeanData_Amitran::MSLaneMeanDataValues::isEmpty ( ) const
virtual

Returns whether any data was collected.

Returns
whether no data was collected

Reimplemented from MSMeanData::MeanDataValues.

Definition at line 117 of file MSMeanData_Amitran.cpp.

References amount, and MSMeanData::MeanDataValues::sampleSeconds.

bool MSMeanData_Amitran::MSLaneMeanDataValues::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 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 102 of file MSMeanData_Amitran.cpp.

References amount, MSMoveReminder::getLane(), SUMOVehicle::getVehicleType(), MSMoveReminder::NOTIFICATION_DEPARTED, MSMoveReminder::NOTIFICATION_JUNCTION, typedAmount, and MSMeanData::MeanDataValues::vehicleApplies().

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

References Named::getID(), SUMOVehicle::getID(), MSMoveReminder::getLane(), MSVehicleType::getLength(), SUMOVehicle::getVehicleType(), SUMOVehicle::hasArrived(), MSMeanData::MeanDataValues::myLaneLength, MSMoveReminder::notifyMoveInternal(), SUMOReal, TS, and WRITE_ERROR.

void MSMeanData_Amitran::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 93 of file MSMeanData_Amitran.cpp.

References SUMOVehicle::getVehicleType(), MSMeanData::MeanDataValues::sampleSeconds, MSMeanData::MeanDataValues::travelledDistance, typedSamples, and typedTravelDistance.

void MSMoveReminder::removeFromVehicleUpdateValues ( SUMOVehicle veh)
protectedinherited
void MSMeanData_Amitran::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_Amitran.cpp.

References amount, typedAmount, typedSamples, and typedTravelDistance.

void MSMoveReminder::setDescription ( const std::string &  description)
inlineinherited
void MSMeanData::MeanDataValues::update ( )
virtualinherited

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

Reimplemented in MSMeanData_Harmonoise::MSLaneMeanDataValues.

Definition at line 133 of file MSMeanData.cpp.

References SUMOReal.

void MSMoveReminder::updateDetector ( SUMOVehicle veh,
SUMOReal  entryPos,
SUMOReal  leavePos,
SUMOTime  entryTime,
SUMOTime  currentTime,
SUMOTime  leaveTime,
bool  cleanUp 
)
inherited
bool MSMeanData::MeanDataValues::vehicleApplies ( const SUMOVehicle veh) const
inherited
void MSMeanData_Amitran::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 123 of file MSMeanData_Amitran.cpp.

References amount, OutputDevice::closeTag(), MSMeanData::MeanDataValues::myLaneLength, MSMeanData::MeanDataValues::myVehicleTypes, OutputDevice::openTag(), MSMeanData::MeanDataValues::sampleSeconds, SUMO_ATTR_ID, MSMeanData::MeanDataValues::travelledDistance, typedAmount, typedSamples, typedTravelDistance, and OutputDevice::writeAttr().

Field Documentation

unsigned MSMeanData_Amitran::MSLaneMeanDataValues::amount
private

Definition at line 145 of file MSMeanData_Amitran.h.

Referenced by addTo(), isEmpty(), notifyEnter(), reset(), and write().

std::string MSMoveReminder::myDescription
protectedinherited

a description of this moveReminder

Definition at line 225 of file MSMoveReminder.h.

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

const SUMOReal MSMeanData::MeanDataValues::myLaneLength
protectedinherited
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.

Referenced by MSMeanData::MeanDataValues::vehicleApplies(), and write().

std::map<const MSVehicleType*, unsigned> MSMeanData_Amitran::MSLaneMeanDataValues::typedAmount
private

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

Definition at line 148 of file MSMeanData_Amitran.h.

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

std::map<const MSVehicleType*, SUMOReal> MSMeanData_Amitran::MSLaneMeanDataValues::typedSamples
private

The number of sampled vehicle movements by type (in s)

Definition at line 151 of file MSMeanData_Amitran.h.

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

std::map<const MSVehicleType*, SUMOReal> MSMeanData_Amitran::MSLaneMeanDataValues::typedTravelDistance
private

The sum of the distances the vehicles travelled by type.

Definition at line 154 of file MSMeanData_Amitran.h.

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


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