OutputDevice_String Class Reference

#include <OutputDevice_String.h>

Inheritance diagram for OutputDevice_String:

---

Detailed Description

An output device that encapsulates an ofstream.

Please note that the device gots responsible for the stream and deletes it (it should not be deleted elsewhere).

Definition at line 46 of file OutputDevice_String.h.

OutputDevice member methods
void	close () throw ()
	Closes the device and removes it from the dictionary.
bool	closeTag (bool abbreviated=false) throw ()
	Closes the most recently opened tag.
OutputDevice &	indent () throw ()
	Adds indentation.
void	inform (const std::string &msg)
	Retrieves a message to this device.
virtual bool	ok () throw ()
	returns the information whether one can write into the device
OutputDevice &	openTag (const std::string &xmlElement) throw ()
	Opens an XML tag.
template<class T>
OutputDevice &	operator<< (const T &t)
	Abstract output operator.
void	setPrecision (unsigned int precision=OUTPUT_ACCURACY) throw ()
	Sets the precison or resets it to default.
bool	writeXMLHeader (const std::string &rootElement, const bool writeConfig=true, const std::string &attrs="", const std::string &comment="") throw ()
	Writes an XML header with optional configuration.
virtual void	postWriteHook () throw ()
	Called after every write access.
Public Member Functions
std::string	getString () throw ()
	Returns the current content as a string.
	OutputDevice_String () throw (IOError)
	Constructor Exceptions: IOError  Should not be thrown by this implementation.
	~OutputDevice_String () throw ()
	Destructor.
Static Public Member Functions
static access methods to OutputDevices
static void	closeAll () throw ()
static bool	createDeviceByOption (const std::string &optionName, const std::string &rootElement="") throw (IOError)
	Creates the device using the output definition stored in the named option.
static OutputDevice &	getDevice (const std::string &name, const std::string &base="") throw (IOError)
	Returns the described OutputDevice.
static OutputDevice &	getDeviceByOption (const std::string &name) throw (IOError, InvalidArgument)
	Returns the device described by the option.
Protected Member Functions
Methods that override/implement OutputDevice-methods
std::ostream &	getOStream () throw ()
	Returns the associated ostream.
Private Attributes
std::ostringstream	myStream
	The wrapped ofstream.

---

Constructor & Destructor Documentation

OutputDevice_String::OutputDevice_String

(

)

throw (IOError)

Constructor

Exceptions:

IOError

Should not be thrown by this implementation.

Definition at line 42 of file OutputDevice_String.cpp.

                                                        {
}

OutputDevice_String::~OutputDevice_String

(

)

throw ()

Destructor.

Definition at line 46 of file OutputDevice_String.cpp.

                                                  {
}

---

Member Function Documentation

void OutputDevice::close

(

)

throw () [inherited]

Closes the device and removes it from the dictionary.

Definition at line 133 of file OutputDevice.cpp.

References OutputDevice::closeTag(), and OutputDevice::myOutputDevices.

Referenced by RONet::closeOutput(), GUIDialog_ViewSettings::onCmdExportSetting(), GUIParameterTracker::onCmdSave(), GUIDialog_Breakpoints::onCmdSave(), RODFDetectorCon::save(), PCPolyContainer::save(), GUISelectedStorage::save(), GUISelectedStorage::SingleTypeSelections::save(), RODFDetectorCon::saveAsPOIs(), GUIDialog_ViewSettings::saveDecals(), NBNodeCont::savePlain(), NBEdgeCont::savePlain(), RODFDetectorCon::saveRoutes(), RODFDetector::writeEmitterDefinition(), RODFDetectorCon::writeEmitterPOIs(), RODFDetectorCon::writeEmitters(), RODFDetectorCon::writeEndRerouterDetectors(), RODFDetector::writeSingleSpeedTrigger(), RODFDetectorCon::writeSpeedTrigger(), and RODFDetectorCon::writeValidationDetectors().

                            {
    while (closeTag());
    for (DeviceMap::iterator i=myOutputDevices.begin(); i!=myOutputDevices.end(); ++i) {
        if (i->second == this) {
            myOutputDevices.erase(i);
            break;
        }
    }
    delete this;
}

