A detector which joins E2Collectors over consecutive lanes (backward) More...

#include <MS_E2_ZS_CollectorOverLanes.h>

Inheritance diagram for MS_E2_ZS_CollectorOverLanes:

Public Types
typedef std::vector < MSE2Collector * >	CollectorCont
	Definition of a E2 collector storage.
Public Member Functions
const std::string &	getID () const throw ()
	Returns this detector's id.
SUMOReal	getLength () const throw ()
	Returns this detector's length [m].
const std::string &	getStartLaneID () const throw ()
	Returns the id of the lane this detector starts at.
void	init (MSLane *lane, SUMOReal detLength) throw ()
	Builds the consecutive E2 detectors.
	MS_E2_ZS_CollectorOverLanes (const std::string &id, DetectorUsage usage, MSLane *lane, SUMOReal startPos, SUMOTime haltingTimeThreshold, SUMOReal haltingSpeedThreshold, SUMOReal jamDistThreshold) throw ()
	Constructor.
void	setID (const std::string &newID)
	resets the id
virtual	~MS_E2_ZS_CollectorOverLanes () throw ()
	Destructor.
Methods inherited from MSDetectorFileOutput.
void	writeXMLOutput (OutputDevice &dev, SUMOTime startTime, SUMOTime stopTime) throw (IOError)
	Writes collected values into the given stream.
void	writeXMLDetectorProlog (OutputDevice &dev) const throw (IOError)
	Opens the XML-output using "detector" as root element.
Virtual methods to implement by derived classes
virtual void	reset () throw ()
	Resets collected values.
virtual void	detectorUpdate (const SUMOTime step) throw ()
	Updates the detector (computes values)
virtual GUIDetectorWrapper *	buildDetectorGUIRepresentation ()
	Builds the graphical representation.
Protected Types
typedef std::vector < MSE2Collector * >	DetectorVector
	Definition of a detector storage.
typedef std::vector < DetectorVector >	DetectorVectorVector
	Definition of a storage for detector vectors.
typedef std::vector< SUMOReal >	DoubleVector
	Definition of a SUMOReal storage.
typedef std::map< MSLane , MSE2Collector >	LaneDetMap
	Definition of a map from a lane to the detector lying on it.
typedef std::vector< MSLane * >	LaneVector
	Definition of a lane storage.
typedef std::vector< LaneVector >	LaneVectorVector
	Definition of a storage for lane vectors.
typedef DoubleVector	LengthVector
	Definition of a storage for SUMOReal vectors.
Protected Member Functions
virtual MSE2Collector *	buildCollector (size_t c, size_t r, MSLane *l, SUMOReal start, SUMOReal end) throw ()
	Builds a single collector.
void	extendTo (SUMOReal length) throw ()
	This method extends the current length up to the given.
std::vector< MSLane * >	getLanePredeccessorLanes (MSLane *l) throw ()
	Returns the list of lanes predecessing the given one.
std::string	makeID (const std::string &baseID, size_t c, size_t r) const throw ()
	Builds an id for one of the E2 collectors this detector uses.
Protected Attributes
SUMOReal	haltingSpeedThresholdM
	Describes how slow a vehicle must be before being assigned to a jam.
SUMOTime	haltingTimeThresholdM
	Describes how long a vehicle shall stay before being assigned to a jam.
SUMOReal	jamDistThresholdM
	Describes how long a jam must be before being recognized.
LaneDetMap	myAlreadyBuild
	Storage for detectors which already have been build for a single lane.
DetectorVectorVector	myDetectorCombinations
	Storage for detector combinations.
std::string	myID
	The id of this detector.
LaneVectorVector	myLaneCombinations
	Storage for lane combinations.
SUMOReal	myLength
	The length of the collector.
LengthVector	myLengths
	Storage for length combinations.
std::string	myStartLaneID
	The id of the lane this detector starts at.
DetectorUsage	myUsage
	Information about how this detector is used.
