SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MSE2Collector.h
Go to the documentation of this file.
1 /****************************************************************************/
10 // An areal (along a single lane) detector
11 /****************************************************************************/
12 // SUMO, Simulation of Urban MObility; see http://sumo-sim.org/
13 // Copyright (C) 2001-2013 DLR (http://www.dlr.de/) and contributors
14 /****************************************************************************/
15 //
16 // This file is part of SUMO.
17 // SUMO is free software: you can redistribute it and/or modify
18 // it under the terms of the GNU General Public License as published by
19 // the Free Software Foundation, either version 3 of the License, or
20 // (at your option) any later version.
21 //
22 /****************************************************************************/
23 #ifndef MSE2Collector_h
24 #define MSE2Collector_h
25 
26 
27 // ===========================================================================
28 // included modules
29 // ===========================================================================
30 #ifdef _MSC_VER
31 #include <windows_config.h>
32 #else
33 #include <config.h>
34 #endif
35 
36 #include <vector>
37 #include <list>
38 #include <microsim/MSLane.h>
43 
44 
45 // ===========================================================================
46 // class declarations
47 // ===========================================================================
48 class OutputDevice;
49 
50 
51 // ===========================================================================
52 // class definitions
53 // ===========================================================================
78 public:
91  MSE2Collector(const std::string& id, DetectorUsage usage,
92  MSLane* const lane, SUMOReal startPos, SUMOReal detLength,
93  SUMOTime haltingTimeThreshold, SUMOReal haltingSpeedThreshold,
94  SUMOReal jamDistThreshold);
95 
96 
98  virtual ~MSE2Collector();
99 
100 
106  virtual DetectorUsage getUsageType() const {
107  return myUsage;
108  }
109 
110 
111 
114 
130  bool notifyMove(SUMOVehicle& veh, SUMOReal oldPos, SUMOReal newPos,
131  SUMOReal newSpeed);
132 
133 
145  bool notifyLeave(SUMOVehicle& veh, SUMOReal lastPos, MSMoveReminder::Notification reason);
146 
147 
162 
163 
164 
173  void detectorUpdate(const SUMOTime step);
174 
175 
176 
179 
188  void writeXMLOutput(OutputDevice& dev, SUMOTime startTime, SUMOTime stopTime);
189 
190 
197  void writeXMLDetectorProlog(OutputDevice& dev) const;
199 
200 
206  return myStartPos;
207  }
208 
209 
214  SUMOReal getEndPos() const {
215  return myEndPos;
216  }
217 
218 
225  void reset();
226 
227 
230 
232  unsigned getCurrentVehicleNumber() const;
233 
236 
239 
242 
244  unsigned getCurrentJamNumber() const;
245 
247  unsigned getCurrentMaxJamLengthInVehicles() const;
248 
251 
253  unsigned getCurrentJamLengthInVehicles() const;
254 
257 
259  unsigned getCurrentStartedHalts() const;
261 
262 
263 protected:
269  struct JamInfo {
271  std::list<SUMOVehicle*>::const_iterator firstStandingVehicle;
272 
274  std::list<SUMOVehicle*>::const_iterator lastStandingVehicle;
275  };
276 
277 
289  public:
295  : myLane(lane) { }
296 
297 
303  : myLane(s.myLane) { }
304 
305 
312  int operator()(const SUMOVehicle* v1, const SUMOVehicle* v2);
313 
314  private:
315  by_vehicle_position_sorter& operator=(const by_vehicle_position_sorter&); // just to avoid a compiler warning
316  private:
318  const MSLane* const myLane;
319  };
320 
321 
322 private:
325 
337 
340 
342  std::list<SUMOVehicle*> myKnownVehicles;
343 
345  std::map<SUMOVehicle*, SUMOTime> myHaltingVehicleDurations;
346 
348  std::map<SUMOVehicle*, SUMOTime> myIntervalHaltingVehicleDurations;
349 
351  std::vector<SUMOTime> myPastStandingDurations;
352 
354  std::vector<SUMOTime> myPastIntervalStandingDurations;
355 
356 
359 
371  unsigned myTimeSamples;
389 
390 
393 
401  unsigned myCurrentJamNo;
413 
414 
415 private:
418 
421 
422 
423 };
424 
425 
426 #endif
427 
428 /****************************************************************************/
429 
std::map< SUMOVehicle *, SUMOTime > myHaltingVehicleDurations
Storage for halting durations of known vehicles (for halting vehicles)
std::vector< SUMOTime > myPastIntervalStandingDurations
Halting durations of ended halts for the current interval [s].
unsigned myCurrentJamNo
The current jam number.
unsigned getCurrentJamNumber() const
Returns the current number of jams.
SUMOReal myMaxJamInMeters
The max jam length [m].
unsigned getCurrentStartedHalts() const
Returns the length of all jams in meters.
virtual ~MSE2Collector()
Destructor.
An areal (along a single lane) detector.
Definition: MSE2Collector.h:77
SUMOReal getCurrentMeanLength() const
Returns the mean vehicle length of vehicles currently on the detector.
Internal representation of a jam.
unsigned getCurrentMaxJamLengthInVehicles() const
Returns the length in vehicles of the currently largest jam.
SUMOReal myStartedHalts
The number of started halts [#].
Notification
Definition of a vehicle state.
A class used to sort known vehicles by their position.
std::vector< SUMOTime > myPastStandingDurations
Halting durations of ended halts [s].
unsigned myMaxVehicleNumber
The max number of vehicles [#veh].
SUMOReal getCurrentJamLengthInMeters() const
Returns the length of all jams in meters.
by_vehicle_position_sorter & operator=(const by_vehicle_position_sorter &)
SUMOReal myCurrentMeanLength
The current mean length.
virtual DetectorUsage getUsageType() const
Returns the detector&#39;s usage type.
unsigned myCurrentStartedHalts
The number of started halts in the last step.
by_vehicle_position_sorter(const MSLane *const lane)
constructor
bool notifyEnter(SUMOVehicle &veh, MSMoveReminder::Notification reason)
Adds the vehicle to known vehicles if not beyond the dector.
MSE2Collector & operator=(const MSE2Collector &)
Invalidated assignment operator.
unsigned myVehicleSamples
The number of collected samples [#].
Representation of a vehicle.
Definition: SUMOVehicle.h:63
std::map< SUMOVehicle *, SUMOTime > myIntervalHaltingVehicleDurations
Storage for halting durations of known vehicles (current interval)
SUMOReal getStartPos() const
Returns the begin position of the detector.
std::list< SUMOVehicle * > myKnownVehicles
List of known vehicles.
SUMOReal getCurrentMeanSpeed() const
Returns the mean vehicle speed of vehicles currently on the detector.
Something on a lane to be noticed about vehicle movement.
SUMOReal myJamHaltingSpeedThreshold
A vehicle must driver slower than this to be counted as a part of a jam.
unsigned myCurrentJamLengthInVehicles
The overall jam length in vehicles.
SUMOTime myJamHaltingTimeThreshold
A vehicle must be that long beyond myJamHaltingSpeedThreshold to be counted as a part of a jam...
SUMOReal mySpeedSum
The sum of collected vehicle speeds [m/s].
unsigned myMeanVehicleNumber
The mean number of vehicles [#veh].
SUMOReal myCurrentMaxJamLengthInMeters
the current maximum jam length in meters
unsigned myMeanMaxJamInVehicles
The mean jam length [#veh].
SUMOReal myCurrentJamLengthInMeters
The overall jam length in meters.
by_vehicle_position_sorter(const by_vehicle_position_sorter &s)
copy constructor
std::list< SUMOVehicle * >::const_iterator firstStandingVehicle
The first standing vehicle.
SUMOReal myStartPos
The position the detector starts at.
unsigned myMaxJamInVehicles
The max jam length [#veh].
void detectorUpdate(const SUMOTime step)
Computes the detector values in each time step.
SUMOReal myEndPos
The position the detector ends at.
SUMOReal myCurrentOccupancy
The current occupancy.
SUMOReal myMaxOccupancy
The maximum occupancy [%].
bool notifyMove(SUMOVehicle &veh, SUMOReal oldPos, SUMOReal newPos, SUMOReal newSpeed)
Adds/removes vehicles from the list of vehicles to regard.
void writeXMLOutput(OutputDevice &dev, SUMOTime startTime, SUMOTime stopTime)
Writes collected values into the given stream.
SUMOReal getCurrentOccupancy() const
Returns the curent detector occupancy.
DetectorUsage myUsage
Information about how this detector is used.
SUMOReal myCurrentMeanSpeed
The current mean speed.
void reset()
Resets all values.
unsigned myTimeSamples
The current aggregation duration [#steps].
unsigned getCurrentVehicleNumber() const
Returns the number of vehicles currently on the detector.
SUMOReal myMeanMaxJamInMeters
The mean jam length [m].
SUMOReal myOccupancySum
The sum of occupancies [%].
const MSLane *const myLane
The lane the detector is placed at.
int SUMOTime
Definition: SUMOTime.h:43
MSE2Collector(const std::string &id, DetectorUsage usage, MSLane *const lane, SUMOReal startPos, SUMOReal detLength, SUMOTime haltingTimeThreshold, SUMOReal haltingSpeedThreshold, SUMOReal jamDistThreshold)
Constructor.
std::list< SUMOVehicle * >::const_iterator lastStandingVehicle
The last standing vehicle.
unsigned myCurrentMaxJamLengthInVehicles
The current maximum jam length in vehicles.
SUMOReal myJamLengthInMetersSum
The sum of jam lengths [m].
SUMOReal getCurrentMaxJamLengthInMeters() const
Returns the length in meters of the currently largest jam.
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:70
unsigned getCurrentJamLengthInVehicles() const
Returns the length of all jams in vehicles.
#define SUMOReal
Definition: config.h:215
bool notifyLeave(SUMOVehicle &veh, SUMOReal lastPos, MSMoveReminder::Notification reason)
Removes a known vehicle due to its lane-change.
Representation of a lane in the micro simulation.
Definition: MSLane.h:77
int operator()(const SUMOVehicle *v1, const SUMOVehicle *v2)
Comparison funtcion.
Base of value-generating classes (detectors)
unsigned myJamLengthInVehiclesSum
The sum of jam lengths [#veh].
SUMOReal myJamDistanceThreshold
Two standing vehicles must be closer than this to be counted into the same jam.
void writeXMLDetectorProlog(OutputDevice &dev) const
Opens the XML-output using &quot;detector&quot; as root element.
SUMOReal getEndPos() const
Returns the end position of the detector.