SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MSDetectorFileOutput Class Reference

Base of value-generating classes (detectors) More...

#include <MSDetectorFileOutput.h>

Inheritance diagram for MSDetectorFileOutput:
Named MS_E2_ZS_CollectorOverLanes MSE2Collector MSE3Collector MSInductLoop MSInstantInductLoop MSMeanData MSRouteProbe GUI_E2_ZS_CollectorOverLanes GUI_E2_ZS_Collector GUIE3Collector GUIInductLoop GUIInstantInductLoop MSMeanData_Harmonoise MSMeanData_HBEFA MSMeanData_Net

Public Member Functions

const std::string & getID () const
 Returns the id.
 MSDetectorFileOutput (const std::string &id)
 Constructor.
void setID (const std::string &newID)
 resets the id
virtual ~MSDetectorFileOutput ()
 (virtual) destructor

Protected Attributes

std::string myID
 The name of the object.

Virtual methods to implement by derived classes

virtual void writeXMLOutput (OutputDevice &dev, SUMOTime startTime, SUMOTime stopTime)=0
 Write the generated output to the given device.
virtual void writeXMLDetectorProlog (OutputDevice &dev) const =0
 Open the XML-output.
virtual void reset ()
 Resets collected values.
virtual void detectorUpdate (const SUMOTime step)
 Updates the detector (computes values)
virtual GUIDetectorWrapperbuildDetectorGUIRepresentation ()
 Builds the graphical representation.
 MSDetectorFileOutput (const MSDetectorFileOutput &)
 Invalidated copy constructor.
MSDetectorFileOutputoperator= (const MSDetectorFileOutput &)
 Invalidated assignment operator.

Detailed Description

Base of value-generating classes (detectors)

Pure virtual base class for classes (e.g. MSInductLoop) that should produce XML-output.

Definition at line 65 of file MSDetectorFileOutput.h.


Constructor & Destructor Documentation

MSDetectorFileOutput::MSDetectorFileOutput ( const std::string &  id)
inline

Constructor.

Definition at line 68 of file MSDetectorFileOutput.h.

virtual MSDetectorFileOutput::~MSDetectorFileOutput ( )
inlinevirtual

(virtual) destructor

Definition at line 72 of file MSDetectorFileOutput.h.

MSDetectorFileOutput::MSDetectorFileOutput ( const MSDetectorFileOutput )
private

Invalidated copy constructor.


Member Function Documentation

virtual GUIDetectorWrapper* MSDetectorFileOutput::buildDetectorGUIRepresentation ( )
inlinevirtual

Builds the graphical representation.

Meant to be overridden by graphical versions of the detectors

Returns:
A wrapper for the detector which performs the user I/O within the GUI

Reimplemented in GUI_E2_ZS_Collector, GUIInductLoop, GUIE3Collector, GUI_E2_ZS_CollectorOverLanes, and GUIInstantInductLoop.

Definition at line 123 of file MSDetectorFileOutput.h.

virtual void MSDetectorFileOutput::detectorUpdate ( const SUMOTime  step)
inlinevirtual

Updates the detector (computes values)

Parameters:
[in]stepThe current time step

Reimplemented in MSMeanData, MSE3Collector, MSMeanData_Harmonoise, and MSE2Collector.

Definition at line 113 of file MSDetectorFileOutput.h.

References UNUSED_PARAMETER.

const std::string& Named::getID ( ) const
inlineinherited

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_TLS::processGet(), TraCIServerAPI_Lane::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().

MSDetectorFileOutput& MSDetectorFileOutput::operator= ( const MSDetectorFileOutput )
private

Invalidated assignment operator.

virtual void MSDetectorFileOutput::reset ( )
inlinevirtual

Resets collected values.

Please note that this is only a "hack" for coupled-tls-outputs.

See also:
Command_SaveTLCoupledLaneDet
Todo:
Reckeck/refactor

Reimplemented in MSE2Collector, MSE3Collector, MSInductLoop, and GUIInductLoop.

Definition at line 106 of file MSDetectorFileOutput.h.

Referenced by Command_SaveTLCoupledLaneDet::execute().

void Named::setID ( const std::string &  newID)
inlineinherited

resets the id

Definition at line 67 of file Named.h.

References Named::myID.

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

virtual void MSDetectorFileOutput::writeXMLDetectorProlog ( OutputDevice dev) const
pure virtual

Open the XML-output.

The implementing function should open an xml element using OutputDevice::writeXMLHeader.

Parameters:
[in]devThe output device to write the root into
Exceptions:
IOErrorIf an error on writing occurs

Implemented in MSMeanData, MSE3Collector, MSInductLoop, MSE2Collector, MSInstantInductLoop, MS_E2_ZS_CollectorOverLanes, and MSRouteProbe.

Referenced by MSDetectorControl::addDetectorAndInterval(), and Command_SaveTLCoupledDet::Command_SaveTLCoupledDet().

virtual void MSDetectorFileOutput::writeXMLOutput ( OutputDevice dev,
SUMOTime  startTime,
SUMOTime  stopTime 
)
pure virtual

Write the generated output to the given device.

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
Exceptions:
IOErrorIf an error on writing occurs

Implemented in MSMeanData, MSE3Collector, MSInductLoop, MSE2Collector, MSInstantInductLoop, MS_E2_ZS_CollectorOverLanes, and MSRouteProbe.

Referenced by Command_SaveTLCoupledLaneDet::execute(), Command_SaveTLCoupledDet::execute(), and MSDetectorControl::writeOutput().


Field Documentation


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