OutputFormatter.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2012-2026 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// Abstract base class for output formatters
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <vector>
#include <utils/common/StdDefs.h>
#include <utils/common/SUMOTime.h>
#include <utils/xml/SUMOXMLDefinitions.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class Boundary;
class Position;
class PositionVector;
class RGBColor;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
enum class OutputFormatterType {
    XML,
#ifdef HAVE_PARQUET
    PARQUET,
#endif
    CSV
};
 
class OutputFormatter {
public:
    OutputFormatter(OutputFormatterType t) : myType(t) { }
 
    virtual ~OutputFormatter() { }
 
    virtual bool writeXMLHeader(std::ostream& into, const std::string& rootElement,
                                const std::map<SumoXMLAttr, std::string>& attrs, bool writeMetadata,
                                bool includeConfig) {
        UNUSED_PARAMETER(into);
        UNUSED_PARAMETER(rootElement);
        UNUSED_PARAMETER(attrs);
        UNUSED_PARAMETER(writeMetadata);
        UNUSED_PARAMETER(includeConfig);
        return false;
    }
 
    virtual void openTag(std::ostream& into, const std::string& xmlElement) = 0;
 
    virtual void openTag(std::ostream& into, const SumoXMLTag& xmlElement) = 0;
 
    virtual void writeTime(std::ostream& into, const SumoXMLAttr attr, const SUMOTime val) = 0;
 
    virtual bool closeTag(std::ostream& into, const std::string& comment = "") = 0;
 
    virtual void writePreformattedTag(std::ostream& into, const std::string& val) {
        UNUSED_PARAMETER(into);
        UNUSED_PARAMETER(val);
        throw ProcessError("The selected file format does not support preformatted tags.");
    }
 
    virtual void writePadding(std::ostream& into, const std::string& val) {
        UNUSED_PARAMETER(into);
        UNUSED_PARAMETER(val);
    }
 
    virtual bool wroteHeader() const = 0;
 
    OutputFormatterType getType() const {
        return myType;
    }
 
    virtual void setExpectedAttributes(const SumoXMLAttrMask& expected, const int depth) {
        UNUSED_PARAMETER(expected);
        UNUSED_PARAMETER(depth);
    }
 
private:
    const OutputFormatterType myType;
};