SUMOReal	startPosM
	The position the collector starts at.
Private Member Functions
	MS_E2_ZS_CollectorOverLanes (const MS_E2_ZS_CollectorOverLanes &)
	Invalidated copy constructor.
MS_E2_ZS_CollectorOverLanes &	operator= (const MS_E2_ZS_CollectorOverLanes &)
	Invalidated assignment operator.

Detailed Description

A detector which joins E2Collectors over consecutive lanes (backward)

This class is somekind of a wrapper over several MSE2Collectors.

For some reasons it may be necessary to use MSE2Collectors that are longer than the lane they begin at. In this case, this class should be used. MSE2Collectors are laid on consecutive lanes backwards, building a virtual detector for each lane combination.

There are still some problems with it: we do not know how the different combinations shall be treated.

Definition at line 62 of file MS_E2_ZS_CollectorOverLanes.h.

Member Typedef Documentation

typedef std::vector< MSE2Collector* > MS_E2_ZS_CollectorOverLanes::CollectorCont

Definition of a E2 collector storage.

Definition at line 66 of file MS_E2_ZS_CollectorOverLanes.h.

typedef std::vector<MSE2Collector*> MS_E2_ZS_CollectorOverLanes::DetectorVector [protected]

Definition of a detector storage.

Definition at line 212 of file MS_E2_ZS_CollectorOverLanes.h.

typedef std::vector<DetectorVector> MS_E2_ZS_CollectorOverLanes::DetectorVectorVector [protected]

Definition of a storage for detector vectors.

Definition at line 215 of file MS_E2_ZS_CollectorOverLanes.h.

typedef std::vector<SUMOReal> MS_E2_ZS_CollectorOverLanes::DoubleVector [protected]

Definition of a SUMOReal storage.

Definition at line 218 of file MS_E2_ZS_CollectorOverLanes.h.

typedef std::map<MSLane*, MSE2Collector*> MS_E2_ZS_CollectorOverLanes::LaneDetMap [protected]

Definition of a map from a lane to the detector lying on it.

Definition at line 249 of file MS_E2_ZS_CollectorOverLanes.h.

typedef std::vector<MSLane*> MS_E2_ZS_CollectorOverLanes::LaneVector [protected]

Definition of a lane storage.

Definition at line 206 of file MS_E2_ZS_CollectorOverLanes.h.

typedef std::vector<LaneVector> MS_E2_ZS_CollectorOverLanes::LaneVectorVector [protected]

Definition of a storage for lane vectors.

Definition at line 209 of file MS_E2_ZS_CollectorOverLanes.h.

typedef DoubleVector MS_E2_ZS_CollectorOverLanes::LengthVector [protected]

Definition of a storage for SUMOReal vectors.

Definition at line 221 of file MS_E2_ZS_CollectorOverLanes.h.

Constructor & Destructor Documentation

MS_E2_ZS_CollectorOverLanes::MS_E2_ZS_CollectorOverLanes	(	const std::string &	id,
		DetectorUsage	usage,
		MSLane *	lane,
		SUMOReal	startPos,
		SUMOTime	haltingTimeThreshold,
		SUMOReal	haltingSpeedThreshold,
		SUMOReal	jamDistThreshold
	)		throw ()

Constructor.

Parameters:

[in]	id	The id of the detector
[in]	usage	Information how the detector is used
[in]	lane	The lane the detector starts at
[in]	startPos	Begin position of the detector
[in]	detLength	Length of the detector
[in]	haltingTimeThreshold	The time a vehicle's speed must be below haltingSpeedThreshold to be assigned as jammed
[in]	haltingSpeedThreshold	The speed a vehicle's speed must be below to be assigned as jammed
[in]	jamDistThreshold	The distance between two vehicles in order to not count them to one jam

Todo:: The lane should not be given as a pointer

Definition at line 42 of file MS_E2_ZS_CollectorOverLanes.cpp.

