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

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

#include <OutputDevice.h>

Inheritance diagram for OutputDevice:
MsgRetrievingFunction< T > OutputDevice_CERR OutputDevice_COUT OutputDevice_File OutputDevice_Network OutputDevice_String

Static Public Member Functions

static std::string realString (const SUMOReal v, const int precision=OUTPUT_ACCURACY)
 Helper method for string formatting.
static access methods to OutputDevices
static OutputDevicegetDevice (const std::string &name, const std::string &base="")
 Returns the described OutputDevice.
static bool createDeviceByOption (const std::string &optionName, const std::string &rootElement="")
 Creates the device using the output definition stored in the named option.
static OutputDevicegetDeviceByOption (const std::string &name) throw (IOError, InvalidArgument)
 Returns the device described by the option.
static void closeAll ()

OutputDevice member methods

static std::map< std::string,
OutputDevice * > 
myOutputDevices
 map from names to output devices
OutputFormattermyFormatter
 The formatter for XML.
const bool myAmBinary
 OutputDevice (const bool binary=false, const unsigned int defaultIndentation=0)
 Constructor.
virtual ~OutputDevice ()
 Destructor.
virtual bool ok ()
 returns the information whether one can write into the device
void close ()
 Closes the device and removes it from the dictionary.
void setPrecision (unsigned int precision=OUTPUT_ACCURACY)
 Sets the precison or resets it to default.
bool writeXMLHeader (const std::string &rootElement, const std::string xmlParams="", const std::string &attrs="", const std::string &comment="")
 Writes an XML header with optional configuration.
OutputDeviceopenTag (const std::string &xmlElement)
 Opens an XML tag.
OutputDeviceopenTag (const SumoXMLTag &xmlElement)
 Opens an XML tag.
void closeOpener ()
 Ends the most recently opened element start.
bool closeTag (bool abbreviated=false)
 Closes the most recently opened tag.
OutputDevicewriteAttr (std::string attr, std::string val)
 writes an arbitrary attribute
void lf ()
 writes a line feed if applicable
bool isBinary () const
 Returns whether we have a binary output.
template<typename T >
OutputDevicewriteAttr (const SumoXMLAttr attr, const T &val)
 writes a named attribute
void inform (const std::string &msg, const char progress=0)
 Retrieves a message to this device.
template<class T >
OutputDeviceoperator<< (const T &t)
 Abstract output operator.
virtual std::ostream & getOStream ()=0
 Returns the associated ostream.
virtual void postWriteHook ()
 Called after every write access.
 OutputDevice (const OutputDevice &)
 Invalidated copy constructor.
OutputDeviceoperator= (const OutputDevice &)
 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 70 of file OutputDevice.h.


Constructor & Destructor Documentation

OutputDevice::OutputDevice ( const bool  binary = false,
const unsigned int  defaultIndentation = 0 
)

Constructor.

Definition at line 156 of file OutputDevice.cpp.

References myFormatter.

OutputDevice::~OutputDevice ( )
virtual

Destructor.

Definition at line 166 of file OutputDevice.cpp.

References myFormatter.

OutputDevice::OutputDevice ( const OutputDevice )
private

Invalidated copy constructor.


Member Function Documentation

void OutputDevice::closeAll ( )
static

Closes all registered devices

Definition at line 127 of file OutputDevice.cpp.

References myOutputDevices.

Referenced by GUIRunThread::deleteSim(), and main().

bool OutputDevice::closeTag ( bool  abbreviated = false)

Closes the most recently opened tag.

The topmost xml-element from the stack is written into the stream as a closing element ("</" + element + ">") and is then removed from the stack. If abbreviated closing is requested, only "/>" is the output.

Parameters:
[in]namewhether abbreviated closing is performed
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 224 of file OutputDevice.cpp.

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

Referenced by close(), MSPersonControl::erase(), PCPolyContainer::save(), ROVehicle::saveAllAsXML(), MSVehicleControl::scheduleVehicleRemoval(), MSXMLRawOut::write(), SUMOVTypeParameter::write(), MSMeanData_HBEFA::MSLaneMeanDataValues::write(), MSMeanData_Harmonoise::MSLaneMeanDataValues::write(), ODMatrix::write(), MSMeanData_Net::MSLaneMeanDataValues::write(), MSInstantInductLoop::write(), NWWriter_SUMO::writeConnection(), NWWriter_SUMO::writeDistrict(), MSXMLRawOut::writeEdge(), NWWriter_SUMO::writeEdge(), MSMeanData::writeEdge(), NWWriter_XML::writeEdgesAndConnections(), RODFDetector::writeEmitterDefinition(), NWWriter_SUMO::writeInternalConnection(), NWWriter_SUMO::writeInternalEdge(), NWWriter_SUMO::writeInternalNodes(), NWWriter_XML::writeJoinedJunctions(), NWWriter_SUMO::writeJunction(), MSXMLRawOut::writeLane(), NWWriter_SUMO::writeLane(), NBRequest::writeLaneResponse(), NWWriter_SUMO::writeLocation(), NWWriter_XML::writeNodes(), NWWriter_SUMO::writeProhibitions(), NWWriter_SUMO::writeRoundabout(), NWWriter_SUMO::writeTrafficLights(), MSXMLRawOut::writeVehicle(), RORouteDef_Complete::writeXMLDefinition(), RORouteDef_Alternatives::writeXMLDefinition(), RORoute::writeXMLDefinition(), MSRouteProbe::writeXMLOutput(), and MSMeanData::writeXMLOutput().

bool OutputDevice::createDeviceByOption ( const std::string &  optionName,
const std::string &  rootElement = "" 
)
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]optionNameThe name of the option to use for retrieving the output definition
[in]rootElementThe root element to use (XML-output)
Returns:
Whether a device was built (the option was set)
Exceptions:
IOErrorIf the output could not be built for any reason (error message is supplied)

Definition at line 103 of file OutputDevice.cpp.

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

Referenced by MSFrame::buildStreams(), MSDevice_Vehroutes::init(), and main().

OutputDevice & OutputDevice::getDevice ( const std::string &  name,
const std::string &  base = "" 
)
static

Returns the described OutputDevice.

Creates and returns the named device. "stdout" and "-" refer to standard out, "hostname:port" initiates socket connection. Otherwise a filename is assumed and the second parameter may be used to give a base directory. If there already is a device with the same name this one is returned.

Parameters:
[in]nameThe description of the output name/port/whatever
[in]baseThe base path the application is run within
Returns:
The corresponding (built or existing) device
Exceptions:
IOErrorIf the output could not be built for any reason (error message is supplied)

Definition at line 66 of file OutputDevice.cpp.

References FileHelpers::checkForRelativity(), getOStream(), FileHelpers::isSocket(), myOutputDevices, and setPrecision().

Referenced by NLHandler::addE1Detector(), NLHandler::addE2Detector(), NLHandler::addEdgeLaneMeanData(), NLHandler::addInstantE1Detector(), NLHandler::addRouteProbeDetector(), NLHandler::addVTypeProbeDetector(), NLHandler::beginE3Detector(), NLDiscreteEventBuilder::buildSaveTLStateCommand(), NLDiscreteEventBuilder::buildSaveTLSwitchesCommand(), NLDiscreteEventBuilder::buildSaveTLSwitchStatesCommand(), createDeviceByOption(), getDeviceByOption(), MsgHandler::initOutputOptions(), MsgHandler::MsgHandler(), GUIDialog_ViewSettings::onCmdExportSetting(), GUIDialog_Breakpoints::onCmdSave(), GUIDialog_EditViewport::onCmdSave(), GUIParameterTracker::onCmdSave(), RONet::openOutput(), GUILoadThread::run(), PCPolyContainer::save(), RODFDetectorCon::save(), GUISelectedStorage::save(), RODFDetectorCon::saveAsPOIs(), GUIDialog_ViewSettings::saveDecals(), RODFDetectorCon::saveRoutes(), NWWriter_XML::writeEdgesAndConnections(), RODFDetector::writeEmitterDefinition(), RODFDetectorCon::writeEmitterPOIs(), RODFDetectorCon::writeEmitters(), RODFDetectorCon::writeEndRerouterDetectors(), NWWriter_XML::writeJoinedJunctions(), NWWriter_OpenDrive::writeNetwork(), NWFrame::writeNetwork(), NWWriter_MATSim::writeNetwork(), NWWriter_SUMO::writeNetwork(), NWWriter_XML::writeNodes(), RODFDetector::writeSingleSpeedTrigger(), RODFDetectorCon::writeSpeedTrigger(), NWWriter_XML::writeTrafficLights(), and RODFDetectorCon::writeValidationDetectors().

OutputDevice & OutputDevice::getDeviceByOption ( const std::string &  name) throw (IOError, InvalidArgument)
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]nameThe name of the option to use for retrieving the output definition
Returns:
The corresponding (built or existing) device
Exceptions:
IOErrorIf the output could not be built for any reason (error message is supplied)
InvalidArgumentIf the option with the given name does not exist

Definition at line 117 of file OutputDevice.cpp.

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

Referenced by MSPersonControl::erase(), MSDevice_HBEFA::generateOutput(), MSDevice_Vehroutes::generateOutput(), MSDevice_Tripinfo::generateOutput(), main(), MSVehicleControl::scheduleVehicleRemoval(), and MSNet::writeOutput().

virtual std::ostream& OutputDevice::getOStream ( )
protectedpure virtual
void OutputDevice::inform ( const std::string &  msg,
const char  progress = 0 
)

Retrieves a message to this device.

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

Parameters:
[in]msgThe msg to write to the device

Definition at line 238 of file OutputDevice.cpp.

References getOStream(), and postWriteHook().

bool OutputDevice::isBinary ( ) const
inline

Returns whether we have a binary output.

Returns:
whether we have a binary output

Definition at line 250 of file OutputDevice.h.

References myAmBinary.

Referenced by MSDevice_Vehroutes::generateOutput().

void OutputDevice::lf ( )
inline

writes a line feed if applicable

Definition at line 240 of file OutputDevice.h.

References getOStream(), and myAmBinary.

Referenced by NWWriter_SUMO::writeLocation(), NWWriter_SUMO::writeNetwork(), and NWWriter_SUMO::writeTrafficLights().

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 172 of file OutputDevice.cpp.

References getOStream().

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]xmlElementName of element to open
Returns:
The OutputDevice for further processing

Definition at line 204 of file OutputDevice.cpp.

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

Referenced by MSPersonControl::erase(), MSDevice_Vehroutes::generateOutput(), MSDevice_HBEFA::generateOutput(), MSDevice_Tripinfo::generateOutput(), PCPolyContainer::save(), MSPerson::MSPersonStage_Walking::tripInfoOutput(), MSPerson::MSPersonStage_Driving::tripInfoOutput(), MSPerson::MSPersonStage_Waiting::tripInfoOutput(), MSXMLRawOut::write(), SUMOVTypeParameter::write(), ODMatrix::write(), MSInstantInductLoop::write(), SUMOVehicleParameter::writeAs(), NWWriter_SUMO::writeConnection(), NWWriter_SUMO::writeDistrict(), MSXMLRawOut::writeEdge(), NWWriter_SUMO::writeEdge(), MSMeanData::writeEdge(), NWWriter_XML::writeEdgesAndConnections(), RODFDetector::writeEmitterDefinition(), NWWriter_SUMO::writeInternalConnection(), NWWriter_SUMO::writeInternalEdge(), NWWriter_SUMO::writeInternalNodes(), NWWriter_XML::writeJoinedJunctions(), NWWriter_SUMO::writeJunction(), MSXMLRawOut::writeLane(), NWWriter_SUMO::writeLane(), NBRequest::writeLaneResponse(), NWWriter_SUMO::writeLocation(), NWWriter_XML::writeNodes(), MSMeanData::writePrefix(), NWWriter_SUMO::writeProhibitions(), NWWriter_SUMO::writeRoundabout(), NWWriter_SUMO::writeTrafficLights(), MSXMLRawOut::writeVehicle(), RORouteDef_Complete::writeXMLDefinition(), RORouteDef_Alternatives::writeXMLDefinition(), RORoute::writeXMLDefinition(), MSRouteProbe::writeXMLOutput(), MSMeanData::writeXMLOutput(), and MSDevice_Vehroutes::writeXMLRoute().

OutputDevice & OutputDevice::openTag ( const SumoXMLTag xmlElement)

Opens an XML tag.

Helper method which finds the correct string before calling openTag.

Parameters:
[in]xmlElementId of the element to open
Returns:
The OutputDevice for further processing

Definition at line 211 of file OutputDevice.cpp.

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

template<class T >
OutputDevice& OutputDevice::operator<< ( const T &  t)
inline

Abstract output operator.

Returns:
The OutputDevice for further processing

Definition at line 285 of file OutputDevice.h.

References getOStream(), and postWriteHook().

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

