OutputDevice Class Reference

Static storage of an output device and its base (abstract) implementation. More...

#include <OutputDevice.h>

Inheritance diagram for OutputDevice:

Collaboration diagram for OutputDevice:

Static Public Member Functions
static std::string	realString (const double v, const int precision=gPrecision)
	Helper method for string formatting.
static access methods to OutputDevices
static OutputDevice &	getDevice (const std::string &name, bool usePrefix=true)
	Returns the described OutputDevice.
static bool	createDeviceByOption (const std::string &optionName, const std::string &rootElement="", const std::string &schemaFile="")
	Creates the device using the output definition stored in the named option.
static OutputDevice &	getDeviceByOption (const std::string &name)
	Returns the device described by the option.
static void	flushAll ()
static void	closeAll (bool keepErrorRetrievers=false)

OutputDevice member methods
static std::map< std::string, OutputDevice * >	myOutputDevices
	map from names to output devices
static int	myPrevConsoleCP = -1
	old console code page to restore after ending
const std::string	myFilename
OutputFormatter *const	myFormatter
	The formatter for XML.
	OutputDevice (const int defaultIndentation=0, const std::string &filename="")
	Constructor.
virtual	~OutputDevice ()
	Destructor.
virtual bool	ok ()
	returns the information whether one can write into the device
virtual bool	isNull ()
	returns the information whether the device will discard all output
const std::string &	getFilename ()
	get filename or suitable description of this device
void	close ()
	Closes the device and removes it from the dictionary.
void	setPrecision (int precision=gPrecision)
	Sets the precision or resets it to default.
int	precision ()
	return precision set on the device
int	getPrecision ()
	Returns the precision of the underlying stream.
bool	writeXMLHeader (const std::string &rootElement, const std::string &schemaFile, std::map< SumoXMLAttr, std::string > attrs=std::map< SumoXMLAttr, std::string >(), bool includeConfig=true)
	Writes an XML header with optional configuration.
template<typename E >
bool	writeHeader (const SumoXMLTag &rootElement)
OutputDevice &	openTag (const std::string &xmlElement)
	Opens an XML tag.
OutputDevice &	openTag (const SumoXMLTag &xmlElement)
	Opens an XML tag.
bool	closeTag (const std::string &comment="")
	Closes the most recently opened tag and optionally adds a comment.
void	lf ()
	writes a line feed if applicable
template<typename T >
OutputDevice &	writeAttr (const SumoXMLAttr attr, const T &val)
	writes a named attribute
bool	useAttribute (const SumoXMLAttr attr, SumoXMLAttrMask attributeMask) const
template<typename T >
OutputDevice &	writeOptionalAttr (const SumoXMLAttr attr, const T &val, long long int attributeMask)
	writes a named attribute unless filtered
template<typename T >
OutputDevice &	writeOptionalAttr (const SumoXMLAttr attr, const T &val, SumoXMLAttrMask attributeMask)
template<typename T >
OutputDevice &	writeAttr (const std::string &attr, const T &val)
	writes an arbitrary attribute
OutputDevice &	writeNonEmptyAttr (const SumoXMLAttr attr, const std::string &val)
	writes a string attribute only if it is not the empty string and not the string "default"
OutputDevice &	writePreformattedTag (const std::string &val)
	writes a preformatted tag to the device but ensures that any pending tags are closed
OutputDevice &	writePadding (const std::string &val)
	writes padding (ignored for binary output)
void	inform (const std::string &msg, const bool progress=false)
	Retrieves a message to this device.
template<class T >
OutputDevice &	operator<< (const T &t)
	Abstract output operator.
void	flush ()
bool	wroteHeader () const
virtual std::ostream &	getOStream ()=0
	Returns the associated ostream.
virtual void	postWriteHook ()
	Called after every write access.
	OutputDevice (const OutputDevice &)=delete
	Invalidated copy constructor.
OutputDevice &	operator= (const OutputDevice &)=delete
	Invalidated assignment operator.

Detailed Description

Static storage of an output device and its base (abstract) implementation.

OutputDevices are basically a capsule around an std::ostream, which give a unified access to sockets, files and stdout.

Usually, an application builds as many output devices as needed. Each output device may also be used to save outputs from several sources (several detectors, for example). Building is done using OutputDevice::getDevice() what also parses the given output description in order to decide what kind of an OutputDevice shall be built. OutputDevices are closed via OutputDevice::closeAll(), normally called at the application's end.

