SUMO - Simulation of Urban MObility
GUIE3Collector Class Reference

The gui-version of the MSE3Collector. More...

#include <GUIE3Collector.h>

Inheritance diagram for GUIE3Collector:
MSE3Collector MSDetectorFileOutput Named

Data Structures

class  MyWrapper

Public Member Functions

GUIDetectorWrapperbuildDetectorGUIRepresentation ()
 Returns the wrapper for this detector.
void detectorUpdate (const SUMOTime step)
 Computes the detector values in each time step.
void enter (SUMOVehicle &veh, SUMOReal entryTimestep)
 Called if a vehicle touches an entry-cross-section.
const CrossSectionVectorgetEntries () const
 Returns the list of entry points.
const CrossSectionVectorgetExits () const
 Returns the list of exit points.
const std::string & getID () const
 Returns the id.
 GUIE3Collector (const std::string &id, const CrossSectionVector &entries, const CrossSectionVector &exits, SUMOReal haltingSpeedThreshold, SUMOTime haltingTimeThreshold)
 Constructor.
void leave (SUMOVehicle &veh, SUMOReal leaveTimestep)
 Called if a vehicle passes a leave-cross-section.
void reset ()
 Resets all generated values to allow computation of next interval.
void setID (const std::string &newID)
 resets the id
 ~GUIE3Collector ()
 Destructor.
Methods returning current values
SUMOReal getCurrentMeanSpeed () const
 Returns the mean speed within the area.
SUMOReal getCurrentHaltingNumber () const
 Returns the number of current haltings within the area.
SUMOReal getVehiclesWithin () const
 Returns the number of vehicles within the area.
std::vector< std::string > getCurrentVehicleIDs () const
 Returns the number of vehicles within the area.
Methods inherited from MSDetectorFileOutput.
void writeXMLOutput (OutputDevice &dev, SUMOTime startTime, SUMOTime stopTime)
 Writes collected values into the given stream.
void writeXMLDetectorProlog (OutputDevice &dev) const
 Opens the XML-output using "e3Detector" as root element.

Protected Attributes

std::map< SUMOVehicle *, E3ValuesmyEnteredContainer
 Container for vehicles that have entered the area.
CrossSectionVector myEntries
 The detector's entries.
std::vector< MSE3EntryReminder * > myEntryReminders
 The detector's built entry reminder.
CrossSectionVector myExits
 The detector's exits.
SUMOReal myHaltingSpeedThreshold
 Speed-threshold to determine if a vehicle is halting.
SUMOTime myHaltingTimeThreshold
std::string myID
 The name of the object.
SUMOTime myLastResetTime
 Information when the last reset has been done.
std::vector< MSE3LeaveReminder * > myLeaveReminders
 The detector's built exit reminder.
std::map< SUMOVehicle *, E3ValuesmyLeftContainer
 Container for vehicles that have left the area.
Storages for current values
SUMOReal myCurrentMeanSpeed
 The current mean speed of known vehicles (inside)
SUMOReal myCurrentHaltingsNumber
 The current number of haltings (inside)
SUMOReal myCurrentTouchedVehicles
 The current number of vehicles inside;.

Detailed Description

The gui-version of the MSE3Collector.

Allows the building of a wrapper (also declared herein) which draws the detector on the gl-canvas.

Definition at line 53 of file GUIE3Collector.h.


Constructor & Destructor Documentation

GUIE3Collector::GUIE3Collector ( const std::string &  id,
const CrossSectionVector entries,
const CrossSectionVector exits,
SUMOReal  haltingSpeedThreshold,
SUMOTime  haltingTimeThreshold 
)

Constructor.

Definition at line 179 of file GUIE3Collector.cpp.

Destructor.

Definition at line 186 of file GUIE3Collector.cpp.


Member Function Documentation

Returns the wrapper for this detector.

Returns:
The wrapper representing the detector
See also:
MyWrapper

Reimplemented from MSDetectorFileOutput.

Definition at line 203 of file GUIE3Collector.cpp.

void MSE3Collector::detectorUpdate ( const SUMOTime  step) [virtual, inherited]

Computes the detector values in each time step.

This method should be called at the end of a simulation step, when all vehicles have moved. The current values are computed and summed up with the previous.

Parameters:
[in]currentTimeThe current simulation time (unused)

Reimplemented from MSDetectorFileOutput.

Definition at line 285 of file MSE3Collector.cpp.

