MSDetectorFileOutput Class Reference

#include <MSDetectorFileOutput.h>

Inheritance diagram for MSDetectorFileOutput:

---

Detailed Description

Base of value-generating classes (detectors).

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

See also:

MSDetector2File

Definition at line 56 of file MSDetectorFileOutput.h.

Virtual methods to implement by derived classes
virtual void	reset ()
	Resets collected values.
virtual void	writeXMLDetectorProlog (OutputDevice &dev) const =0 throw (IOError)
	Open the XML-output.
virtual void	writeXMLOutput (OutputDevice &dev, SUMOTime startTime, SUMOTime stopTime)=0 throw (IOError)
	Write the generated output to the given device.
	MSDetectorFileOutput (const MSDetectorFileOutput &)
	Invalidated copy constructor.
MSDetectorFileOutput &	operator= (const MSDetectorFileOutput &)
	Invalidated assignment operator.
Public Member Functions
	MSDetectorFileOutput () throw ()
	Constructor.
virtual	~MSDetectorFileOutput () throw ()
	(virtual) destructor

---

Constructor & Destructor Documentation

MSDetectorFileOutput::MSDetectorFileOutput

(

)

throw () [inline]

Constructor.

Definition at line 59 of file MSDetectorFileOutput.h.

{ }

virtual MSDetectorFileOutput::~MSDetectorFileOutput

(

)

throw () [inline, virtual]

(virtual) destructor

Definition at line 63 of file MSDetectorFileOutput.h.

{ }

MSDetectorFileOutput::MSDetectorFileOutput

(

const MSDetectorFileOutput &

)

[private]

Invalidated copy constructor.

---

Member Function Documentation

MSDetectorFileOutput& MSDetectorFileOutput::operator=

(

const MSDetectorFileOutput &

)

[private]

Invalidated assignment operator.

virtual void MSDetectorFileOutput::reset

(

)

[inline, virtual]

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, and MSInductLoop.

Definition at line 97 of file MSDetectorFileOutput.h.

Referenced by Command_SaveTLCoupledLaneDet::execute().

{ }

virtual void MSDetectorFileOutput::writeXMLDetectorProlog

(

OutputDevice &

dev

)

const throw (IOError) [pure virtual]

Open the XML-output.

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

Parameters:

[in]

dev

The output device to write the root into

Exceptions:

IOError

If an error on writing occurs

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

virtual void MSDetectorFileOutput::writeXMLOutput	(	OutputDevice &	dev,
		SUMOTime	startTime,
		SUMOTime	stopTime
	)			throw (IOError) [pure virtual]

Write the generated output to the given device.

Parameters:

[in]	dev	The output device to write the data into
[in]	startTime	First time step the data were gathered
[in]	stopTime	Last time step the data were gathered

Exceptions:

IOError

If an error on writing occurs

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

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

---

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

• MSDetectorFileOutput.h