Although everything that can be written to a stream can also be written to an OutputDevice, there is special support for XML tags (remembering all open tags to close them at the end). OutputDevices are still lacking support for function pointers with the '<<' operator (no endl, use '
'). The most important method to implement in subclasses is getOStream, the most used part of the interface is the '<<' operator.

The Boolean markers are used rarely and might get removed in future versions.

Definition at line 61 of file OutputDevice.h.

Constructor & Destructor Documentation

OutputDevice() [1/2]

OutputDevice::OutputDevice	(	const int	defaultIndentation = 0,
		const std::string &	filename = ""
	)

Constructor.

Definition at line 206 of file OutputDevice.cpp.

~OutputDevice()

OutputDevice::~OutputDevice ( )

virtual

Destructor.

Definition at line 211 of file OutputDevice.cpp.

References myFormatter.

OutputDevice() [2/2]

OutputDevice::OutputDevice ( const OutputDevice &  )

privatedelete

Invalidated copy constructor.

Member Function Documentation

close()

void OutputDevice::close

(

)

Closes the device and removes it from the dictionary.

Definition at line 228 of file OutputDevice.cpp.

References closeTag(), myOutputDevices, and MsgHandler::removeRetrieverFromAllInstances().

Referenced by RONet::cleanup(), AStarRouter< E, V, M >::compute(), NBRailwayTopologyAnalyzer::getBrokenRailNodes(), GUIDialog_ViewSettings::onCmdExportSetting(), GUIDialog_Breakpoints::onCmdSave(), GNESelectorFrame::SelectionOperation::onCmdSave(), GUIParameterTracker::onCmdSave(), GUIDialog_EditViewport::onCmdSave(), GNERunNetgenerateDialog::onCmdSaveLog(), GNERunPythonToolDialog::onCmdSaveLog(), GNEMultipleParametersDialog::ParametersOperations::onCmdSaveParameters(), GNESingleParametersDialog::ParametersOperations::onCmdSaveParameters(), GNEVTypeDistributionsDialog::ParametersOperations::onCmdSaveParameters(), GNETLSEditorFrame::TLSFile::onCmdSaveTLSProgram(), GUIDialog_ViewSettings::onCmdSaveXMLDecals(), RODFDetectorCon::save(), PCPolyContainer::save(), GUISelectedStorage::save(), GNENet::saveAdditionalsConfirmed(), RODFDetectorCon::saveAsPOIs(), GNEFixDemandElements::FixOptions::saveContents(), GNEFixNetworkElements::FixOptions::saveContents(), GNENet::saveDataElementsConfirmed(), GNENet::saveDemandElementsConfirmed(), PCPolyContainer::saveDlrTDP(), GNENet::saveEdgeTypes(), GNENet::saveJuPedSimElements(), GNENet::saveMeanDatasConfirmed(), RODFDetectorCon::saveRoutes(), MSStateHandler::saveState(), GNENet::saveTLSPrograms(), GNEViewNet::saveVisualizationSettings(), NWWriter_DlrNavteq::writeConnectedLanes(), NWWriter_XML::writeEdgesAndConnections(), RODFDetector::writeEmitterDefinition(), RODFDetectorCon::writeEmitterPOIs(), RODFDetectorCon::writeEmitters(), RODFDetectorCon::writeEndRerouterDetectors(), NWWriter_XML::writeJoinedJunctions(), NWWriter_DlrNavteq::writeLinksUnsplitted(), NWWriter_Amitran::writeNetwork(), NWWriter_MATSim::writeNetwork(), NWWriter_OpenDrive::writeNetwork(), NWWriter_SUMO::writeNetwork(), NWWriter_XML::writeNodes(), NWWriter_DlrNavteq::writeNodesUnsplitted(), NWWriter_XML::writeParkingAreas(), NWWriter_DlrNavteq::writeProhibitedManoeuvres(), NWWriter_XML::writePTLines(), NWWriter_XML::writePTStops(), RODFDetector::writeSingleSpeedTrigger(), RODFDetectorCon::writeSpeedTrigger(), NWWriter_XML::writeStreetSigns(), NWWriter_XML::writeTrafficLights(), NWWriter_DlrNavteq::writeTrafficSignals(), NWWriter_XML::writeTypes(), and RODFDetectorCon::writeValidationDetectors().

closeAll()

void OutputDevice::closeAll ( bool  keepErrorRetrievers = false )

static

Closes all registered devices

Definition at line 149 of file OutputDevice.cpp.

References MsgHandler::getErrorInstance(), MsgHandler::isRetriever(), myOutputDevices, myPrevConsoleCP, TL, and WRITE_ERROR.

Referenced by MSNet::clearAll(), SystemFrame::close(), GUIRunThread::deleteSim(), and main().

Here is the caller graph for this function:

closeTag()

bool OutputDevice::closeTag

(

const std::string &

comment = ""

)

Closes the most recently opened tag and optionally adds a comment.

The topmost xml-element from the stack is written into the stream as a closing element. Depending on the formatter used this may be something like "</" + element + ">" or "/>" or nothing at all.

Returns

Whether a further element existed in the stack and could be closed

Todo:

it is not verified that the topmost element was closed

Definition at line 281 of file OutputDevice.cpp.

References OutputFormatter::closeTag(), getOStream(), myFormatter, and postWriteHook().

Referenced by MSDriveWay::_saveState(), MSRoutingEngine::adaptEdgeEfforts(), RORouteHandler::addStop(), AGActivityTripWriter::addTrip(), AGActivityTripWriter::AGActivityTripWriter(), MSDevice_SSM::cleanup(), MSDevice_ToC::cleanup(), close(), RORouteHandler::closeContainer(), RORouteHandler::closeContainerFlow(), computeRoutes(), MSRoute::dict_saveState(), MSDispatch_GreedyShared::dispatch(), MSDispatch_RouteExtension::dispatch(), Command_SaveTLSState::execute(), Command_SaveTLSSwitchStates::execute(), MSVTypeProbe::execute(), MSDevice_SSM::flushGlobalMeasures(), MSDevice_Bluelight::generateOutput(), MSDevice_ElecHybrid::generateOutput(), MSDevice_Emissions::generateOutput(), MSDevice_Example::generateOutput(), MSDevice_Taxi::generateOutput(), MSDevice_Battery::generateOutput(), MSDevice_StationFinder::generateOutput(), MSDevice_Tripinfo::generateOutputForUnfinished(), NBRailwayTopologyAnalyzer::getBrokenRailNodes(), MSRailSignalControl::haveDeadlock(), MSAbstractLaneChangeModel::laneChangeOutput(), RORouteHandler::myStartElement(), MSDevice_Vehroutes::notifyStopEnded(), GUIDialog_ViewSettings::onCmdExportSetting(), GUIDialog_EditViewport::onCmdSave(), GNEMultipleParametersDialog::ParametersOperations::onCmdSaveParameters(), GNESingleParametersDialog::ParametersOperations::onCmdSaveParameters(), GNEVTypeDistributionsDialog::ParametersOperations::onCmdSaveParameters(), GUIDialog_ViewSettings::onCmdSaveXMLDecals(), MSVehicleControl::removePending(), MSStageDriving::routeOutput(), MSStageTranship::routeOutput(), MSStageTrip::routeOutput(), MSStageWaiting::routeOutput(), MSStageWalking::routeOutput(), MSTransportable::routeOutput(), RODFDetectorCon::save(), GUIVisualizationSettings::save(), GUIPropertyScheme< T >::save(), RODFRouteCont::save(), ROPerson::Stop::saveAsXML(), ROPerson::PersonTrip::saveAsXML(), ROPerson::Ride::saveAsXML(), ROPerson::Walk::saveAsXML(), ROPerson::saveAsXML(), ROVehicle::saveAsXML(), GUIDialog_ViewSettings::saveDecals(), GNENet::saveEdgeTypes(), MSStateHandler::saveRNGs(), MSLane::saveRNGStates(), MSStateHandler::saveState(), MEVehicle::saveState(), MSEdgeControl::saveState(), MSInsertionControl::saveState(), MSLane::saveState(), MSVehicle::saveState(), MSVehicleControl::saveState(), MSVehicleTransfer::saveState(), MSRailSignalConstraint::saveState(), MSRailSignalConstraint_Predecessor::PassedTracker::saveState(), MSTransportable::saveState(), MESegment::saveState(), MSDevice_Routing::saveState(), MSDevice_Transportable::saveState(), MSDevice_Tripinfo::saveState(), MSDevice_Vehroutes::saveState(), MSTransportableDevice_Routing::saveState(), MSDevice_Battery::saveState(), MSDevice_StationFinder::saveState(), MSSimpleTrafficLightLogic::saveState(), GNEViewNet::saveVisualizationSettings(), MSStopOut::stopEnded(), MSTransportable::tripInfoOutput(), MSPerson::MSPersonStage_Access::tripInfoOutput(), MSStageDriving::tripInfoOutput(), MSStageTranship::tripInfoOutput(), MSStageWaiting::tripInfoOutput(), MSStageWalking::tripInfoOutput(), MSInstantInductLoop::write(), MSStop::write(), SUMOVTypeParameter::write(), SUMOVehicleParameter::Stop::write(), MSMeanData_Amitran::MSLaneMeanDataValues::write(), MSMeanData_Emissions::MSLaneMeanDataValues::write(), MSMeanData_Harmonoise::MSLaneMeanDataValues::write(), MSMeanData_Net::MSLaneMeanDataValues::write(), NBPTLine::write(), NBPTStop::write(), NBParking::write(), MSXMLRawOut::write(), MSElecHybridExport::write(), MSFullExport::write(), MSQueueExport::write(), MSFCDExport::write(), MSBatteryExport::write(), MSEmissionExport::write(), MSRailSignalConstraint_Predecessor::write(), ODMatrix::write(), GNEAccess::writeAdditional(), GNEBusStop::writeAdditional(), GNECalibrator::writeAdditional(), GNECalibratorFlow::writeAdditional(), GNEChargingStation::writeAdditional(), GNEClosingLaneReroute::writeAdditional(), GNEClosingReroute::writeAdditional(), GNEContainerStop::writeAdditional(), GNEDestProbReroute::writeAdditional(), GNEEntryExitDetector::writeAdditional(), GNEInductionLoopDetector::writeAdditional(), GNEInstantInductionLoopDetector::writeAdditional(), GNELaneAreaDetector::writeAdditional(), GNEMultiEntryExitDetector::writeAdditional(), GNEOverheadWire::writeAdditional(), GNEParkingArea::writeAdditional(), GNEParkingAreaReroute::writeAdditional(), GNEParkingSpace::writeAdditional(), GNERerouter::writeAdditional(), GNERerouterInterval::writeAdditional(), GNERouteProbe::writeAdditional(), GNERouteProbReroute::writeAdditional(), GNETAZ::writeAdditional(), GNETAZSourceSink::writeAdditional(), GNETractionSubstation::writeAdditional(), GNEVaporizer::writeAdditional(), GNEVariableSpeedSign::writeAdditional(), GNEVariableSpeedSignStep::writeAdditional(), MSElecHybridExport::writeAggregated(), MSChargingStation::writeAggregatedChargingStationOutput(), MSLink::writeApproaching(), NBSign::writeAsPOI(), MSDriveWay::writeBlocks(), MSRailSignal::writeBlocks(), MSDriveWay::writeBlockVehicles(), MSChargingStation::writeChargingStationOutput(), MSNet::writeCollisions(), NWWriter_SUMO::writeConnection(), Command_SaveTLSProgram::writeCurrent(), GNEDataSet::writeDataSet(), GNEContainer::writeDemandElement(), GNEPerson::writeDemandElement(), GNEPersonTrip::writeDemandElement(), GNERide::writeDemandElement(), GNERoute::writeDemandElement(), GNERouteDistribution::writeDemandElement(), GNEStopPlan::writeDemandElement(), GNETranship::writeDemandElement(), GNETransport::writeDemandElement(), GNEVehicle::writeDemandElement(), GNEVTypeDistribution::writeDemandElement(), GNEWalk::writeDemandElement(), MSDriveWay::writeDepatureBlocks(), NWWriter_SUMO::writeDistrict(), MSMeanData::writeEdge(), NWWriter_SUMO::writeEdge(), MSFullExport::writeEdge(), MSQueueExport::writeEdge(), MSXMLRawOut::writeEdge(), NWWriter_XML::writeEdgesAndConnections(), NBTypeCont::writeEdgeTypes(), RODFDetector::writeEmitterDefinition(), RODFDetectorCon::writeEmitters(), ODMatrix::writeFlows(), GNEEdgeData::writeGenericData(), GNEEdgeRelData::writeGenericData(), GNETAZRelData::writeGenericData(), NWWriter_OpenDrive::writeGeomLines(), NWWriter_OpenDrive::writeGeomPP3(), RONet::writeIntermodal(), NWWriter_SUMO::writeInternalConnection(), NWWriter_OpenDrive::writeInternalEdge(), NWWriter_SUMO::writeInternalEdges(), NWWriter_SUMO::writeInternalNodes(), ROMAAssignments::writeInterval(), NWWriter_XML::writeJoinedJunctions(), NWWriter_SUMO::writeJunction(), NWWriter_SUMO::writeLane(), MSFullExport::writeLane(), MSQueueExport::writeLane(), MSXMLRawOut::writeLane(), GeoConvHelper::writeLocation(), NBRequest::writeLogic(), GNEMeanData::writeMeanData(), NWWriter_OpenDrive::writeNetwork(), NWWriter_SUMO::writeNetwork(), IntermodalRouter< E, L, N, V >::writeNetwork(), NWWriter_XML::writeNodes(), NWWriter_OpenDrive::writeNormalEdge(), GNEDemandElementPlan::writeOriginStop(), MSDevice_SSM::writeOutConflict(), MSDevice_ToC::writeOutput(), MSNet::writeOutput(), MSDevice_Vehroutes::writeOutput(), MSDevice_BTreceiver::BTreceiverUpdate::writeOutput(), MSOverheadWire::writeOverheadWireSegmentOutput(), Parameterised::writeParams(), NWWriter_SUMO::writeProhibitions(), MSDevice_Tripinfo::writeRideStatistics(), NWWriter_OpenDrive::writeRoadObjectPOI(), NWWriter_OpenDrive::writeRoadObjectPoly(), NWWriter_OpenDrive::writeRoadObjects(), NWWriter_SUMO::writeRoundabout(), NWWriter_OpenDrive::writeSignals(), RODFDetector::writeSingleSpeedTrigger(), RODFDetectorCon::writeSpeedTrigger(), MSNet::writeStatistics(), MSDevice_Tripinfo::writeStatistics(), NWWriter_SUMO::writeStopOffsets(), MSNet::writeSummaryOutput(), MSFullExport::writeTLS(), MSTractionSubstation::writeTractionSubstationOutput(), NWWriter_SUMO::writeTrafficLight(), MSFCDExport::writeTransportable(), MSXMLRawOut::writeTransportable(), RODFDetectorCon::writeValidationDetectors(), MSXMLRawOut::writeVehicle(), MSAmitranTrajectories::writeVehicle(), MSChargingStation::writeVehicle(), MSOverheadWire::writeVehicle(), MSFullExport::writeVehicles(), IntermodalRouter< E, L, N, V >::writeWeights(), GUIDialog_EditViewport::writeXML(), SUMOPolygon::writeXML(), PointOfInterest::writeXML(), RORouteDef::writeXMLDefinition(), RORoute::writeXMLDefinition(), TrajectoriesHandler::writeXMLEmissions(), MSInductLoop::writeXMLOutput(), MSMeanData::writeXMLOutput(), MSCalibrator::writeXMLOutput(), MSRouteProbe::writeXMLOutput(), and MSDevice_Vehroutes::writeXMLRoute().

createDeviceByOption()

bool OutputDevice::createDeviceByOption ( const std::string &  optionName, const std::string &  rootElement = "", const std::string &  schemaFile = ""  )

static

Creates the device using the output definition stored in the named option.

Creates and returns the device named by the option. Asks whether the option and retrieves the name from the option if so. Optionally the XML header gets written as well. Returns whether a device was created (option was set).

Please note, that we do not have to consider the "application base" herein, because this call is only used to get file names of files referenced within XML-declarations of structures which paths already is aware of the cwd.

Parameters

[in]	optionName	The name of the option to use for retrieving the output definition
[in]	rootElement	The root element to use (XML-output)
[in]	schemaFile	The basename of the schema file to use (XML-output)

Returns

Whether a device was built (the option was set)

Exceptions

IOError

If the output could not be built for any reason (error message is supplied)

Definition at line 116 of file OutputDevice.cpp.

References getDevice(), OptionsCont::getOptions(), and writeXMLHeader().

Referenced by MSFrame::buildStreams(), computeAllPairs(), computeRoutes(), MSDevice_Vehroutes::init(), MSPModel_JuPedSim::initialize(), MSRoutingEngine::initWeightUpdate(), main(), main(), MSDispatch::MSDispatch(), MSTransportableControl::MSTransportableControl(), GNEAttributeCarrier::writeAttributeHelp(), RONet::writeIntermodal(), and NWWriter_OpenDrive::writeNetwork().

Here is the caller graph for this function:

flush()

void OutputDevice::flush ( )

inline

Definition at line 349 of file OutputDevice.h.

References getOStream().

Referenced by OutputDevice_CERR::postWriteHook(), OutputDevice_COUT::postWriteHook(), MSVehicleControl::removePending(), and MSMeanData::writeXMLOutput().

Here is the caller graph for this function:

flushAll()

void OutputDevice::flushAll ( )

static

Flushes all registered devices

Definition at line 141 of file OutputDevice.cpp.

References myOutputDevices.

Referenced by GUINet::flushOutputsAtEnd().

Here is the caller graph for this function:

getDevice()

OutputDevice & OutputDevice::getDevice ( const std::string &  name, bool  usePrefix = true  )

static

Returns the described OutputDevice.

Creates and returns the named device. "stdout" and "stderr" refer to the relevant console streams, "hostname:port" initiates socket connection. Otherwise a filename is assumed (where "nul" and "/dev/null" do what you would expect on both platforms). If there already is a device with the same name this one is returned.

Parameters

[in]

name

The description of the output name/port/whatever

Returns

The corresponding (built or existing) device

Exceptions

IOError

If the output could not be built for any reason (error message is supplied)

Definition at line 60 of file OutputDevice.cpp.

References OutputDevice_CERR::getDevice(), OutputDevice_COUT::getDevice(), OptionsIO::getLoadTime(), OptionsCont::getOptions(), getOStream(), OptionsCont::getString(), FileHelpers::isSocket(), myOutputDevices, myPrevConsoleCP, FileHelpers::prependToLastPathComponent(), setPrecision(), StringUtils::substituteEnvironment(), TL, and StringUtils::toInt().

Referenced by MSDetectorControl::add(), MSDetectorControl::add(), NLDetectorBuilder::buildE2Detector(), NLDetectorBuilder::buildE2Detector(), NLDiscreteEventBuilder::buildSaveTLSProgramCommand(), NLDiscreteEventBuilder::buildSaveTLStateCommand(), NLDiscreteEventBuilder::buildSaveTLSwitchesCommand(), NLDiscreteEventBuilder::buildSaveTLSwitchStatesCommand(), NLDetectorBuilder::buildVTypeProbe(), MSDevice_SSM::cleanup(), MSDevice_ToC::cleanup(), AStarRouter< E, V, M >::compute(), createDeviceByOption(), NLDetectorBuilder::createInstantInductLoop(), GUIDetectorBuilder::createInstantInductLoop(), NBRailwayTopologyAnalyzer::getBrokenRailNodes(), getDeviceByOption(), MsgHandler::initOutputOptions(), main(), MSCalibrator::MSCalibrator(), MSDevice_SSM::MSDevice_SSM(), MSDevice_ToC::MSDevice_ToC(), MsgHandler::MsgHandler(), GUIDialog_ViewSettings::onCmdExportSetting(), GUIDialog_Breakpoints::onCmdSave(), GNESelectorFrame::SelectionOperation::onCmdSave(), GUIParameterTracker::onCmdSave(), GUIDialog_EditViewport::onCmdSave(), GNERunNetgenerateDialog::onCmdSaveLog(), GNERunPythonToolDialog::onCmdSaveLog(), GNEMultipleParametersDialog::ParametersOperations::onCmdSaveParameters(), GNESingleParametersDialog::ParametersOperations::onCmdSaveParameters(), GNEVTypeDistributionsDialog::ParametersOperations::onCmdSaveParameters(), GNETLSEditorFrame::TLSFile::onCmdSaveTLSProgram(), GUIDialog_ViewSettings::onCmdSaveXMLDecals(), RONet::openOutput(), RandHelper::rand(), GUILoadThread::run(), RODFDetectorCon::save(), PCPolyContainer::save(), GUISelectedStorage::save(), GNENet::saveAdditionalsConfirmed(), RODFDetectorCon::saveAsPOIs(), GNEFixDemandElements::FixOptions::saveContents(), GNEFixNetworkElements::FixOptions::saveContents(), GNENet::saveDataElementsConfirmed(), GNENet::saveDemandElementsConfirmed(), PCPolyContainer::saveDlrTDP(), GNENet::saveEdgeTypes(), GNENet::saveJuPedSimElements(), GNENet::saveMeanDatasConfirmed(), RODFDetectorCon::saveRoutes(), MSStateHandler::saveState(), GNENet::saveTLSPrograms(), GNEViewNet::saveVisualizationSettings(), NWWriter_DlrNavteq::writeConnectedLanes(), NWWriter_XML::writeDistricts(), NWWriter_XML::writeEdgesAndConnections(), RODFDetector::writeEmitterDefinition(), RODFDetectorCon::writeEmitterPOIs(), RODFDetectorCon::writeEmitters(), RODFDetectorCon::writeEndRerouterDetectors(), RONet::writeIntermodal(), NWWriter_XML::writeJoinedJunctions(), NWWriter_DlrNavteq::writeLinksUnsplitted(), NWWriter_Amitran::writeNetwork(), NWWriter_MATSim::writeNetwork(), NWWriter_OpenDrive::writeNetwork(), NWWriter_SUMO::writeNetwork(), NWWriter_XML::writeNodes(), NWWriter_DlrNavteq::writeNodesUnsplitted(), MSNet::writeOutput(), NWWriter_XML::writeParkingAreas(), NWWriter_DlrNavteq::writeProhibitedManoeuvres(), NWWriter_XML::writePTLines(), NWWriter_XML::writePTStops(), NIImporter_OpenDrive::writeRoadObjects(), RODFDetector::writeSingleSpeedTrigger(), RODFDetectorCon::writeSpeedTrigger(), NWWriter_XML::writeStreetSigns(), NWWriter_XML::writeTrafficLights(), NWWriter_DlrNavteq::writeTrafficSignals(), NWWriter_XML::writeTypes(), and RODFDetectorCon::writeValidationDetectors().

getDeviceByOption()

OutputDevice & OutputDevice::getDeviceByOption ( const std::string &  name )

static

Returns the device described by the option.

Returns the device named by the option. If the option is unknown, unset or the device was not created before, InvalidArgument is thrown.

Please note, that we do not have to consider the "application base" herein.

Parameters

[in]

name

The name of the option to use for retrieving the output definition

Returns

The corresponding (built or existing) device

Exceptions

IOError	If the output could not be built for any reason (error message is supplied)
InvalidArgument	If the option with the given name does not exist

Definition at line 131 of file OutputDevice.cpp.

References getDevice(), OptionsCont::getOptions(), OptionsCont::getString(), and myOutputDevices.

Referenced by MSRoutingEngine::adaptEdgeEfforts(), MSNet::closeSimulation(), computeAllPairs(), computeRoutes(), MSTransportableControl::erase(), MSDevice_Tripinfo::generateOutputForUnfinished(), MSRailSignalControl::haveDeadlock(), MSDevice_Vehroutes::init(), MSStopOut::init(), MSPModel_JuPedSim::initialize(), MSAbstractLaneChangeModel::laneChangeOutput(), main(), MSDispatch::MSDispatch(), MSTransportableControl::MSTransportableControl(), MSVehicleControl::removePending(), GNEAttributeCarrier::writeAttributeHelp(), MSNet::writeChargingStationOutput(), MSNet::writeCollisions(), RONet::writeIntermodal(), MSNet::writeOutput(), MSDevice_Vehroutes::writeOutput(), MSDevice_BTreceiver::BTreceiverUpdate::writeOutput(), MSNet::writeOverheadWireSegmentOutput(), MSNet::writeRailSignalBlocks(), MSNet::writeStatistics(), MSNet::writeSubstationOutput(), and MSNet::writeSummaryOutput().

Here is the caller graph for this function:

getFilename()

const std::string & OutputDevice::getFilename

(

)

get filename or suitable description of this device

Definition at line 223 of file OutputDevice.cpp.

References myFilename.

getOStream()

virtual std::ostream & OutputDevice::getOStream ( )

protectedpure virtual

Returns the associated ostream.

Implemented in MsgRetrievingFunction< T >, GUIMessageWindow::MsgOutputDevice, OutputDevice_CERR, OutputDevice_COUT, OutputDevice_Network, OutputDevice_String, and OutputDevice_File.

Referenced by closeTag(), flush(), getDevice(), getPrecision(), inform(), lf(), ok(), openTag(), openTag(), operator<<(), precision(), setPrecision(), writeAttr(), writeAttr(), writeHeader(), writeOptionalAttr(), writeOptionalAttr(), writePadding(), writePreformattedTag(), and writeXMLHeader().

Here is the caller graph for this function:

getPrecision()

int OutputDevice::getPrecision ( )

inline

Returns the precision of the underlying stream.

Definition at line 177 of file OutputDevice.h.

References getOStream().

Referenced by GUIPropertyScheme< T >::save().

Here is the caller graph for this function:

inform()

void OutputDevice::inform	(	const std::string &	msg,
		const bool	progress = false
	)

Retrieves a message to this device.

Implementation of the MessageRetriever interface. Writes the given message to the output device.

Parameters

[in]

msg

The msg to write to the device

Definition at line 295 of file OutputDevice.cpp.

References getOStream(), and postWriteHook().

isNull()

virtual bool OutputDevice::isNull ( )

inlinevirtual

returns the information whether the device will discard all output

Returns

Whether the device redirects to /dev/null

Reimplemented in OutputDevice_File.

Definition at line 155 of file OutputDevice.h.

Referenced by RONet::openOutput(), MSInstantInductLoop::write(), MSE2Collector::writeXMLOutput(), and MSInductLoop::writeXMLOutput().

Here is the caller graph for this function:

lf()

void OutputDevice::lf ( )

inline

writes a line feed if applicable

Definition at line 242 of file OutputDevice.h.

References getOStream().

Referenced by AGActivityTripWriter::AGActivityTripWriter(), MSTransportable::routeOutput(), GUIVisualizationSettings::save(), MSDriveWay::writeBlocks(), NWWriter_XML::writeEdgesAndConnections(), NBTypeCont::writeEdgeTypes(), GeoConvHelper::writeLocation(), NWWriter_OpenDrive::writeNetwork(), NWWriter_SUMO::writeNetwork(), MSDevice_Vehroutes::writeOutput(), NWWriter_SUMO::writeRoundabouts(), and NWWriter_SUMO::writeTrafficLights().

Here is the caller graph for this function:

ok()

bool OutputDevice::ok ( )

virtual

returns the information whether one can write into the device

Returns

Whether the device can be used (stream is good)

Definition at line 217 of file OutputDevice.cpp.

References getOStream().

openTag() [1/2]

OutputDevice & OutputDevice::openTag

(

const std::string &

xmlElement

)

Opens an XML tag.

An indentation, depending on the current xml-element-stack size, is written followed by the given xml element ("<" + xmlElement) The xml element is added to the stack, then.

Parameters

[in]

xmlElement

Name of element to open

Returns

The OutputDevice for further processing

Definition at line 267 of file OutputDevice.cpp.

References getOStream(), myFormatter, and OutputFormatter::openTag().

Referenced by MSDriveWay::_saveState(), MSRoutingEngine::adaptEdgeEfforts(), RORouteHandler::addStop(), AGActivityTripWriter::addTrip(), AGActivityTripWriter::AGActivityTripWriter(), computeRoutes(), MSRoute::dict_saveState(), MSDispatch_GreedyShared::dispatch(), MSDispatch_RouteExtension::dispatch(), Command_SaveTLSState::execute(), Command_SaveTLSSwitchStates::execute(), MSVTypeProbe::execute(), MSDevice_SSM::flushGlobalMeasures(), MSDevice_Bluelight::generateOutput(), MSDevice_ElecHybrid::generateOutput(), MSDevice_Emissions::generateOutput(), MSDevice_Example::generateOutput(), MSDevice_Taxi::generateOutput(), MSDevice_Tripinfo::generateOutput(), MSDevice_Battery::generateOutput(), MSDevice_StationFinder::generateOutput(), NBRailwayTopologyAnalyzer::getBrokenRailNodes(), MSRailSignalControl::haveDeadlock(), MSAbstractLaneChangeModel::laneChangeOutput(), RORouteHandler::myStartElement(), GUIDialog_ViewSettings::onCmdExportSetting(), GUIDialog_EditViewport::onCmdSave(), GNEMultipleParametersDialog::ParametersOperations::onCmdSaveParameters(), GNESingleParametersDialog::ParametersOperations::onCmdSaveParameters(), GNEVTypeDistributionsDialog::ParametersOperations::onCmdSaveParameters(), GUIDialog_ViewSettings::onCmdSaveXMLDecals(), MSMeanData::openInterval(), MSMeanData_Amitran::openInterval(), MSStageDriving::routeOutput(), MSStageTranship::routeOutput(), MSStageTrip::routeOutput(), MSStageWaiting::routeOutput(), MSStageWalking::routeOutput(), RODFDetectorCon::save(), GUIVisualizationSettings::save(), GUIPropertyScheme< T >::save(), RODFRouteCont::save(), RODFDetectorCon::saveAsPOIs(), ROPerson::PersonTrip::saveAsXML(), ROPerson::Ride::saveAsXML(), ROPerson::Walk::saveAsXML(), GUIDialog_ViewSettings::saveDecals(), GNENet::saveEdgeTypes(), MSStateHandler::saveRNGs(), MSLane::saveRNGStates(), MSStateHandler::saveState(), MSEdgeControl::saveState(), MSLane::saveState(), MSVehicleControl::saveState(), MSVehicleTransfer::saveState(), MSRailSignalConstraint::saveState(), MSRailSignalConstraint_Predecessor::PassedTracker::saveState(), MESegment::saveState(), MSDevice_Routing::saveState(), MSDevice_Transportable::saveState(), MSDevice_Tripinfo::saveState(), MSDevice_Vehroutes::saveState(), MSTransportableDevice_Routing::saveState(), MSDevice_Battery::saveState(), MSDevice_StationFinder::saveState(), MSSimpleTrafficLightLogic::saveState(), GNENet::saveTLSPrograms(), GNEViewNet::saveVisualizationSettings(), MSStopOut::stopEnded(), MSTransportable::tripInfoOutput(), MSPerson::MSPersonStage_Access::tripInfoOutput(), MSStageDriving::tripInfoOutput(), MSStageTranship::tripInfoOutput(), MSStageWaiting::tripInfoOutput(), MSStageWalking::tripInfoOutput(), MSInstantInductLoop::write(), SUMOVTypeParameter::write(), SUMOVehicleParameter::Stop::write(), SUMOVehicleParameter::write(), MSMeanData_Amitran::MSLaneMeanDataValues::write(), NBPTLine::write(), NBPTStop::write(), NBParking::write(), MSXMLRawOut::write(), MSElecHybridExport::write(), MSFullExport::write(), MSQueueExport::write(), MSFCDExport::write(), MSBatteryExport::write(), MSEmissionExport::write(), MSRailSignalConstraint_Predecessor::write(), ODMatrix::write(), GNEAccess::writeAdditional(), GNEBusStop::writeAdditional(), GNECalibrator::writeAdditional(), GNECalibratorFlow::writeAdditional(), GNEChargingStation::writeAdditional(), GNEClosingLaneReroute::writeAdditional(), GNEClosingReroute::writeAdditional(), GNEContainerStop::writeAdditional(), GNEDestProbReroute::writeAdditional(), GNEEntryExitDetector::writeAdditional(), GNEInductionLoopDetector::writeAdditional(), GNEInstantInductionLoopDetector::writeAdditional(), GNELaneAreaDetector::writeAdditional(), GNEMultiEntryExitDetector::writeAdditional(), GNEOverheadWire::writeAdditional(), GNEParkingArea::writeAdditional(), GNEParkingAreaReroute::writeAdditional(), GNEParkingSpace::writeAdditional(), GNERerouter::writeAdditional(), GNERerouterInterval::writeAdditional(), GNERouteProbe::writeAdditional(), GNERouteProbReroute::writeAdditional(), GNETAZ::writeAdditional(), GNETAZSourceSink::writeAdditional(), GNETractionSubstation::writeAdditional(), GNEVaporizer::writeAdditional(), GNEVariableSpeedSign::writeAdditional(), GNEVariableSpeedSignStep::writeAdditional(), MSElecHybridExport::writeAggregated(), MSChargingStation::writeAggregatedChargingStationOutput(), MSLink::writeApproaching(), NBSign::writeAsPOI(), MSDriveWay::writeBlocks(), MSRailSignal::writeBlocks(), MSDriveWay::writeBlockVehicles(), MSChargingStation::writeChargingStationOutput(), MSNet::writeCollisions(), NWWriter_SUMO::writeConnection(), Command_SaveTLSProgram::writeCurrent(), GNEDataSet::writeDataSet(), GNEPersonTrip::writeDemandElement(), GNERide::writeDemandElement(), GNERoute::writeDemandElement(), GNERouteDistribution::writeDemandElement(), GNEStop::writeDemandElement(), GNEStopPlan::writeDemandElement(), GNETranship::writeDemandElement(), GNETransport::writeDemandElement(), GNEVTypeDistribution::writeDemandElement(), GNEWalk::writeDemandElement(), MSDriveWay::writeDepatureBlocks(), NWWriter_SUMO::writeDistrict(), MSMeanData::writeEdge(), NWWriter_SUMO::writeEdge(), MSFullExport::writeEdge(), MSQueueExport::writeEdge(), MSXMLRawOut::writeEdge(), NWWriter_XML::writeEdgesAndConnections(), NBTypeCont::writeEdgeTypes(), RODFDetector::writeEmitterDefinition(), RODFDetectorCon::writeEmitterPOIs(), RODFDetectorCon::writeEmitters(), RODFDetectorCon::writeEndRerouterDetectors(), ODMatrix::writeFlows(), GNEEdgeData::writeGenericData(), GNEEdgeRelData::writeGenericData(), GNETAZRelData::writeGenericData(), NWWriter_OpenDrive::writeGeomLines(), NWWriter_OpenDrive::writeGeomPP3(), RONet::writeIntermodal(), NWWriter_SUMO::writeInternalConnection(), NWWriter_OpenDrive::writeInternalEdge(), NWWriter_SUMO::writeInternalEdges(), NWWriter_SUMO::writeInternalNodes(), ROMAAssignments::writeInterval(), NWWriter_XML::writeJoinedJunctions(), NWWriter_SUMO::writeJunction(), NWWriter_SUMO::writeLane(), MSFullExport::writeLane(), MSQueueExport::writeLane(), MSXMLRawOut::writeLane(), GeoConvHelper::writeLocation(), NBRequest::writeLogic(), GNEMeanData::writeMeanData(), NWWriter_OpenDrive::writeNetwork(), NWWriter_SUMO::writeNetwork(), IntermodalRouter< E, L, N, V >::writeNetwork(), NWWriter_XML::writeNodes(), NWWriter_OpenDrive::writeNormalEdge(), GNEDemandElementPlan::writeOriginStop(), MSDevice_SSM::writeOutConflict(), MSDevice_ToC::writeOutput(), MSNet::writeOutput(), MSDevice_Vehroutes::writeOutput(), MSDevice_BTreceiver::BTreceiverUpdate::writeOutput(), MSOverheadWire::writeOverheadWireSegmentOutput(), Parameterised::writeParams(), MSMeanData::writePrefix(), MSMeanData_Amitran::writePrefix(), NWWriter_SUMO::writeProhibitions(), MSDevice_Tripinfo::writeRideStatistics(), NWWriter_OpenDrive::writeRoadObjectPOI(), NWWriter_OpenDrive::writeRoadObjectPoly(), NWWriter_OpenDrive::writeRoadObjects(), NWWriter_SUMO::writeRoundabout(), NWWriter_OpenDrive::writeSignals(), RODFDetector::writeSingleSpeedTrigger(), RODFDetectorCon::writeSpeedTrigger(), MSNet::writeStatistics(), MSDevice_Tripinfo::writeStatistics(), NWWriter_SUMO::writeStopOffsets(), MSNet::writeSummaryOutput(), MSFullExport::writeTLS(), MSTractionSubstation::writeTractionSubstationOutput(), NWWriter_SUMO::writeTrafficLight(), MSFCDExport::writeTransportable(), MSXMLRawOut::writeTransportable(), RODFDetectorCon::writeValidationDetectors(), MSXMLRawOut::writeVehicle(), MSAmitranTrajectories::writeVehicle(), MSChargingStation::writeVehicle(), MSOverheadWire::writeVehicle(), MSFullExport::writeVehicles(), IntermodalRouter< E, L, N, V >::writeWeights(), GUIDialog_EditViewport::writeXML(), SUMOPolygon::writeXML(), PointOfInterest::writeXML(), RORouteDef::writeXMLDefinition(), RORoute::writeXMLDefinition(), TrajectoriesHandler::writeXMLEmissions(), MEInductLoop::writeXMLOutput(), MSInductLoop::writeXMLOutput(), MSCalibrator::writeXMLOutput(), MSRouteProbe::writeXMLOutput(), and MSDevice_Vehroutes::writeXMLRoute().

openTag() [2/2]

OutputDevice & OutputDevice::openTag

(

const SumoXMLTag &

xmlElement

)

Opens an XML tag.

Helper method which finds the correct string before calling openTag.

Parameters

[in]

xmlElement

Id of the element to open

Returns

The OutputDevice for further processing

Definition at line 274 of file OutputDevice.cpp.

References getOStream(), myFormatter, and OutputFormatter::openTag().

operator<<()

template<class T >

OutputDevice & OutputDevice::operator<< ( const T &  t )

inline

Abstract output operator.

Returns

The OutputDevice for further processing

Definition at line 343 of file OutputDevice.h.

References getOStream(), and postWriteHook().

operator=()

OutputDevice & OutputDevice::operator= ( const OutputDevice &  )

privatedelete

Invalidated assignment operator.

postWriteHook()

void OutputDevice::postWriteHook ( )

protectedvirtual

Called after every write access.

Default implementation does nothing.

Reimplemented in MsgRetrievingFunction< T >, GUIMessageWindow::MsgOutputDevice, OutputDevice_CERR, OutputDevice_COUT, and OutputDevice_Network.

Definition at line 291 of file OutputDevice.cpp.

Referenced by closeTag(), inform(), and operator<<().

Here is the caller graph for this function:

precision()

int OutputDevice::precision

(

)

return precision set on the device

Definition at line 248 of file OutputDevice.cpp.

References getOStream().

Referenced by realString(), MSBaseVehicle::saveState(), setPrecision(), and SUMOVehicleParameter::write().

Here is the caller graph for this function:

realString()

std::string OutputDevice::realString ( const double  v, const int  precision = gPrecision  )

static

Helper method for string formatting.

Parameters

[in]	v	The floating point value to be formatted
[in]	precision	the precision to achieve

Returns

The formatted string

Definition at line 186 of file OutputDevice.cpp.

References precision().

Referenced by MSDevice_Emissions::generateOutput(), NBNodeCont::joinSameJunctions(), and MSMeanData_Emissions::MSLaneMeanDataValues::write().

Here is the caller graph for this function:

setPrecision()

void OutputDevice::setPrecision

(

int

precision = gPrecision

)

Sets the precision or resets it to default.

Parameters

[in]

precision

The accuracy (number of digits behind '.') to set

Definition at line 242 of file OutputDevice.cpp.

References getOStream(), and precision().

Referenced by MSVTypeProbe::execute(), getDevice(), MSPModel_JuPedSim::initialize(), OutputDevice_String::OutputDevice_String(), PCPolyContainer::save(), GUIPropertyScheme< T >::save(), ROPerson::PersonTrip::saveAsXML(), ROVehicle::saveAsXML(), PCPolyContainer::saveDlrTDP(), MSStateHandler::saveState(), MSBaseVehicle::saveState(), MSTransportable::saveState(), SUMOVehicleParameter::write(), MSXMLRawOut::write(), MSElecHybridExport::write(), MSFCDExport::write(), MSBatteryExport::write(), MSEmissionExport::write(), MSElecHybridExport::writeAggregated(), NWWriter_SUMO::writeConnection(), ODMatrix::writeFlows(), NWWriter_OpenDrive::writeInternalEdge(), GeoConvHelper::writeLocation(), NWWriter_XML::writeNodes(), NWWriter_DlrNavteq::writeNodesUnsplitted(), NWWriter_OpenDrive::writeNormalEdge(), MSDevice_Vehroutes::writeOutput(), NWWriter_OpenDrive::writeRoadObjects(), NWWriter_XML::writeShape(), NWWriter_OpenDrive::writeSignals(), MSDevice_Tripinfo::writeStatistics(), MSNet::writeSubstationOutput(), NWWriter_DlrNavteq::writeTrafficSignals(), MSFCDExport::writeTransportable(), SUMOPolygon::writeXML(), PointOfInterest::writeXML(), and RORoute::writeXMLDefinition().

Here is the caller graph for this function:

useAttribute()

bool OutputDevice::useAttribute ( const SumoXMLAttr  attr, SumoXMLAttrMask  attributeMask  ) const

inline

Definition at line 259 of file OutputDevice.h.

Referenced by MSFCDExport::write(), writeOptionalAttr(), and writeOptionalAttr().

Here is the caller graph for this function:

writeAttr() [1/2]

template<typename T >

OutputDevice & OutputDevice::writeAttr ( const std::string &  attr, const T &  val  )

inline

writes an arbitrary attribute

Parameters

[in]	attr	The attribute (name)
[in]	val	The attribute value

Returns

The OutputDevice for further processing

Definition at line 295 of file OutputDevice.h.

References getOStream(), and PlainXMLFormatter::writeAttr().

writeAttr() [2/2]

template<typename T >

OutputDevice & OutputDevice::writeAttr ( const SumoXMLAttr  attr, const T &  val  )

inline

writes a named attribute

Parameters

[in]	attr	The attribute (name)
[in]	val	The attribute value

Returns

The OutputDevice for further processing

Definition at line 254 of file OutputDevice.h.

References getOStream(), and PlainXMLFormatter::writeAttr().

Referenced by MSDriveWay::_saveState(), MSRoutingEngine::adaptEdgeEfforts(), AGActivityTripWriter::addTrip(), AGActivityTripWriter::AGActivityTripWriter(), computeRoutes(), MSRoute::dict_saveState(), MSDispatch_GreedyShared::dispatch(), MSDispatch_RouteExtension::dispatch(), Command_SaveTLSState::execute(), Command_SaveTLSSwitchStates::execute(), MSVTypeProbe::execute(), MSDevice_SSM::flushGlobalMeasures(), MSDevice_ElecHybrid::generateOutput(), MSDevice_Emissions::generateOutput(), MSDevice_Example::generateOutput(), MSDevice_Taxi::generateOutput(), MSDevice_Tripinfo::generateOutput(), MSDevice_Battery::generateOutput(), MSDevice_StationFinder::generateOutput(), NBRailwayTopologyAnalyzer::getBrokenRailNodes(), MSRailSignalControl::haveDeadlock(), MSAbstractLaneChangeModel::laneChangeOutput(), MSDevice_Vehroutes::notifyStopEnded(), GUIDialog_ViewSettings::onCmdExportSetting(), GNEMultipleParametersDialog::ParametersOperations::onCmdSaveParameters(), GNESingleParametersDialog::ParametersOperations::onCmdSaveParameters(), GNEVTypeDistributionsDialog::ParametersOperations::onCmdSaveParameters(), MSMeanData::openInterval(), MSMeanData_Amitran::openInterval(), RONet::openOutput(), GUIVisualizationTextSettings::print(), GUIVisualizationRainbowSettings::print(), GUIVisualizationSizeSettings::print(), MSStageDriving::routeOutput(), MSStageTranship::routeOutput(), MSStageTrip::routeOutput(), MSStageWaiting::routeOutput(), MSStageWalking::routeOutput(), MSTransportable::routeOutput(), RODFDetectorCon::save(), GUIVisualizationSettings::save(), GUIPropertyScheme< T >::save(), RODFRouteCont::save(), RODFDetectorCon::saveAsPOIs(), ROPerson::PersonTrip::saveAsXML(), ROPerson::Ride::saveAsXML(), ROPerson::Walk::saveAsXML(), ROVehicle::saveAsXML(), GUIDialog_ViewSettings::saveDecals(), MSStateHandler::saveRNGs(), MSLane::saveRNGStates(), MSStateHandler::saveState(), MEVehicle::saveState(), MSBaseVehicle::saveState(), MSEdgeControl::saveState(), MSInsertionControl::saveState(), MSLane::saveState(), MSVehicle::saveState(), MSVehicleControl::saveState(), MSVehicleTransfer::saveState(), MSRailSignalConstraint::saveState(), MSRailSignalConstraint_Predecessor::PassedTracker::saveState(), MSTransportable::saveState(), MSTransportableControl::saveState(), MESegment::saveState(), MSDevice_Routing::saveState(), MSDevice_Transportable::saveState(), MSDevice_Tripinfo::saveState(), MSDevice_Vehroutes::saveState(), MSTransportableDevice_Routing::saveState(), MSAbstractLaneChangeModel::saveState(), MSDevice_Battery::saveState(), MSDevice_StationFinder::saveState(), MSSimpleTrafficLightLogic::saveState(), GNEViewNet::saveVisualizationSettings(), MSStopOut::stopEnded(), MSTransportable::tripInfoOutput(), MSPerson::MSPersonStage_Access::tripInfoOutput(), MSStageDriving::tripInfoOutput(), MSStageTranship::tripInfoOutput(), MSStageWaiting::tripInfoOutput(), MSStageWalking::tripInfoOutput(), MSInstantInductLoop::write(), MSStop::write(), SUMOVTypeParameter::write(), SUMOVehicleParameter::Stop::write(), SUMOVehicleParameter::write(), MSMeanData_Amitran::MSLaneMeanDataValues::write(), NBPTLine::write(), NBPTStop::write(), NBParking::write(), MSElecHybridExport::write(), MSQueueExport::write(), MSFCDExport::write(), MSBatteryExport::write(), MSEmissionExport::write(), MSRailSignalConstraint_Predecessor::write(), ODMatrix::write(), GNEAccess::writeAdditional(), GNEBusStop::writeAdditional(), GNECalibrator::writeAdditional(), GNECalibratorFlow::writeAdditional(), GNEChargingStation::writeAdditional(), GNEClosingLaneReroute::writeAdditional(), GNEClosingReroute::writeAdditional(), GNEContainerStop::writeAdditional(), GNEDestProbReroute::writeAdditional(), GNEEntryExitDetector::writeAdditional(), GNEInductionLoopDetector::writeAdditional(), GNEInstantInductionLoopDetector::writeAdditional(), GNELaneAreaDetector::writeAdditional(), GNEMultiEntryExitDetector::writeAdditional(), GNEOverheadWire::writeAdditional(), GNEParkingArea::writeAdditional(), GNEParkingAreaReroute::writeAdditional(), GNEParkingSpace::writeAdditional(), GNERerouter::writeAdditional(), GNERerouterInterval::writeAdditional(), GNERouteProbe::writeAdditional(), GNERouteProbReroute::writeAdditional(), GNETAZ::writeAdditional(), GNETAZSourceSink::writeAdditional(), GNETractionSubstation::writeAdditional(), GNEVaporizer::writeAdditional(), GNEVariableSpeedSign::writeAdditional(), GNEVariableSpeedSignStep::writeAdditional(), MSMeanData::writeAggregated(), MSElecHybridExport::writeAggregated(), MSChargingStation::writeAggregatedChargingStationOutput(), MSLink::writeApproaching(), NBSign::writeAsPOI(), MSDriveWay::writeBlocks(), MSRailSignal::writeBlocks(), MSDriveWay::writeBlockVehicles(), MSChargingStation::writeChargingStationOutput(), MSNet::writeCollisions(), NWWriter_SUMO::writeConnection(), Command_SaveTLSProgram::writeCurrent(), GNEDataSet::writeDataSet(), ODMatrix::writeDefaultAttrs(), GNEPersonTrip::writeDemandElement(), GNERide::writeDemandElement(), GNERoute::writeDemandElement(), GNERouteDistribution::writeDemandElement(), GNEStop::writeDemandElement(), GNEStopPlan::writeDemandElement(), GNETranship::writeDemandElement(), GNETransport::writeDemandElement(), GNEVehicle::writeDemandElement(), GNEVTypeDistribution::writeDemandElement(), GNEWalk::writeDemandElement(), MSDriveWay::writeDepatureBlocks(), GNEDetector::writeDetectorValues(), NWWriter_SUMO::writeDistrict(), MSMeanData::writeEdge(), NWWriter_SUMO::writeEdge(), MSFullExport::writeEdge(), NWWriter_XML::writeEdgesAndConnections(), NBTypeCont::writeEdgeTypes(), RODFDetector::writeEmitterDefinition(), RODFDetectorCon::writeEmitterPOIs(), RODFDetectorCon::writeEmitters(), RODFDetectorCon::writeEndRerouterDetectors(), GNEDemandElementFlow::writeFlowAttributes(), ODMatrix::writeFlows(), GNEEdgeData::writeGenericData(), GNEEdgeRelData::writeGenericData(), GNETAZRelData::writeGenericData(), NWWriter_OpenDrive::writeGeomLines(), NWWriter_OpenDrive::writeGeomPP3(), RONet::writeIntermodal(), NWWriter_SUMO::writeInternalConnection(), NWWriter_OpenDrive::writeInternalEdge(), NWWriter_SUMO::writeInternalEdges(), NWWriter_SUMO::writeInternalNodes(), ROMAAssignments::writeInterval(), NWWriter_XML::writeJoinedJunctions(), NWWriter_SUMO::writeJunction(), NWWriter_SUMO::writeLane(), MSFullExport::writeLane(), MSQueueExport::writeLane(), MSXMLRawOut::writeLane(), GeoConvHelper::writeLocation(), GNEDemandElementPlan::writeLocationAttributes(), NBRequest::writeLogic(), GNEMeanData::writeMeanData(), NWWriter_OpenDrive::writeNetwork(), NWWriter_SUMO::writeNetwork(), IntermodalRouter< E, L, N, V >::writeNetwork(), NWWriter_XML::writeNodes(), writeNonEmptyAttr(), NWWriter_OpenDrive::writeNormalEdge(), GNEDemandElementPlan::writeOriginStop(), MSDevice_SSM::writeOutConflict(), MSDevice_ToC::writeOutput(), MSNet::writeOutput(), MSDevice_Vehroutes::writeOutput(), MSDevice_BTreceiver::BTreceiverUpdate::writeOutput(), MSOverheadWire::writeOverheadWireSegmentOutput(), Parameterised::writeParams(), writePermissions(), NWFrame::writePositionLong(), writePreferences(), MSMeanData::writePrefix(), MSMeanData_Amitran::writePrefix(), NWWriter_SUMO::writeProhibitions(), MSDevice_Tripinfo::writeRideStatistics(), NWWriter_OpenDrive::writeRoadObjectPOI(), NWWriter_OpenDrive::writeRoadObjectPoly(), NWWriter_SUMO::writeRoundabout(), NWWriter_XML::writeShape(), NWWriter_OpenDrive::writeSignals(), RODFDetector::writeSingleSpeedTrigger(), RODFDetectorCon::writeSpeedTrigger(), MSNet::writeStatistics(), MSDevice_Tripinfo::writeStatistics(), NWWriter_SUMO::writeStopOffsets(), MSNet::writeSummaryOutput(), MSFullExport::writeTLS(), MSTractionSubstation::writeTractionSubstationOutput(), NWWriter_SUMO::writeTrafficLight(), MSFCDExport::writeTransportable(), MSXMLRawOut::writeTransportable(), RODFDetectorCon::writeValidationDetectors(), MSXMLRawOut::writeVehicle(), MSAmitranTrajectories::writeVehicle(), MSChargingStation::writeVehicle(), MSOverheadWire::writeVehicle(), MSFullExport::writeVehicles(), IntermodalRouter< E, L, N, V >::writeWeights(), GUIDialog_EditViewport::writeXML(), SUMOPolygon::writeXML(), PointOfInterest::writeXML(), RORouteDef::writeXMLDefinition(), RORoute::writeXMLDefinition(), TrajectoriesHandler::writeXMLEmissions(), MEInductLoop::writeXMLOutput(), MSInductLoop::writeXMLOutput(), MSCalibrator::writeXMLOutput(), and MSDevice_Vehroutes::writeXMLRoute().

writeHeader()

template<typename E >

bool OutputDevice::writeHeader ( const SumoXMLTag &  rootElement )

inline

Definition at line 199 of file OutputDevice.h.

References getOStream(), myFormatter, and writeHeader().

Referenced by RONet::openOutput(), MSStateHandler::saveState(), and writeHeader().

Here is the caller graph for this function:

writeNonEmptyAttr()

OutputDevice & OutputDevice::writeNonEmptyAttr ( const SumoXMLAttr  attr, const std::string &  val  )

inline

writes a string attribute only if it is not the empty string and not the string "default"

Parameters

[in]	attr	The attribute (name)
[in]	val	The attribute value

Returns

The OutputDevice for further processing

Definition at line 306 of file OutputDevice.h.

References writeAttr().

Referenced by SUMOVehicleParameter::write(), and RODFDetector::writeEmitterDefinition().

Here is the caller graph for this function:

writeOptionalAttr() [1/2]

template<typename T >

OutputDevice & OutputDevice::writeOptionalAttr ( const SumoXMLAttr  attr, const T &  val, long long int  attributeMask  )

inline

writes a named attribute unless filtered

Parameters

[in]	attr	The attribute (name)
[in]	val	The attribute value
[in]	attributeMask	The filter that specifies whether the attribute shall be written

Returns

The OutputDevice for further processing

Definition at line 271 of file OutputDevice.h.

References getOStream(), useAttribute(), and PlainXMLFormatter::writeAttr().

Referenced by MSMeanData_Amitran::MSLaneMeanDataValues::write(), MSMeanData_Emissions::MSLaneMeanDataValues::write(), MSMeanData_Harmonoise::MSLaneMeanDataValues::write(), MSMeanData_Net::MSLaneMeanDataValues::write(), MSFCDExport::write(), MSEmissionExport::write(), MSMeanData::writePrefix(), and MSFCDExport::writeTransportable().

Here is the caller graph for this function:

writeOptionalAttr() [2/2]

template<typename T >

OutputDevice & OutputDevice::writeOptionalAttr ( const SumoXMLAttr  attr, const T &  val, SumoXMLAttrMask  attributeMask  )

inline

Definition at line 279 of file OutputDevice.h.

References getOStream(), useAttribute(), and PlainXMLFormatter::writeAttr().

writePadding()

OutputDevice & OutputDevice::writePadding ( const std::string &  val )

inline

writes padding (ignored for binary output)

Definition at line 325 of file OutputDevice.h.

References getOStream(), myFormatter, and OutputFormatter::writePadding().

Referenced by Command_SaveTLSProgram::writeCurrent(), NBRequest::writeLogic(), and NWWriter_SUMO::writeTrafficLight().

Here is the caller graph for this function:

writePreformattedTag()

OutputDevice & OutputDevice::writePreformattedTag ( const std::string &  val )

inline

writes a preformatted tag to the device but ensures that any pending tags are closed

Parameters

[in]

val

The preformatted data

Returns

The OutputDevice for further processing

Definition at line 319 of file OutputDevice.h.

References getOStream(), myFormatter, and OutputFormatter::writePreformattedTag().

Referenced by computeRoutes(), RONet::saveAndRemoveRoutesUntil(), and NWWriter_OpenDrive::writeNetwork().

Here is the caller graph for this function:

writeXMLHeader()

bool OutputDevice::writeXMLHeader	(	const std::string &	rootElement,
		const std::string &	schemaFile,
		std::map< SumoXMLAttr, std::string >	attrs = std::map<SumoXMLAttr, std::string>(),
		bool	includeConfig = true
	)

Writes an XML header with optional configuration.

If something has been written (myXMLStack is not empty), nothing is written and false returned.

Parameters

[in]	rootElement	The root element to use
[in]	schemaFile	The basename of the schema file to use
[in]	attrs	Additional attributes to save within the rootElement

Returns

Whether the header could be written (stack was empty)

Todo:

Describe what is saved

Definition at line 254 of file OutputDevice.cpp.

References getOStream(), myFormatter, SUMO_ATTR_SCHEMA_LOCATION, SUMO_ATTR_XMLNS, and OutputFormatter::writeXMLHeader().

Referenced by Command_SaveTLSProgram::Command_SaveTLSProgram(), Command_SaveTLSSwitches::Command_SaveTLSSwitches(), Command_SaveTLSSwitchStates::Command_SaveTLSSwitchStates(), createDeviceByOption(), MSDispatch_RouteExtension::dispatch(), Command_SaveTLSState::execute(), NBRailwayTopologyAnalyzer::getBrokenRailNodes(), MSDevice_SSM::MSDevice_SSM(), MSDevice_ToC::MSDevice_ToC(), MSVTypeProbe::MSVTypeProbe(), GNEMultipleParametersDialog::ParametersOperations::onCmdSaveParameters(), GNESingleParametersDialog::ParametersOperations::onCmdSaveParameters(), GNEVTypeDistributionsDialog::ParametersOperations::onCmdSaveParameters(), GNETLSEditorFrame::TLSFile::onCmdSaveTLSProgram(), RODFDetectorCon::save(), PCPolyContainer::save(), GNENet::saveAdditionalsConfirmed(), RODFDetectorCon::saveAsPOIs(), GNENet::saveDataElementsConfirmed(), GNENet::saveDemandElementsConfirmed(), GNENet::saveJuPedSimElements(), GNENet::saveMeanDatasConfirmed(), RODFDetectorCon::saveRoutes(), NWWriter_XML::writeDistricts(), NWWriter_XML::writeEdgesAndConnections(), RODFDetector::writeEmitterDefinition(), RODFDetectorCon::writeEmitterPOIs(), RODFDetectorCon::writeEmitters(), RODFDetectorCon::writeEndRerouterDetectors(), NWWriter_XML::writeJoinedJunctions(), NWWriter_SUMO::writeNetwork(), NWWriter_XML::writeNodes(), MSNet::writeOutput(), NWWriter_XML::writeParkingAreas(), NWWriter_XML::writePTLines(), NWWriter_XML::writePTStops(), NIImporter_OpenDrive::writeRoadObjects(), RODFDetector::writeSingleSpeedTrigger(), RODFDetectorCon::writeSpeedTrigger(), NWWriter_XML::writeStreetSigns(), NWWriter_XML::writeTrafficLights(), NWWriter_XML::writeTypes(), RODFDetectorCon::writeValidationDetectors(), MEInductLoop::writeXMLDetectorProlog(), MSE2Collector::writeXMLDetectorProlog(), MSE3Collector::writeXMLDetectorProlog(), MSInductLoop::writeXMLDetectorProlog(), MSInstantInductLoop::writeXMLDetectorProlog(), MSMeanData::writeXMLDetectorProlog(), MSMeanData_Amitran::writeXMLDetectorProlog(), MSCalibrator::writeXMLDetectorProlog(), and MSRouteProbe::writeXMLDetectorProlog().

wroteHeader()

bool OutputDevice::wroteHeader ( ) const

inline

Definition at line 353 of file OutputDevice.h.

References myFormatter, and OutputFormatter::wroteHeader().

Referenced by Command_SaveTLSState::execute().

Here is the caller graph for this function:

Field Documentation

myFilename

const std::string OutputDevice::myFilename

protected

Definition at line 377 of file OutputDevice.h.

Referenced by getFilename().

myFormatter

OutputFormatter* const OutputDevice::myFormatter

private

The formatter for XML.

Definition at line 381 of file OutputDevice.h.

Referenced by closeTag(), openTag(), openTag(), writeHeader(), writePadding(), writePreformattedTag(), writeXMLHeader(), wroteHeader(), and ~OutputDevice().

myOutputDevices

std::map< std::string, OutputDevice * > OutputDevice::myOutputDevices

staticprivate

map from names to output devices

Definition at line 371 of file OutputDevice.h.

Referenced by close(), closeAll(), flushAll(), getDevice(), and getDeviceByOption().

myPrevConsoleCP

int OutputDevice::myPrevConsoleCP = -1

staticprivate

old console code page to restore after ending

Definition at line 374 of file OutputDevice.h.

Referenced by closeAll(), and getDevice().

---

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

• OutputDevice.h
• OutputDevice.cpp