CommonXMLStructure.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2025 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
/****************************************************************************/
// Structure for common XML Parsing
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <utils/common/SUMOTime.h>
#include <utils/common/RGBColor.h>
#include <utils/geom/PositionVector.h>
#include <utils/vehicle/SUMOVehicleParameter.h>
#include <utils/vehicle/SUMOVTypeParameter.h>
#include <utils/xml/SUMOSAXHandler.h>
#include <utils/xml/SUMOXMLDefinitions.h>
 
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class CommonXMLStructure {
 
public:
 
    class SumoBaseObject;
 
    class PlanParameters {
 
    public:
        // @brief default constructor
        PlanParameters();
 
        PlanParameters(const CommonXMLStructure::SumoBaseObject* sumoBaseObject,
                       const SUMOSAXAttributes& attrs, bool& parsedOk);
 
        void clear();
 
        bool isSingleEdgePlan() const;
 
        int getNumberOfDefinedParameters() const;
 
        SumoXMLTag getWalkTag() const;
 
        SumoXMLTag getPersonTripTag() const;
 
        SumoXMLTag getRideTag() const;
 
        SumoXMLTag getTransportTag() const;
 
        SumoXMLTag getTranshipTag() const;
 
        SumoXMLTag getPersonStopTag() const;
 
        SumoXMLTag getContainerStopTag() const;
 
        std::string fromEdge;
 
        std::string toEdge;
 
        std::vector<std::string> consecutiveEdges;
 
        std::string fromJunction;
 
        std::string toJunction;
 
        std::string fromTAZ;
 
        std::string toTAZ;
 
        std::string fromBusStop;
 
        std::string toBusStop;
 
        std::string fromTrainStop;
 
        std::string toTrainStop;
 
        std::string fromContainerStop;
 
        std::string toContainerStop;
 
        std::string fromChargingStation;
 
        std::string toChargingStation;
 
        std::string fromParkingArea;
 
        std::string toParkingArea;
 
        std::string fromRoute;
 
        std::string toRoute;
 
    private:
        const CommonXMLStructure::SumoBaseObject* getPreviousPlanObj(const CommonXMLStructure::SumoBaseObject* sumoBaseObject) const;
 
        void updateFromAttributes(const CommonXMLStructure::SumoBaseObject* sumoBaseObject);
 
        void resetPreviousFromAttributes(const CommonXMLStructure::SumoBaseObject* previousPlanObj, const std::string& newType, const std::string& newId) const;
 
        void writeIgnoringMessage(const CommonXMLStructure::SumoBaseObject* previousPlanObj, const std::string& oldType, const std::string& oldId,
                                  const std::string& newType, const std::string& newId) const;
    };
 
    class SumoBaseObject {
 
    public:
        SumoBaseObject(SumoBaseObject* sumoBaseObjectParent);
 
        ~SumoBaseObject();
 
        void clear();
 
        void setTag(const SumoXMLTag tag);
 
        void markAsCreated();
 
 
        SumoXMLTag getTag() const;
 
        bool wasCreated() const;
 
        SumoBaseObject* getParentSumoBaseObject() const;
 
        std::map<std::string, std::string> getAllAttributes() const;
 
        const std::string& getStringAttribute(const SumoXMLAttr attr) const;
 
        int getIntAttribute(const SumoXMLAttr attr) const;
 
        double getDoubleAttribute(const SumoXMLAttr attr) const;
 
        bool getBoolAttribute(const SumoXMLAttr attr) const;
 
        const Position& getPositionAttribute(const SumoXMLAttr attr) const;
 
        SUMOTime getTimeAttribute(const SumoXMLAttr attr) const;
 
        SUMOTime getPeriodAttribute() const;
 
        const RGBColor& getColorAttribute(const SumoXMLAttr attr) const;
 
        const std::vector<std::string>& getStringListAttribute(const SumoXMLAttr attr) const;
 
        const std::vector<double>& getDoubleListAttribute(const SumoXMLAttr attr) const;
 
        const PositionVector& getPositionVectorAttribute(const SumoXMLAttr attr) const;
 
        const std::string& getParentID(const SumoXMLTag tag) const;
 
        SUMOVehicleClass getVClass() const;
 
        const SUMOVTypeParameter& getVehicleTypeParameter() const;
 
        const SUMOVehicleParameter& getVehicleParameter() const;
 
        const SUMOVehicleParameter::Stop& getStopParameter() const;
 
        const std::map<std::string, std::string>& getParameters() const;
 
        const CommonXMLStructure::PlanParameters& getPlanParameters() const;
 
        const std::vector<SumoBaseObject*>& getSumoBaseObjectChildren() const;
 
 
 
        bool hasStringAttribute(const SumoXMLAttr attr) const;
 
        bool hasIntAttribute(const SumoXMLAttr attr) const;
 
        bool hasDoubleAttribute(const SumoXMLAttr attr) const;
 
        bool hasBoolAttribute(const SumoXMLAttr attr) const;
 
        bool hasPositionAttribute(const SumoXMLAttr attr) const;
 
        bool hasTimeAttribute(const SumoXMLAttr attr) const;
 
        bool hasColorAttribute(const SumoXMLAttr attr) const;
 
        bool hasStringListAttribute(const SumoXMLAttr attr) const;
 
        bool hasDoubleListAttribute(const SumoXMLAttr attr) const;
 
        bool hasPositionVectorAttribute(const SumoXMLAttr attr) const;
 
        bool hasParentID(const SumoXMLTag tag) const;
 
 
 
        void addStringAttribute(const SumoXMLAttr attr, const std::string& value);
 
        void addIntAttribute(const SumoXMLAttr attr, const int value);
 
        void addDoubleAttribute(const SumoXMLAttr attr, const double value);
 
        void addBoolAttribute(const SumoXMLAttr attr, const bool value);
 
        void addPositionAttribute(const SumoXMLAttr attr, const Position& value);
 
        void addTimeAttribute(const SumoXMLAttr attr, const SUMOTime value);
 
        void addColorAttribute(const SumoXMLAttr attr, const RGBColor& value);
 
        void addStringListAttribute(const SumoXMLAttr attr, const std::vector<std::string>& value);
 
        void addDoubleListAttribute(const SumoXMLAttr attr, const std::vector<double>& value);
 
        void addPositionVectorAttribute(const SumoXMLAttr attr, const PositionVector& value);
 
        void addParameters(const std::string& value);
 
        void addParameter(const std::string& key, const std::string& value);
 
        void addParentID(const SumoXMLTag tag, const std::string& ID);
 
        void setVClass(SUMOVehicleClass vClass);
 
        void setVehicleTypeParameter(const SUMOVTypeParameter* vehicleTypeParameter);
 
        void setVehicleParameter(const SUMOVehicleParameter* vehicleParameter);
 
        void setStopParameter(const SUMOVehicleParameter::Stop& stopParameter);
 
        void setPlanParameters(const CommonXMLStructure::PlanParameters& planParameters);
 
 
    protected:
        SumoBaseObject* mySumoBaseObjectParent;
 
        SumoXMLTag myTag = SUMO_TAG_NOTHING;
 
        bool myWasCreated = false;
 
        std::map<const SumoXMLAttr, std::string> myStringAttributes;
 
        std::map<const SumoXMLAttr, int> myIntAttributes;
 
        std::map<const SumoXMLAttr, double> myDoubleAttributes;
 
        std::map<const SumoXMLAttr, bool> myBoolAttributes;
 
        std::map<const SumoXMLAttr, Position> myPositionAttributes;
 
        std::map<const SumoXMLAttr, SUMOTime> myTimeAttributes;
 
        std::map<const SumoXMLAttr, RGBColor> myColorAttributes;
 
        std::map<const SumoXMLAttr, std::vector<std::string> > myStringListAttributes;
 
        std::map<const SumoXMLAttr, std::vector<double> > myDoubleListAttributes;
 
        std::map<const SumoXMLAttr, PositionVector> myPositionVectorAttributes;
 
        std::map<std::string, std::string> myParameters;
 
        std::map<const SumoXMLTag, std::string> myParentIDs;
 
        std::vector<SumoBaseObject*> mySumoBaseObjectChildren;
 
        SUMOVehicleClass myVClass = SVC_IGNORING;
 
        SUMOVTypeParameter myVehicleTypeParameter;
 
        SUMOVehicleParameter myVehicleParameter;
 
        SUMOVehicleParameter::Stop myStopParameter;
 
        CommonXMLStructure::PlanParameters myPlanParameters;
 
        void addSumoBaseObjectChild(SumoBaseObject* sumoBaseObject);
 
        void removeSumoBaseObjectChild(SumoBaseObject* sumoBaseObject);
 
    private:
        bool myDefinedVehicleTypeParameter = false;
 
        bool myDefinedVehicleParameter = false;
 
        bool myDefinedStopParameter = false;
 
        void handleAttributeError(const SumoXMLAttr attr, const std::string& type) const;
 
        SumoBaseObject(const SumoBaseObject& s) = delete;
 
        SumoBaseObject& operator=(const SumoBaseObject& s) = delete;
    };
 
    CommonXMLStructure();
 
    ~CommonXMLStructure();
 
    void openSUMOBaseOBject();
 
    void closeSUMOBaseOBject();
 
    void abortSUMOBaseOBject();
 
    CommonXMLStructure::SumoBaseObject* getSumoBaseObjectRoot() const;
 
    CommonXMLStructure::SumoBaseObject* getCurrentSumoBaseObject() const;
 
protected:
    CommonXMLStructure::SumoBaseObject* mySumoBaseObjectRoot;
 
    CommonXMLStructure::SumoBaseObject* myCurrentSumoBaseObject;
 
private:
    CommonXMLStructure(const CommonXMLStructure& s) = delete;
 
    CommonXMLStructure& operator=(const CommonXMLStructure& s) = delete;
};