SUMORouteHandler.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-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
/****************************************************************************/
// Parser for routes during their loading
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <utils/common/IDSupplier.h>
#include <utils/common/SUMOTime.h>
#include <utils/vehicle/SUMOVehicleParameter.h>
#include <utils/xml/SUMOSAXHandler.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class MsgHandler;
class SUMOVTypeParameter;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class SUMORouteHandler : public SUMOSAXHandler {
public:
    enum StopPos {
        STOPPOS_VALID,
        STOPPOS_INVALID_STARTPOS,
        STOPPOS_INVALID_ENDPOS,
        STOPPOS_INVALID_LANELENGTH
    };
 
    SUMORouteHandler(const std::string& file, const std::string& expectedRoot, const bool hardFail);
 
    virtual ~SUMORouteHandler();
 
    static StopPos checkStopPos(double& startPos, double& endPos, const double laneLength, const double minLength, const bool friendlyPos);
 
    SUMOTime getFirstDepart() const;
 
    SUMOTime getLastDepart() const;
 
    static SumoRNG* getParsingRNG() {
        return &myParsingRNG;
    }
 
protected:
 
 
    virtual void myStartElement(int element,
                                const SUMOSAXAttributes& attrs);
 
    virtual void myEndElement(int element);
 
 
 
    virtual void openVehicleTypeDistribution(const SUMOSAXAttributes& attrs) = 0;
 
    virtual void closeVehicleTypeDistribution() = 0;
 
    virtual void openRoute(const SUMOSAXAttributes& attrs) = 0;
 
    virtual void openFlow(const SUMOSAXAttributes& attrs) = 0;
 
    virtual void openRouteFlow(const SUMOSAXAttributes& attrs) = 0;
 
    virtual void openTrip(const SUMOSAXAttributes& attrs) = 0;
 
 
 
    virtual void closeRoute(const bool mayBeDisconnected = false) = 0;
 
    virtual void openRouteDistribution(const SUMOSAXAttributes& attrs) = 0;
 
    virtual void closeRouteDistribution() = 0;
 
    virtual void closeVehicle() = 0;
 
    virtual void closeVType() = 0;
 
    virtual void closePerson() = 0;
 
    virtual void closePersonFlow() = 0;
 
    virtual void closeContainer() = 0;
 
    virtual void closeContainerFlow() = 0;
 
    virtual void closeFlow() = 0;
 
    virtual void closeTrip() = 0;
 
 
 
    virtual void addTransportable(const SUMOSAXAttributes& attrs, const bool isPerson) {
        UNUSED_PARAMETER(attrs);
        UNUSED_PARAMETER(isPerson);
    }
 
    virtual Parameterised* addStop(const SUMOSAXAttributes& attrs) = 0;
 
    virtual void addPersonTrip(const SUMOSAXAttributes& attrs) = 0;
 
    virtual void addWalk(const SUMOSAXAttributes& attrs) = 0;
 
    virtual void addRide(const SUMOSAXAttributes& attrs) = 0;
 
    virtual void addTransport(const SUMOSAXAttributes& attrs) = 0;
 
    virtual void addTranship(const SUMOSAXAttributes& attrs) = 0;
 
 
    virtual bool checkLastDepart();
 
    void registerLastDepart();
 
    void addParam(const SUMOSAXAttributes& attrs);
 
    bool parseStop(SUMOVehicleParameter::Stop& stop, const SUMOSAXAttributes& attrs, std::string errorSuffix, MsgHandler* const errorOutput);
 
protected:
    virtual const SUMOVTypeParameter* getVTypeParameter(const std::string& refid) = 0;
 
protected:
    const bool myHardFail;
 
    SUMOVehicleParameter* myVehicleParameter;
 
    std::vector<Parameterised*> myParamStack;
 
    SUMOTime myLastDepart;
 
    std::string myActiveRouteID;
 
    std::string myActiveRouteRefID;
 
    double myActiveRouteProbability;
 
    const RGBColor* myActiveRouteColor;
 
    double myCurrentCosts;
 
    StopParVector myActiveRouteStops;
 
    SUMOVTypeParameter* myCurrentVType;
 
    std::string myCurrentVTypeRef;
 
    double myCurrentVTypeProbability;
 
    SUMOTime myBeginDefault;
 
    SUMOTime myEndDefault;
 
    SUMOTime myFirstDepart;
 
    int myInsertStopEdgesAt;
 
    std::vector<int> myElementStack;
 
    bool myAllowInternalRoutes;
 
    std::set<std::string> mySkippedVehicles;
 
    static SumoRNG myParsingRNG;
 
private:
    SUMORouteHandler(const SUMORouteHandler& s) = delete;
 
    SUMORouteHandler& operator=(const SUMORouteHandler& s) = delete;
};