MS_E2_ZS_CollectorOverLanes::~MS_E2_ZS_CollectorOverLanes ( ) throw () [virtual]

Destructor.

Definition at line 78 of file MS_E2_ZS_CollectorOverLanes.cpp.

MS_E2_ZS_CollectorOverLanes::MS_E2_ZS_CollectorOverLanes ( const MS_E2_ZS_CollectorOverLanes & ) [private]

Invalidated copy constructor.

Member Function Documentation

MSE2Collector * MS_E2_ZS_CollectorOverLanes::buildCollector	(	size_t	c,
		size_t	r,
		MSLane *	l,
		SUMOReal	start,
		SUMOReal	end
	)		throw () `[protected, virtual]`

Builds a single collector.

Parameters:

[in]	c	!!!
[in]	r	!!!
[in]	start	!!!
[in]	end	!!!

Todo:: Describe!

Reimplemented in GUI_E2_ZS_CollectorOverLanes.

Definition at line 195 of file MS_E2_ZS_CollectorOverLanes.cpp.

References SUMOReal.

virtual GUIDetectorWrapper* MSDetectorFileOutput::buildDetectorGUIRepresentation ( ) [inline, virtual, inherited]

Builds the graphical representation.

Meant to be overridden by grahical 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, GUI_E2_ZS_CollectorOverLanes, GUIE3Collector, GUIInductLoop, and GUIInstantInductLoop.

Definition at line 117 of file MSDetectorFileOutput.h.

virtual void MSDetectorFileOutput::detectorUpdate ( const SUMOTime step ) throw () [inline, virtual, inherited]

Updates the detector (computes values)

Parameters:

[in] step The current time step

Reimplemented in MSE2Collector, MSE3Collector, MSMeanData, and MSMeanData_Harmonoise.

Definition at line 109 of file MSDetectorFileOutput.h.

void MS_E2_ZS_CollectorOverLanes::extendTo ( SUMOReal length ) throw () [protected]

This method extends the current length up to the given.

This method is called consecutively until all paths have the desired length

Parameters:

[in] length !!!

Todo:: Describe length's usage

Definition at line 82 of file MS_E2_ZS_CollectorOverLanes.cpp.

References MSLane::getEdge(), MSEdge::getLanes(), MSLane::getLength(), and SUMOReal.

const std::string & MS_E2_ZS_CollectorOverLanes::getID ( ) const throw ()

Returns this detector's id.

Returns:: The id of this detector

Reimplemented from Named.

Definition at line 256 of file MS_E2_ZS_CollectorOverLanes.cpp.

References myID.

std::vector< MSLane * > MS_E2_ZS_CollectorOverLanes::getLanePredeccessorLanes ( MSLane * l ) throw () [protected]

Returns the list of lanes predecessing the given one.

Parameters:

[in] l The lane to return predecessors of

Returns:: List of lanes predecessing the given one

Definition at line 165 of file MS_E2_ZS_CollectorOverLanes.cpp.

References MSEdge::allowedLanes(), and SVC_UNKNOWN.

SUMOReal MS_E2_ZS_CollectorOverLanes::getLength ( ) const throw () [inline]

Returns this detector's length [m].

Returns:: This detector's length in meters

Definition at line 145 of file MS_E2_ZS_CollectorOverLanes.h.

References myLength.

const std::string & MS_E2_ZS_CollectorOverLanes::getStartLaneID ( ) const throw ()

Returns the id of the lane this detector starts at.

Returns:: The id of the lane this detector starts at

Todo:: Check whether this is needed

Definition at line 262 of file MS_E2_ZS_CollectorOverLanes.cpp.

References myStartLaneID.

void MS_E2_ZS_CollectorOverLanes::init	(	MSLane *	lane,
		SUMOReal	detLength
	)		throw ()

Builds the consecutive E2 detectors.

This is not done within the constructor to allow overriding of most functions but the building of detectors itself which in fact is depending on whether the normal or the gui-version is used

Parameters: