Eclipse SUMO - Simulation of Urban MObility
MSRouteProbe.cpp
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
3 // Copyright (C) 2008-2019 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials
5 // are made available under the terms of the Eclipse Public License v2.0
6 // which accompanies this distribution, and is available at
7 // http://www.eclipse.org/legal/epl-v20.html
8 // SPDX-License-Identifier: EPL-2.0
9 /****************************************************************************/
18 // Writes route distributions at a certain edge
19 /****************************************************************************/
20 
21 
22 // ===========================================================================
23 // included modules
24 // ===========================================================================
25 #include <config.h>
26 
27 #include <string>
28 #include <microsim/MSEdge.h>
29 #include <microsim/MSLane.h>
30 #include <microsim/MSGlobals.h>
31 #include <microsim/MSRoute.h>
32 #include <microsim/MSVehicle.h>
33 #include <utils/common/ToString.h>
35 #include <mesosim/MELoop.h>
36 #include <mesosim/MESegment.h>
37 #include "MSRouteProbe.h"
38 
39 
40 // ===========================================================================
41 // method definitions
42 // ===========================================================================
43 MSRouteProbe::MSRouteProbe(const std::string& id, const MSEdge* edge, const std::string& distID, const std::string& lastID,
44  const std::string& vTypes) :
45  MSDetectorFileOutput(id, vTypes), MSMoveReminder(id) {
46  myCurrentRouteDistribution = std::make_pair(distID, MSRoute::distDictionary(distID));
47  if (myCurrentRouteDistribution.second == 0) {
49  MSRoute::dictionary(distID, myCurrentRouteDistribution.second, false);
50  }
51  myLastRouteDistribution = std::make_pair(lastID, MSRoute::distDictionary(lastID));
54  while (seg != nullptr) {
55  seg->addDetector(this);
56  seg = seg->getNextSegment();
57  }
58  return;
59  }
60  for (std::vector<MSLane*>::const_iterator it = edge->getLanes().begin(); it != edge->getLanes().end(); ++it) {
61  (*it)->addMoveReminder(this);
62  }
63 }
64 
65 
67 }
68 
69 
70 bool
72  if (!vehicleApplies(veh)) {
73  return false;
74  }
76  SUMOVehicle* vehicle = dynamic_cast<SUMOVehicle*>(&veh);
77  if (vehicle != nullptr) {
78  if (myCurrentRouteDistribution.second->add(&vehicle->getRoute(), 1.)) {
79  vehicle->getRoute().addReference();
80  }
81  }
82  }
83  return false;
84 }
85 
86 
87 void
89  SUMOTime startTime, SUMOTime stopTime) {
90  if (myCurrentRouteDistribution.second->getOverallProb() > 0) {
91  dev.openTag("routeDistribution") << " id=\"" << getID() + "_" + time2string(startTime) << "\"";
92  const std::vector<const MSRoute*>& routes = myCurrentRouteDistribution.second->getVals();
93  const std::vector<double>& probs = myCurrentRouteDistribution.second->getProbs();
94  for (int j = 0; j < (int)routes.size(); ++j) {
95  const MSRoute* r = routes[j];
96  dev.openTag("route") << " id=\"" << r->getID() + "_" + time2string(startTime) << "\" edges=\"";
97  for (MSRouteIterator i = r->begin(); i != r->end(); ++i) {
98  if (i != r->begin()) {
99  dev << " ";
100  }
101  dev << (*i)->getID();
102  }
103  dev << "\" probability=\"" << probs[j] << "\"";
104  dev.closeTag();
105  }
106  dev.closeTag();
107  if (myLastRouteDistribution.second != 0) {
109  }
111  myCurrentRouteDistribution.first = getID() + "_" + toString(stopTime);
114  }
115 }
116 
117 
118 void
120  dev.writeXMLHeader("routes", "routes_file.xsd");
121 }
122 
123 
124 const MSRoute*
126  if (myLastRouteDistribution.second == 0) {
127  if (myCurrentRouteDistribution.second->getOverallProb() > 0) {
128  return myCurrentRouteDistribution.second->get();
129  }
130  return nullptr;
131  }
132  return myLastRouteDistribution.second->get();
133 }
MSRoute::checkDist
static void checkDist(const std::string &id)
Checks the distribution whether it is permanent and deletes it if not.
Definition: MSRoute.cpp:186
MSMoveReminder::NOTIFICATION_LANE_CHANGE
The vehicle changes lanes (micro only)
Definition: MSMoveReminder.h:97
SUMOTrafficObject
Representation of a vehicle or person.
Definition: SUMOTrafficObject.h:48
ToString.h
MSDetectorFileOutput
Base of value-generating classes (detectors)
Definition: MSDetectorFileOutput.h:64
MSLane
Representation of a lane in the micro simulation.
Definition: MSLane.h:83
MESegment
A single mesoscopic segment (cell)
Definition: MESegment.h:50
OutputDevice
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:64
MSRoute::end
MSRouteIterator end() const
Returns the end of the list of edges to pass.
Definition: MSRoute.cpp:76
MSRouteProbe::writeXMLOutput
void writeXMLOutput(OutputDevice &dev, SUMOTime startTime, SUMOTime stopTime)
Writes values into the given stream.
Definition: MSRouteProbe.cpp:88
MSRouteIterator
ConstMSEdgeVector::const_iterator MSRouteIterator
Definition: MSRoute.h:58
MESegment::addDetector
void addDetector(MSMoveReminder *data)
Adds a data collector for a detector to this segment.
Definition: MESegment.cpp:212
SUMOTime
long long int SUMOTime
Definition: SUMOTime.h:35
SUMOVehicle
Representation of a vehicle.
Definition: SUMOVehicle.h:61
MSGlobals::gUseMesoSim
static bool gUseMesoSim
Definition: MSGlobals.h:91
MSEdge.h
MSRouteProbe::writeXMLDetectorProlog
void writeXMLDetectorProlog(OutputDevice &dev) const
Opens the XML-output using "detector" as root element.
Definition: MSRouteProbe.cpp:119
MSRoute
Definition: MSRoute.h:67
MSVehicle.h
MSMoveReminder
Something on a lane to be noticed about vehicle movement.
Definition: MSMoveReminder.h:64
OutputDevice::closeTag
bool closeTag(const std::string &comment="")
Closes the most recently opened tag and optionally adds a comment.
Definition: OutputDevice.cpp:254
MESegment.h
MSRouteProbe::myCurrentRouteDistribution
std::pair< std::string, RandomDistributor< const MSRoute * > * > myCurrentRouteDistribution
The current distribution of routes (probability->route)
Definition: MSRouteProbe.h:134
SUMOVehicle::getRoute
virtual const MSRoute & getRoute() const =0
Returns the current route.
MSRoute::distDictionary
static RandomDistributor< const MSRoute * > * distDictionary(const std::string &id)
Returns the named route distribution.
Definition: MSRoute.cpp:157
MSRouteProbe::myLastRouteDistribution
std::pair< std::string, RandomDistributor< const MSRoute * > * > myLastRouteDistribution
The previous distribution of routes (probability->route)
Definition: MSRouteProbe.h:131
MELoop::getSegmentForEdge
MESegment * getSegmentForEdge(const MSEdge &e, double pos=0)
Get the segment for a given edge at a given position.
Definition: MELoop.cpp:293
OutputDevice.h
time2string
std::string time2string(SUMOTime t)
Definition: SUMOTime.cpp:65
MSRouteProbe::MSRouteProbe
MSRouteProbe(const std::string &id, const MSEdge *edge, const std::string &distID, const std::string &lastID, const std::string &vTypes)
Constructor.
Definition: MSRouteProbe.cpp:43
MSGlobals.h
MESegment::getNextSegment
MESegment * getNextSegment() const
Returns the following segment on the same edge (0 if it is the last).
Definition: MESegment.h:152
MSEdge
A road/street connecting two junctions.
Definition: MSEdge.h:76
MSRouteProbe::getRoute
const MSRoute * getRoute() const
Definition: MSRouteProbe.cpp:125
MSRouteProbe::~MSRouteProbe
virtual ~MSRouteProbe()
Destructor.
Definition: MSRouteProbe.cpp:66
RandomDistributor< const MSRoute * >
MSMoveReminder::NOTIFICATION_SEGMENT
The vehicle changes the segment (meso only)
Definition: MSMoveReminder.h:95
OutputDevice::openTag
OutputDevice & openTag(const std::string &xmlElement)
Opens an XML tag.
Definition: OutputDevice.cpp:240
toString
std::string toString(const T &t, std::streamsize accuracy=gPrecision)
Definition: ToString.h:48
MSRouteProbe::notifyEnter
bool notifyEnter(SUMOTrafficObject &veh, MSMoveReminder::Notification reason, const MSLane *enteredLane=0)
Returns whether the vehicle shall be aware of this entry.
Definition: MSRouteProbe.cpp:71
MSGlobals::gMesoNet
static MELoop * gMesoNet
mesoscopic simulation infrastructure
Definition: MSGlobals.h:106
MSRoute.h
MSRouteProbe.h
MSEdge::getLanes
const std::vector< MSLane * > & getLanes() const
Returns this edge's lanes.
Definition: MSEdge.h:165
MSRoute::begin
MSRouteIterator begin() const
Returns the begin of the list of edges to pass.
Definition: MSRoute.cpp:70
MSDetectorFileOutput::vehicleApplies
bool vehicleApplies(const SUMOTrafficObject &veh) const
Checks whether the detector measures vehicles of the given type.
Definition: MSDetectorFileOutput.h:142
MSRoute::dictionary
static bool dictionary(const std::string &id, const MSRoute *route)
Adds a route to the dictionary.
Definition: MSRoute.cpp:114
config.h
MELoop.h
MSRoute::addReference
void addReference() const
increments the reference counter for the route
Definition: MSRoute.cpp:95
MSLane.h
OutputDevice::writeXMLHeader
bool writeXMLHeader(const std::string &rootElement, const std::string &schemaFile, std::map< SumoXMLAttr, std::string > attrs=std::map< SumoXMLAttr, std::string >())
Writes an XML header with optional configuration.
Definition: OutputDevice.cpp:228
Named::getID
const std::string & getID() const
Returns the id.
Definition: Named.h:77
MSMoveReminder::Notification
Notification
Definition of a vehicle state.
Definition: MSMoveReminder.h:89