void OutputDevice::closeAll

(

)

throw () [static, inherited]

Closes all registered devices

Definition at line 115 of file OutputDevice.cpp.

References OutputDevice::myOutputDevices.

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

                               {
    while (myOutputDevices.size()!=0) {
        myOutputDevices.begin()->second->close();
    }
    myOutputDevices.clear();
}

bool OutputDevice::closeTag

(

bool

abbreviated = false

)

throw () [inherited]

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]

name

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

References OutputDevice::getOStream(), OutputDevice::indent(), OutputDevice::myXMLStack, and OutputDevice::postWriteHook().

Referenced by OutputDevice::close(), MSPersonControl::erase(), ROVehicle::saveAllAsXML(), MSVehicleControl::scheduleVehicleRemoval(), RORouteDef_Complete::writeXMLDefinition(), RORouteDef_Alternatives::writeXMLDefinition(), and RORoute::writeXMLDefinition().

                                               {
    if (!myXMLStack.empty()) {
        if (abbreviated) {
            getOStream() << "/>" << std::endl;
        } else {
            std::string indent(4*(myXMLStack.size()-1), ' ');
            getOStream() << indent << "</" << myXMLStack.back() << ">" << std::endl;
        }
        myXMLStack.pop_back();
        postWriteHook();
        return true;
    }
    return false;
}

bool OutputDevice::createDeviceByOption	(	const std::string &	optionName,
		const std::string &	rootElement = ""
	)			throw (IOError) [static, inherited]

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)

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

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

Referenced by MSFrame::buildStreams(), NBNetBuilder::compute(), NBNodeCont::computeNodeShapes(), and main().

                                                                                {
    if (!OptionsCont::getOptions().isSet(optionName)) {
        return false;
    }
    OutputDevice& dev = OutputDevice::getDevice(OptionsCont::getOptions().getString(optionName));
    if (rootElement != "") {
        dev.writeXMLHeader(rootElement);
    }
    return true;
}

OutputDevice & OutputDevice::getDevice	(	const std::string &	name,
		const std::string &	base = ""
	)			throw (IOError) [static, inherited]

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]	name	The description of the output name/port/whatever
[in]	base	The base path the application is run within

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 TplConvert< E >::_2int(), FileHelpers::checkForRelativity(), OutputDevice::getOStream(), FileHelpers::isSocket(), and OutputDevice::setPrecision().

Referenced by NLHandler::addE1Detector(), NLHandler::addE2Detector(), NLHandler::addEdgeLaneMeanData(), NLHandler::addRouteProbeDetector(), NLHandler::addVTypeProbeDetector(), NLHandler::beginE3Detector(), NBNetBuilder::buildLoaded(), NLDiscreteEventBuilder::buildSaveTLStateCommand(), NLDiscreteEventBuilder::buildSaveTLSwitchesCommand(), NLDiscreteEventBuilder::buildSaveTLSwitchStatesCommand(), OutputDevice::createDeviceByOption(), OutputDevice::getDeviceByOption(), MsgHandler::initOutputOptions(), GUIDialog_ViewSettings::onCmdExportSetting(), GUIParameterTracker::onCmdSave(), GUIDialog_EditViewport::onCmdSave(), GUIDialog_Breakpoints::onCmdSave(), RONet::openOutput(), RODFDetectorCon::save(), PCPolyContainer::save(), GUISelectedStorage::save(), GUISelectedStorage::SingleTypeSelections::save(), RODFDetectorCon::saveAsPOIs(), GUIDialog_ViewSettings::saveDecals(), NBNodeCont::savePlain(), NBEdgeCont::savePlain(), RODFDetectorCon::saveRoutes(), RODFDetector::writeEmitterDefinition(), RODFDetectorCon::writeEmitterPOIs(), RODFDetectorCon::writeEmitters(), RODFDetectorCon::writeEndRerouterDetectors(), RODFDetector::writeSingleSpeedTrigger(), RODFDetectorCon::writeSpeedTrigger(), and RODFDetectorCon::writeValidationDetectors().

                                                              {
    // check whether the device has already been aqcuired
    if (myOutputDevices.find(name)!=myOutputDevices.end()) {
        return *myOutputDevices[name];
    }
    // build the device
    OutputDevice *dev = 0;
    // check whether the device shall print to stdout
    if (name=="stdout" || name=="-") {
        dev = new OutputDevice_COUT();
    } else if (FileHelpers::isSocket(name)) {
        try {
            int port = TplConvert<char>::_2int(name.substr(name.find(":")+1).c_str());
            dev = new OutputDevice_Network(name.substr(0, name.find(":")), port);
        } catch (NumberFormatException &) {
            throw IOError("Given port number '" + name.substr(name.find(":")+1) + "' is not numeric.");
        } catch (EmptyData &) {
            throw IOError("No port number given.");
        }
    } else {
        dev = new OutputDevice_File(FileHelpers::checkForRelativity(name, base));
    }
    dev->setPrecision();
    dev->getOStream() << std::setiosflags(std::ios::fixed);
    myOutputDevices[name] = dev;
    return *dev;
}