References MSE3Collector::E3Values::entryTime, SUMOVehicle::getSpeed(), MSE3Collector::E3Values::hadUpdate, MSE3Collector::E3Values::haltingBegin, MSE3Collector::E3Values::haltings, MSE3Collector::E3Values::intervalHaltings, MSE3Collector::E3Values::intervalSpeedSum, MSE3Collector::myCurrentHaltingsNumber, MSE3Collector::myCurrentMeanSpeed, MSE3Collector::myCurrentTouchedVehicles, MSE3Collector::myEnteredContainer, MSE3Collector::myHaltingSpeedThreshold, MSE3Collector::myHaltingTimeThreshold, MSE3Collector::E3Values::speedSum, SUMOReal, and TS.

Returns the number of current haltings within the area.

If no vehicle is within the area, 0 is returned.

Returns:
The mean number of haltings within the area

Definition at line 338 of file MSE3Collector.cpp.

References MSE3Collector::myCurrentHaltingsNumber.

Referenced by GUIE3Collector::MyWrapper::getParameterWindow(), and TraCIServerAPI_MeMeDetector::processGet().

Returns the mean speed within the area.

If no vehicle is within the area, -1 is returned.

Returns:
The mean speed [m/s] of all vehicles within the area, -1 if there is none

Definition at line 325 of file MSE3Collector.cpp.

References MSE3Collector::myEnteredContainer, and SUMOReal.

Referenced by GUIE3Collector::MyWrapper::getParameterWindow(), and TraCIServerAPI_MeMeDetector::processGet().

std::vector< std::string > MSE3Collector::getCurrentVehicleIDs ( ) const [inherited]

Returns the number of vehicles within the area.

Returns:
The number of vehicles that have passed the entry, but not yet an exit point

Definition at line 350 of file MSE3Collector.cpp.

References MSE3Collector::myEnteredContainer.

Referenced by TraCIServerAPI_MeMeDetector::processGet().

Returns the list of entry points.

Returns:
The list of entry points

Definition at line 190 of file GUIE3Collector.cpp.

References MSE3Collector::myEntries.

Referenced by GUIE3Collector::MyWrapper::MyWrapper().

Returns the list of exit points.

Returns:
The list of exit points

Definition at line 196 of file GUIE3Collector.cpp.

References MSE3Collector::myExits.

Referenced by GUIE3Collector::MyWrapper::MyWrapper().

const std::string& Named::getID ( ) const [inline, inherited]

Returns the id.

Returns:
The stored id

Reimplemented in MS_E2_ZS_CollectorOverLanes.

Definition at line 61 of file Named.h.

References Named::myID.

