OutputDevice.h

Go to the documentation of this file.

/****************************************************************************/
// Static storage of an output device and its base (abstract) implementation
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
// Copyright (C) 2001-2012 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This file is part of SUMO.
//   SUMO is free software: you can redistribute it and/or modify
//   it under the terms of the GNU General Public License as published by
//   the Free Software Foundation, either version 3 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef OutputDevice_h
#define OutputDevice_h


// ===========================================================================
// included modules
// ===========================================================================
#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#include <string>
#include <vector>
#include <map>
#include <utils/common/UtilExceptions.h>
#include <utils/common/ToString.h>
#include <utils/xml/SUMOXMLDefinitions.h>


// ===========================================================================
// class definitions
// ===========================================================================
class OutputDevice {
public:

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


    static bool createDeviceByOption(const std::string& optionName,
                                     const std::string& rootElement = "");


    static OutputDevice& getDeviceByOption(const std::string& name) throw(IOError, InvalidArgument);


    static void closeAll() ;


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



public:

    OutputDevice(const unsigned int defaultIndentation = 0);


    virtual ~OutputDevice() { }


    virtual bool ok() ;


    void close() ;


    void setPrecision(unsigned int precision = OUTPUT_ACCURACY) ;


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


    OutputDevice& indent() ;


    OutputDevice& openTag(const std::string& xmlElement) ;


    OutputDevice& openTag(const SumoXMLTag& xmlElement) ;


    bool closeTag(bool abbreviated = false) ;

    OutputDevice& writeAttr(std::string attr, std::string val);


    template <class T>
    OutputDevice& writeAttr(const SumoXMLAttr attr, const T& val) {
        return writeAttr(toString(attr), toString(val, getOStream().precision()));
    }


    void inform(const std::string& msg);


    template <class T>
    OutputDevice& operator<<(const T& t) {
        getOStream() << t;
        postWriteHook();
        return *this;
    }

protected:
    virtual std::ostream& getOStream() = 0;


    virtual void postWriteHook() ;


private:

    typedef std::map<std::string, OutputDevice*> DeviceMap;

    static DeviceMap myOutputDevices;


private:

    std::vector<std::string> myXMLStack;

    unsigned int myDefaultIndentation;

};


#endif

/****************************************************************************/