OutputDevice & OutputDevice::getDeviceByOption

(

const std::string &

name

)

throw (IOError, InvalidArgument) [static, inherited]

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

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

Referenced by NBNodeShapeComputer::compute(), NBNodeShapeComputer::computeNodeShapeByCrosses(), MSPersonControl::erase(), main(), MSVehicleControl::scheduleVehicleRemoval(), NBNode::sortNodesEdges(), and MSNet::writeOutput().

                                                                                           {
    std::string devName = OptionsCont::getOptions().getString(optionName);
    if (myOutputDevices.find(devName)==myOutputDevices.end()) {
        throw InvalidArgument("Device '" + devName + "' has not been created.");
    }
    return OutputDevice::getDevice(devName);
}

std::ostream & OutputDevice_String::getOStream

(

)

throw () [protected, virtual]

Returns the associated ostream.

Returns:

The used stream

Implements OutputDevice.

Definition at line 57 of file OutputDevice_String.cpp.

References myStream.

                                        {
    return myStream;
}

std::string OutputDevice_String::getString

(

)

throw ()

Returns the current content as a string.

Returns:

The content as string

Definition at line 51 of file OutputDevice_String.cpp.

References myStream.

Referenced by GUICompleteSchemeStorage::writeSettings().

                                       {
    return myStream.str();
}

OutputDevice & OutputDevice::indent

(

)

throw () [inherited]

Adds indentation.

An intendation, depending on the current xml-element-stack size, is written.

Returns:

The OutputDevice for further processing

Definition at line 171 of file OutputDevice.cpp.

References OutputDevice::getOStream(), OutputDevice::myXMLStack, and OutputDevice::postWriteHook().

Referenced by OutputDevice::closeTag().

                             {
    getOStream() << std::string(4*myXMLStack.size(), ' ');
    postWriteHook();
    return *this;
}

void OutputDevice::inform

(

const std::string &

msg

)

[inherited]

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

References OutputDevice::getOStream(), and OutputDevice::postWriteHook().

                                         {
    getOStream() << msg << '\n';
    postWriteHook();
}

bool OutputDevice::ok

(

)

throw () [virtual, inherited]

returns the information whether one can write into the device

Returns:

Whether the device can be used (stream is good)

Definition at line 128 of file OutputDevice.cpp.

References OutputDevice::getOStream().

                         {
    return getOStream().good();
}

OutputDevice & OutputDevice::openTag

(

const std::string &

xmlElement

)

throw () [inherited]

Opens an XML tag.

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

Parameters:

[in]

xmlElement

Name of element to open

Returns:

The OutputDevice for further processing

Definition at line 179 of file OutputDevice.cpp.

References OutputDevice::getOStream(), OutputDevice::myXMLStack, and OutputDevice::postWriteHook().