Invalidated assignment operator.

void OutputDevice::postWriteHook ( )
protectedvirtual

Called after every write access.

Default implementation does nothing.

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

Definition at line 234 of file OutputDevice.cpp.

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

std::string OutputDevice::realString ( const SUMOReal  v,
const int  precision = OUTPUT_ACCURACY 
)
static

Helper method for string formatting.

Parameters:
[in]vThe floating point value to be formatted
[in]precisionthe precision to achieve
Returns:
The formatted string

Definition at line 136 of file OutputDevice.cpp.

Referenced by MSDevice_HBEFA::generateOutput(), and MSMeanData_HBEFA::MSLaneMeanDataValues::write().

void OutputDevice::setPrecision ( unsigned int  precision = OUTPUT_ACCURACY)

Sets the precison or resets it to default.

Parameters:
[in]precisionThe accuracy (number of digits behind '.') to set

Definition at line 191 of file OutputDevice.cpp.

References getOStream().

Referenced by MSVTypeProbe::execute(), getDevice(), NWWriter_XML::writeEdgesAndConnections(), NWWriter_SUMO::writeLocation(), NWWriter_XML::writeNodes(), RORouteDef_Alternatives::writeXMLDefinition(), and RORoute::writeXMLDefinition().

template<typename T >
OutputDevice& OutputDevice::writeAttr ( const SumoXMLAttr  attr,
const T &  val 
)
inline

writes a named attribute

Parameters:
[in]attrThe attribute (name)
[in]valThe attribute value
Returns:
The OutputDevice for further processing

Definition at line 262 of file OutputDevice.h.

References getOStream(), myAmBinary, and writeAttr().

bool OutputDevice::writeXMLHeader ( const std::string &  rootElement,
const std::string  xmlParams = "",
const std::string &  attrs = "",
const std::string &  comment = "" 
)

Writes an XML header with optional configuration.

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

Parameters:
[in]rootElementThe root element to use
[in]xmlParamsAdditional parameters (such as encoding) to include in the <?xml> declaration
[in]attrsAdditional attributes to save within the rootElement
[in]commentAdditional comment (saved in front the rootElement)
Returns:
Whether the header could be written (stack was empty)
Todo:

Check which parameter is used herein

Describe what is saved

Definition at line 197 of file OutputDevice.cpp.

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

Referenced by Command_SaveTLSState::Command_SaveTLSState(), Command_SaveTLSSwitches::Command_SaveTLSSwitches(), Command_SaveTLSSwitchStates::Command_SaveTLSSwitchStates(), createDeviceByOption(), MSVTypeProbe::MSVTypeProbe(), RONet::openOutput(), PCPolyContainer::save(), RODFDetectorCon::save(), RODFDetectorCon::saveAsPOIs(), RODFDetectorCon::saveRoutes(), NWWriter_XML::writeEdgesAndConnections(), RODFDetector::writeEmitterDefinition(), RODFDetectorCon::writeEmitterPOIs(), RODFDetectorCon::writeEmitters(), RODFDetectorCon::writeEndRerouterDetectors(), NWWriter_XML::writeJoinedJunctions(), NWWriter_SUMO::writeNetwork(), NWWriter_XML::writeNodes(), RODFDetector::writeSingleSpeedTrigger(), RODFDetectorCon::writeSpeedTrigger(), NWWriter_XML::writeTrafficLights(), RODFDetectorCon::writeValidationDetectors(), MSRouteProbe::writeXMLDetectorProlog(), MS_E2_ZS_CollectorOverLanes::writeXMLDetectorProlog(), MSInstantInductLoop::writeXMLDetectorProlog(), MSE2Collector::writeXMLDetectorProlog(), MSInductLoop::writeXMLDetectorProlog(), MSE3Collector::writeXMLDetectorProlog(), and MSMeanData::writeXMLDetectorProlog().


Field Documentation

const bool OutputDevice::myAmBinary
private

Definition at line 312 of file OutputDevice.h.

Referenced by isBinary(), lf(), and writeAttr().

OutputFormatter* OutputDevice::myFormatter
private

The formatter for XML.

Definition at line 310 of file OutputDevice.h.

Referenced by closeOpener(), closeTag(), openTag(), OutputDevice(), writeAttr(), writeXMLHeader(), and ~OutputDevice().

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

map from names to output devices

Definition at line 305 of file OutputDevice.h.

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


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