SUMO - Simulation of Urban MObility
MSE3Collector.h
Go to the documentation of this file.
1 /****************************************************************************/
10 // A detector of vehicles passing an area between entry/exit points
11 /****************************************************************************/
12 // SUMO, Simulation of Urban MObility; see http://sumo-sim.org/
13 // Copyright (C) 2003-2014 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 MSE3Collector_h
24 #define MSE3Collector_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 <string>
37 #include <vector>
38 #include <limits>
41 #include <utils/common/Named.h>
44 
45 
46 // ===========================================================================
47 // class declarations
48 // ===========================================================================
49 class SUMOVehicle;
50 class OutputDevice;
51 
52 
53 // ===========================================================================
54 // class definitions
55 // ===========================================================================
66 public:
72  public:
78  MSE3EntryReminder(const MSCrossSection& crossSection, MSE3Collector& collector);
79 
80 
83 
99  bool notifyMove(SUMOVehicle& veh, SUMOReal , SUMOReal newPos, SUMOReal);
100 
101 
112  bool notifyLeave(SUMOVehicle& veh, SUMOReal lastPos, MSMoveReminder::Notification reason);
114 
115 
116  private:
119 
122 
123  private:
126 
129 
130  };
131 
132 
133 
139  public:
145  MSE3LeaveReminder(const MSCrossSection& crossSection, MSE3Collector& collector);
146 
147 
149 
150 
166  bool notifyMove(SUMOVehicle& veh, SUMOReal oldPos, SUMOReal newPos, SUMOReal);
167 
177  bool notifyLeave(SUMOVehicle& veh, SUMOReal lastPos, MSMoveReminder::Notification reason);
179 
180 
181  private:
184 
187 
188  private:
191 
194 
195  };
196 
197 
208  MSE3Collector(const std::string& id,
209  const CrossSectionVector& entries, const CrossSectionVector& exits,
210  SUMOReal haltingSpeedThreshold,
211  SUMOTime haltingTimeThreshold);
212 
213 
215  virtual ~MSE3Collector();
216 
217 
220  void reset();
221 
222 
230  void enter(SUMOVehicle& veh, SUMOReal entryTimestep);
231 
232 
240  void leave(SUMOVehicle& veh, SUMOReal leaveTimestep);
241 
242 
245 
253 
254 
262 
263 
267  SUMOReal getVehiclesWithin() const;
268 
269 
274  std::vector<std::string> getCurrentVehicleIDs() const;
276 
277 
280 
289  void writeXMLOutput(OutputDevice& dev, SUMOTime startTime, SUMOTime stopTime);
290 
291 
300  void writeXMLDetectorProlog(OutputDevice& dev) const;
302 
303 
304 
313  void detectorUpdate(const SUMOTime step);
314 
315 
316 protected:
319 
322 
324  std::vector<MSE3EntryReminder*> myEntryReminders;
325 
327  std::vector<MSE3LeaveReminder*> myLeaveReminders;
328 
329 
330  // @brief Time-threshold to determine if a vehicle is halting.
332 
335 
344  struct E3Values {
352  unsigned haltings;
360  bool hadUpdate;
361  };
362 
364  std::map<SUMOVehicle*, E3Values> myEnteredContainer;
365 
367  std::map<SUMOVehicle*, E3Values> myLeftContainer;
368 
369 
372 
375 
378 
386 
387 
390 
391 
392 private:
395 
398 
399 
400 };
401 
402 
403 #endif
404 
405 /****************************************************************************/
406 
SUMOReal getCurrentHaltingNumber() const
Returns the number of current haltings within the area.
MSE3LeaveReminder & operator=(const MSE3LeaveReminder &)
Invalidated assignment operator.
std::map< SUMOVehicle *, E3Values > myLeftContainer
Container for vehicles that have left the area.
virtual ~MSE3Collector()
Destructor.
bool notifyLeave(SUMOVehicle &veh, SUMOReal lastPos, MSMoveReminder::Notification reason)
Processes state changes of a vehicle.
A simple description of a position on a lane (crossing of a lane)
std::vector< MSE3EntryReminder * > myEntryReminders
The detector's built entry reminder.
SUMOReal entryTime
The vehicle's entry time.
bool hadUpdate
An internal information whether the update step was performed.
A place on the road net (at a certain lane and position on it) where the E3 area ends.
MSE3EntryReminder(const MSCrossSection &crossSection, MSE3Collector &collector)
Constructor.
A place on the road net (at a certain lane and position on it) where the E3 area begins.
Definition: MSE3Collector.h:71
SUMOReal myCurrentHaltingsNumber
The current number of haltings (inside)
SUMOReal myPosition
The position on the lane.
Notification
Definition of a vehicle state.
std::vector< MSCrossSection > CrossSectionVector
void enter(SUMOVehicle &veh, SUMOReal entryTimestep)
Called if a vehicle touches an entry-cross-section.
SUMOTime myLastResetTime
Information when the last reset has been done.
std::vector< MSE3LeaveReminder * > myLeaveReminders
The detector's built exit reminder.
SUMOReal haltingBegin
Begin time of last halt begin.
SUMOReal myPosition
The position on the lane.
SUMOReal leaveTime
The vehicle's leaving time.
MSE3EntryReminder & operator=(const MSE3EntryReminder &)
Invalidated assignment operator.
Representation of a vehicle.
Definition: SUMOVehicle.h:64
Internal storage for values from a vehicle.
void writeXMLDetectorProlog(OutputDevice &dev) const
Opens the XML-output using "e3Detector" as root element.
SUMOTime myHaltingTimeThreshold
MSE3Collector & operator=(const MSE3Collector &)
Invalidated assignment operator.
void leave(SUMOVehicle &veh, SUMOReal leaveTimestep)
Called if a vehicle passes a leave-cross-section.
MSE3Collector & myCollector
The parent collector.
SUMOReal myHaltingSpeedThreshold
Speed-threshold to determine if a vehicle is halting.
Something on a lane to be noticed about vehicle movement.
MSE3LeaveReminder(const MSCrossSection &crossSection, MSE3Collector &collector)
Constructor.
CrossSectionVector myEntries
The detector's entries.
SUMOReal myCurrentTouchedVehicles
The current number of vehicles inside;.
unsigned haltings
The sum of haltings the vehicle has/had within the area.
void reset()
Resets all generated values to allow computation of next interval.
A detector of vehicles passing an area between entry/exit points.
Definition: MSE3Collector.h:65
bool notifyMove(SUMOVehicle &veh, SUMOReal, SUMOReal newPos, SUMOReal)
Checks whether the vehicle enters.
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:71
#define SUMOReal
Definition: config.h:215
bool notifyLeave(SUMOVehicle &veh, SUMOReal lastPos, MSMoveReminder::Notification reason)
Processes state changes of a vehicle.
SUMOReal speedSum
The sum of registered speeds the vehicle has/had inside the area.
SUMOReal getCurrentMeanSpeed() const
Returns the mean speed within the area.
bool notifyMove(SUMOVehicle &veh, SUMOReal oldPos, SUMOReal newPos, SUMOReal)
Checks whether the vehicle leaves.
SUMOReal getVehiclesWithin() const
Returns the number of vehicles within the area.
unsigned intervalHaltings
The sum of haltings the vehicle has/had within the area during the current interval.
void detectorUpdate(const SUMOTime step)
Computes the detector values in each time step.
std::map< SUMOVehicle *, E3Values > myEnteredContainer
Container for vehicles that have entered the area.
MSE3Collector(const std::string &id, const CrossSectionVector &entries, const CrossSectionVector &exits, SUMOReal haltingSpeedThreshold, SUMOTime haltingTimeThreshold)
Constructor.
SUMOReal intervalSpeedSum
The sum of registered speeds the vehicle has/had inside the area during the current interval...
void writeXMLOutput(OutputDevice &dev, SUMOTime startTime, SUMOTime stopTime)
Writes collected values into the given stream.
MSE3Collector & myCollector
The parent collector.
Base of value-generating classes (detectors)
std::vector< std::string > getCurrentVehicleIDs() const
Returns the number of vehicles within the area.
CrossSectionVector myExits
The detector's exits.
SUMOReal myCurrentMeanSpeed
The current mean speed of known vehicles (inside)