Referenced by MSPersonControl::erase(), MSVehicleControl::scheduleVehicleRemoval(), RORouteDef_Complete::writeXMLDefinition(), RORouteDef_Alternatives::writeXMLDefinition(), RORoute::writeXMLDefinition(), OutputDevice::writeXMLHeader(), and MSVehicle::writeXMLRoute().

                                                         {
    getOStream() << std::string(4*myXMLStack.size(), ' ') << "<" << xmlElement;
    postWriteHook();
    myXMLStack.push_back(xmlElement);
    return *this;
}

template<class T>

OutputDevice& OutputDevice::operator<<

(

const T &

t

)

[inline, inherited]

Abstract output operator.

Returns:

The OutputDevice for further processing

Definition at line 222 of file OutputDevice.h.

References OutputDevice::getOStream(), and OutputDevice::postWriteHook().

                                         {
        getOStream() << t;
        postWriteHook();
        return *this;
    }

void OutputDevice::postWriteHook

(

)

throw () [protected, virtual, inherited]

Called after every write access.

Default implementation does nothing.

Reimplemented in MsgRetrievingFunction< T >, and OutputDevice_Network.

Definition at line 205 of file OutputDevice.cpp.

Referenced by OutputDevice::closeTag(), OutputDevice::indent(), OutputDevice::inform(), OutputDevice::openTag(), and OutputDevice::operator<<().

{}

void OutputDevice::setPrecision

(

unsigned int

precision = OUTPUT_ACCURACY

)

throw () [inherited]

Sets the precison or resets it to default.

Parameters:

[in]

precision

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

Definition at line 146 of file OutputDevice.cpp.

References OutputDevice::getOStream().

Referenced by MSVTypeProbe::execute(), OutputDevice::getDevice(), NBNodeCont::savePlain(), RORouteDef_Alternatives::writeXMLDefinition(), and RORoute::writeXMLDefinition().

                                                         {
    getOStream() << std::setprecision(precision);
}

bool OutputDevice::writeXMLHeader	(	const std::string &	rootElement,
		const bool	writeConfig = true,
		const std::string &	attrs = "",
		const std::string &	comment = ""
	)			throw () [inherited]

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]	writeConfig	Whether the configuration used while this file was generated shall be saved
[in]	attrs	Additional attributes to save within the rootElement
[in]	comment	Additional comment (saved in front the rootElement)

Todo:

Check which parameter is used herein

Todo:

Describe what is saved

Definition at line 152 of file OutputDevice.cpp.

References OptionsCont::getOptions(), OutputDevice::getOStream(), OutputDevice::myXMLStack, OutputDevice::openTag(), and OptionsCont::writeXMLHeader().

Referenced by OutputDevice::createDeviceByOption(), RONet::openOutput(), RODFDetectorCon::save(), PCPolyContainer::save(), RODFDetectorCon::saveAsPOIs(), NBNodeCont::savePlain(), NBEdgeCont::savePlain(), RODFDetectorCon::saveRoutes(), RODFDetector::writeEmitterDefinition(), RODFDetectorCon::writeEmitterPOIs(), RODFDetectorCon::writeEmitters(), RODFDetectorCon::writeEndRerouterDetectors(), RODFDetector::writeSingleSpeedTrigger(), RODFDetectorCon::writeSpeedTrigger(), and RODFDetectorCon::writeValidationDetectors().

                                                                                       {
    if (myXMLStack.empty()) {
        OptionsCont::getOptions().writeXMLHeader(getOStream(), writeConfig);
        if (comment != "") {
            getOStream() << comment << "\n";
        }
        openTag(rootElement);
        if (attrs != "") {
            getOStream() << " " << attrs;
        }
        getOStream() << ">\n";
        return true;
    }
    return false;
}

---

Field Documentation

std::ostringstream OutputDevice_String::myStream [private]

The wrapped ofstream.

Definition at line 76 of file OutputDevice_String.h.

Referenced by getOStream(), and getString().

---

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

• OutputDevice_String.h
• OutputDevice_String.cpp