Referenced by MSDetectorControl::add(), ShapeContainer::add(), RORouteDef_Alternatives::addAlternative(), MSNet::addBusStop(), NBLoadedSUMOTLDef::addConnection(), NLHandler::addConnection(), NIImporter_OpenDrive::addE2EConnectionsSecure(), RONet::addNode(), NIImporter_SUMO::addPhase(), RONet::addRouteDef(), NBDistrict::addSink(), NBDistrict::addSource(), MSRouteHandler::addStop(), NIXMLTrafficLightsHandler::addTlConnection(), NIVissimDisturbance::addToNode(), MSVehicle::addTraciStop(), NIVisumTL::build(), MS_E2_ZS_CollectorOverLanes::buildCollector(), NIImporter_VISUM::buildDistrictNode(), NIVissimConnection::buildEdgeConnections(), NBEdge::buildInnerEdges(), NIVissimEdge::buildNBEdge(), NBNodeCont::buildOffRamp(), NBNodeCont::buildOnRamp(), ODDistrictHandler::closeDistrict(), NBTrafficLightDefinition::collectEdges(), NBOwnTLDef::collectLinks(), NBTrafficLightDefinition::compute(), NBNode::computeInternalLaneShape(), NBEdge::computeLaneShapes(), NBNode::computeLogic(), NBNode::computeNodeShape(), NBTrafficLightLogicCont::computeSingleLogic(), NBTurningDirectionsComputer::computeTurnDirectionsForNode(), NBEdge::connections_sorter(), MSLane::detectCollisions(), NIVissimDistrictConnection::dict_BuildDistricts(), MSE3Collector::enter(), Command_SaveTLSSwitches::execute(), MSVTypeProbe::execute(), NBNodeCont::extract(), NBTrafficLightLogicCont::extract(), NBEdgeCont::extract(), MSNet::getBusStopID(), NIImporter_VISUM::getNamedEdgeContinuating(), NLTriggerBuilder::getPosition(), NBNode::getPossiblySplittedIncoming(), NBNode::getPossiblySplittedOutgoing(), NIImporter_VISUM::getReversedContinuating(), NBEdgeCont::ignoreFilterMatch(), MSActuatedTrafficLightLogic::init(), MSAgentbasedTrafficLightLogic::init(), NIImporter_SUMO::initTrafficLightLogic(), NIXMLTrafficLightsHandler::initTrafficLightLogic(), NBDistrictCont::insert(), NBTrafficLightLogicCont::insert(), NBNodeCont::insert(), NBEdgeCont::insert(), NBEdgeCont::joinSameNodeConnectingEdges(), MSE3Collector::leave(), NIImporter_OpenDrive::loadNetwork(), MSLane::moveCritical(), MSVehicle::MSVehicle(), RORDLoader_SUMOBase::myCharacters(), NBOwnTLDef::myCompute(), NBLoadedTLDef::myCompute(), NIXMLTrafficLightsHandler::myEndElement(), NIXMLEdgesHandler::myEndElement(), NIImporter_SUMO::myEndElement(), NIXMLConnectionsHandler::myStartElement(), MSLaneSpeedTrigger::myStartElement(), MSTriggeredRerouter::myStartElement(), NBConnection::NBConnection(), NBRequest::NBRequest(), MSDevice_Tripinfo::notifyEnter(), MSDevice_Tripinfo::notifyLeave(), Named::ComparatorIdLess::operator()(), NBTurningDirectionsComputer::combination_by_angle_sorter::operator()(), NBOwnTLDef::edge_by_incoming_priority_sorter::operator()(), NBNetBuilder::by_id_sorter::operator()(), NBContHelper::same_connection_edge_sorter::operator()(), NBNode::nodes_by_id_sorter::operator()(), NIImporter_VISUM::parse_EdgePolys(), NIImporter_VISUM::parse_Lanes(), NIImporter_VISUM::parse_LanesConnections(), NIImporter_VISUM::parse_Turns(), NIImporter_VISUM::parse_TurnsToSignalGroups(), NIXMLConnectionsHandler::parseDeprecatedLaneDefinition(), NIXMLConnectionsHandler::parseLaneBound(), NBLoadedTLDef::SignalGroup::patchTYellow(), RORouteDef_Complete::preComputeCurrentRoute(), TraCIServerAPI_Lane::processGet(), TraCIServerAPI_TLS::processGet(), TraCIServerAPI_InductionLoop::processGet(), TraCIServerAPI_Vehicle::processGet(), NWWriter_SUMO::prohibitionConnection(), NBLoadedTLDef::SignalGroup::remapIncoming(), NBLoadedTLDef::SignalGroup::remapOutgoing(), NBLoadedSUMOTLDef::removeConnection(), NBNode::removeSelfLoops(), NBEdgeCont::removeUnwishedEdges(), NBNodeCont::removeUnwishedNodes(), NBNodeCont::rename(), NBEdgeCont::rename(), NBConnection::replaceFrom(), MSBaseVehicle::replaceRouteEdges(), NBConnection::replaceTo(), NIXMLTrafficLightsHandler::retrieveLaneIndex(), NBNodeCont::setAsTLControlled(), NBEdge::setControllingTLInformation(), MSLane::setCritical(), NIXMLEdgesHandler::setNodes(), NBOwnTLDef::setTLControllingInformation(), NBLoadedSUMOTLDef::setTLControllingInformation(), NBLoadedTLDef::setTLControllingInformation(), NBEdgeCont::splitAt(), RORDLoader_SUMOBase::startRoute(), NBEdge::startShapeAt(), NIXMLConnectionsHandler::validateLaneInfo(), MSInstantInductLoop::write(), NWWriter_SUMO::writeConnection(), NWWriter_SUMO::writeDistrict(), NWWriter_SUMO::writeEdge(), MSMeanData::writeEdge(), NWWriter_XML::writeEdgesAndConnections(), NWWriter_SUMO::writeInternalConnections(), NWWriter_SUMO::writeJunction(), NWWriter_OpenDrive::writeNetwork(), NWWriter_XML::writeNodes(), MSInductLoop::writeTypedXMLOutput(), MSRouteProbe::writeXMLOutput(), and MSE2Collector::writeXMLOutput().

