RouteHandler.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2024 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
/****************************************************************************/
// The XML-Handler for route elements loading
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <utils/xml/CommonXMLStructure.h>
 
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class RouteHandler {
 
public:
    RouteHandler(const std::string& filename, const bool hardFail);
 
    virtual ~RouteHandler();
 
    bool beginParseAttributes(SumoXMLTag tag, const SUMOSAXAttributes& attrs);
 
    void endParseAttributes();
 
    void parseSumoBaseObject(CommonXMLStructure::SumoBaseObject* obj);
 
 
    virtual void buildVType(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const SUMOVTypeParameter& vTypeParameter) = 0;
 
    virtual void buildVTypeDistribution(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, const int deterministic,
                                        const std::vector<std::string>& vTypeIDs, const std::vector<double>& probabilities) = 0;
 
    virtual void buildRoute(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id, SUMOVehicleClass vClass,
                            const std::vector<std::string>& edgeIDs, const RGBColor& color, const int repeat, const SUMOTime cycleTime,
                            const double probability, const Parameterised::Map& routeParameters) = 0;
 
    virtual void buildEmbeddedRoute(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::vector<std::string>& edgeIDs,
                                    const RGBColor& color, const int repeat, const SUMOTime cycleTime,
                                    const Parameterised::Map& routeParameters) = 0;
 
    virtual void buildRouteDistribution(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& id,
                                        const std::vector<std::string>& vTypeIDs, const std::vector<double>& probabilities) = 0;
 
    virtual void buildVehicleOverRoute(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const SUMOVehicleParameter& vehicleParameters) = 0;
 
    virtual void buildFlowOverRoute(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const SUMOVehicleParameter& vehicleParameters) = 0;
 
    virtual void buildTrip(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const SUMOVehicleParameter& vehicleParameters,
                           const std::string& fromEdgeID, const std::string& toEdgeID) = 0;
 
    virtual void buildTripJunctions(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const SUMOVehicleParameter& vehicleParameters,
                                    const std::string& fromJunctionID, const std::string& toJunctionID) = 0;
 
    virtual void buildTripTAZs(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const SUMOVehicleParameter& vehicleParameters,
                               const std::string& fromTazID, const std::string& toTazID) = 0;
 
    virtual void buildFlow(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const SUMOVehicleParameter& vehicleParameters,
                           const std::string& fromEdgeID, const std::string& toEdgeID) = 0;
 
    virtual void buildFlowJunctions(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const SUMOVehicleParameter& vehicleParameters,
                                    const std::string& fromJunctionID, const std::string& toJunctionID) = 0;
 
    virtual void buildFlowTAZs(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const SUMOVehicleParameter& vehicleParameters,
                               const std::string& fromTAZID, const std::string& toTAZID) = 0;
 
    virtual void buildPerson(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const SUMOVehicleParameter& personParameters) = 0;
 
    virtual void buildPersonFlow(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const SUMOVehicleParameter& personFlowParameters) = 0;
 
    virtual void buildPersonTrip(const CommonXMLStructure::SumoBaseObject* sumoBaseObject,
                                 const std::string& fromEdgeID, const std::string& fromTAZID, const std::string& fromJunctionID, const std::string& fromBusStopID, const std::string& fromTrainStopID,
                                 const std::string& toEdgeID, const std::string& toTAZID, const std::string& toJunctionID, const std::string& toBusStopID, const std::string& toTrainStopID,
                                 double arrivalPos, const std::vector<std::string>& types, const std::vector<std::string>& modes, const std::vector<std::string>& lines) = 0;
 
    virtual void buildWalk(const CommonXMLStructure::SumoBaseObject* sumoBaseObject,
                           const std::string& fromEdgeID, const std::string& fromTAZID, const std::string& fromJunctionID, const std::string& fromBusStopID, const std::string& fromTrainStopID,
                           const std::string& toEdgeID, const std::string& toTAZID, const std::string& toJunctionID, const std::string& toBusStopID, const std::string& toTrainStopID,
                           const std::vector<std::string>& edgeIDs, const std::string& routeID, double arrivalPos) = 0;
 
    virtual void buildRide(const CommonXMLStructure::SumoBaseObject* sumoBaseObject,
                           const std::string& fromEdgeID, const std::string& fromBusStopID, const std::string& fromTrainStopID,
                           const std::string& toEdgeID, const std::string& toBusStopID, const std::string& toTrainStopID,
                           double arrivalPos, const std::vector<std::string>& lines) = 0;
 
    virtual void buildContainer(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const SUMOVehicleParameter& containerParameters) = 0;
 
    virtual void buildContainerFlow(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const SUMOVehicleParameter& containerFlowParameters) = 0;
 
    virtual void buildTransport(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& fromEdgeID, const std::string& fromContainerStopID,
                                const std::string& toEdgeID, const std::string& toContainerStopID, const std::vector<std::string>& lines, const double arrivalPos) = 0;
 
    virtual void buildTranship(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const std::string& fromEdgeID, const std::string& fromContainerStopID,
                               const std::string& toEdgeID, const std::string& toContainerStopID, const std::vector<std::string>& edgeIDs, const double speed,
                               const double departPosition, const double arrivalPosition) = 0;
 
    virtual void buildStop(const CommonXMLStructure::SumoBaseObject* sumoBaseObject, const SUMOVehicleParameter::Stop& stopParameters) = 0;
 
 
    bool isErrorCreatingElement() const;
 
protected:
    void writeError(const std::string& error);
 
private:
    const std::string myFilename;
 
    const bool myHardFail;
 
    SUMOTime myFlowBeginDefault;
 
    SUMOTime myFlowEndDefault;
 
    CommonXMLStructure myCommonXMLStructure;
 
    bool myErrorCreatingElement = false;
 
    void writeErrorInvalidID(const SumoXMLTag tag, const std::string& id);
 
    void writeErrorInvalidDistribution(const SumoXMLTag tag, const std::string& id);
 
    void parseVType(const SUMOSAXAttributes& attrs);
 
    void parseVTypeDistribution(const SUMOSAXAttributes& attrs);
 
    void parseRoute(const SUMOSAXAttributes& attrs);
 
    void parseRouteDistribution(const SUMOSAXAttributes& attrs);
 
    void parseTrip(const SUMOSAXAttributes& attrs);
 
    void parseVehicle(const SUMOSAXAttributes& attrs);
 
    void parseFlow(const SUMOSAXAttributes& attrs);
 
    void parseStop(const SUMOSAXAttributes& attrs);
 
    void parsePerson(const SUMOSAXAttributes& attrs);
 
    void parsePersonFlow(const SUMOSAXAttributes& attrs);
 
    void parsePersonTrip(const SUMOSAXAttributes& attrs);
 
    void parseWalk(const SUMOSAXAttributes& attrs);
 
    void parseRide(const SUMOSAXAttributes& attrs);
 
    void parseContainer(const SUMOSAXAttributes& attrs);
 
    void parseContainerFlow(const SUMOSAXAttributes& attrs);
 
    void parseTransport(const SUMOSAXAttributes& attrs);
 
    void parseTranship(const SUMOSAXAttributes& attrs);
 
    void parseInterval(const SUMOSAXAttributes& attrs);
 
    void parseParameters(const SUMOSAXAttributes& attrs);
 
    bool parseNestedCFM(const SumoXMLTag tag, const SUMOSAXAttributes& attrs);
 
 
    bool parseStopParameters(SUMOVehicleParameter::Stop& stop, const SUMOSAXAttributes& attrs);
 
    bool isEmbeddedRoute(const SUMOSAXAttributes& attrs) const;
 
    void checkParent(const SumoXMLTag currentTag, const std::vector<SumoXMLTag>& parentTags, bool& ok);
 
    RouteHandler(const RouteHandler& s) = delete;
 
    RouteHandler& operator=(const RouteHandler& s) = delete;
};