Returns the number of vehicles within the area.

Returns:
The number of vehicles that passed the entry collector

Definition at line 344 of file MSE3Collector.cpp.

References MSE3Collector::myEnteredContainer, and SUMOReal.

Referenced by GUIE3Collector::MyWrapper::getParameterWindow(), and TraCIServerAPI_MeMeDetector::processGet().

void MSE3Collector::reset ( ) [virtual, inherited]

Resets all generated values to allow computation of next interval.

Reimplemented from MSDetectorFileOutput.

Definition at line 150 of file MSE3Collector.cpp.

References MSE3Collector::myLeftContainer.

Referenced by MSE3Collector::MSE3Collector().

void Named::setID ( const std::string &  newID) [inline, inherited]

resets the id

Definition at line 67 of file Named.h.

References Named::myID.

Referenced by NBNodeCont::rename(), and NBEdgeCont::rename().

void MSE3Collector::writeXMLDetectorProlog ( OutputDevice dev) const [virtual, inherited]

Opens the XML-output using "e3Detector" as root element.

The lists of entries/exists are written, too.

Parameters:
[in]devThe output device to write the root into
See also:
MSDetectorFileOutput::writeXMLDetectorProlog
Exceptions:
IOErrorIf an error on writing occurs (!!! not yet implemented)

Implements MSDetectorFileOutput.

Definition at line 279 of file MSE3Collector.cpp.

References OutputDevice::writeXMLHeader().

void MSE3Collector::writeXMLOutput ( OutputDevice dev,
SUMOTime  startTime,
SUMOTime  stopTime 
) [virtual, inherited]

Writes collected values into the given stream.

Parameters:
[in]devThe output device to write the data into
[in]startTimeFirst time step the data were gathered
[in]stopTimeLast time step the data were gathered
See also:
MSDetectorFileOutput::writeXMLOutput
Exceptions:
IOErrorIf an error on writing occurs (!!! not yet implemented)

Implements MSDetectorFileOutput.

Definition at line 212 of file MSE3Collector.cpp.

References MIN2(), MSE3Collector::myEnteredContainer, Named::myID, MSE3Collector::myLastResetTime, MSE3Collector::myLeftContainer, SUMOReal, and time2string().


Field Documentation

The current number of haltings (inside)

Definition at line 366 of file MSE3Collector.h.

Referenced by MSE3Collector::detectorUpdate(), and MSE3Collector::getCurrentHaltingNumber().

The current mean speed of known vehicles (inside)

Definition at line 363 of file MSE3Collector.h.

Referenced by MSE3Collector::detectorUpdate().

The current number of vehicles inside;.

Please note, that vehicles that enter the area are given as a fraction

See also:
execute

Definition at line 373 of file MSE3Collector.h.

Referenced by MSE3Collector::detectorUpdate().

The detector's entries.

Definition at line 307 of file MSE3Collector.h.

Referenced by getEntries().

std::vector<MSE3EntryReminder*> MSE3Collector::myEntryReminders [protected, inherited]

The detector's built entry reminder.

Definition at line 313 of file MSE3Collector.h.

Referenced by MSE3Collector::MSE3Collector(), and MSE3Collector::~MSE3Collector().

The detector's exits.

Definition at line 310 of file MSE3Collector.h.

Referenced by getExits().

Speed-threshold to determine if a vehicle is halting.

Definition at line 323 of file MSE3Collector.h.

Referenced by MSE3Collector::detectorUpdate(), MSE3Collector::enter(), and MSE3Collector::leave().

SUMOTime MSE3Collector::myLastResetTime [protected, inherited]

Information when the last reset has been done.

Definition at line 378 of file MSE3Collector.h.

Referenced by MSE3Collector::writeXMLOutput().

std::vector<MSE3LeaveReminder*> MSE3Collector::myLeaveReminders [protected, inherited]

The detector's built exit reminder.

Definition at line 316 of file MSE3Collector.h.

Referenced by MSE3Collector::MSE3Collector(), and MSE3Collector::~MSE3Collector().

std::map<SUMOVehicle*, E3Values> MSE3Collector::myLeftContainer [protected, inherited]

Container for vehicles that have left the area.

Definition at line 356 of file MSE3Collector.h.

Referenced by MSE3Collector::leave(), MSE3Collector::reset(), and MSE3Collector::writeXMLOutput().


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