RORouteHandler.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
/****************************************************************************/
// Parser and container for routes during their loading
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <vector>
#include <utils/distribution/RandomDistributor.h>
#include <utils/common/SUMOTime.h>
#include <utils/common/MapMatcher.h>
#include <utils/router/PedestrianRouter.h>
#include <utils/vehicle/SUMORouteHandler.h>
#include "ROPerson.h"
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class OutputDevice_String;
class ROEdge;
class ROLane;
class RONet;
class RORoute;
class RORouteDef;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class RORouteHandler : public SUMORouteHandler, public MapMatcher<ROEdge, ROLane, RONode> {
public:
    RORouteHandler(RONet& net, const std::string& file,
                   const bool tryRepair,
                   const bool emptyDestinationsAllowed,
                   const bool ignoreErrors,
                   const bool checkSchema);
 
    ~RORouteHandler() override;
 
    bool checkLastDepart() override;
 
protected:
    void deleteActivePlanAndVehicleParameter();
 
 
 
    void myStartElement(int element,
                        const SUMOSAXAttributes& attrs) override;
 
    void parseFromViaTo(SumoXMLTag tag, const SUMOSAXAttributes& attrs, bool& ok);
 
    void openVehicleTypeDistribution(const SUMOSAXAttributes& attrs) override;
 
    void closeVehicleTypeDistribution() override;
 
    void openRoute(const SUMOSAXAttributes& attrs) override;
 
    void openFlow(const SUMOSAXAttributes& attrs) override;
 
    void openRouteFlow(const SUMOSAXAttributes& attrs) override;
 
    void openTrip(const SUMOSAXAttributes& attrs) override;
 
    void closeRoute(const bool mayBeDisconnected = false) override;
 
    void openRouteDistribution(const SUMOSAXAttributes& attrs) override;
 
    void closeRouteDistribution() override;
 
    void closeVehicle() override;
 
    void closeVType() override;
 
    void closePerson() override;
 
    void closePersonFlow() override;
 
    void closeContainer() override;
 
    void closeContainerFlow() override;
 
    void closeFlow() override;
 
    void closeTrip() override;
 
    const SUMOVehicleParameter::Stop* retrieveStoppingPlace(const SUMOSAXAttributes& attrs, const std::string& errorSuffix, std::string& id, const SUMOVehicleParameter::Stop* stopParam = nullptr);
 
    Parameterised* addStop(const SUMOSAXAttributes& attrs) override;
 
    void addFlowPerson(const std::string& typeID, SUMOTime depart, const std::string& baseID, int i);
 
    void addRide(const SUMOSAXAttributes& attrs) override;
 
    void addTransport(const SUMOSAXAttributes& attrs) override;
 
    void addTranship(const SUMOSAXAttributes& attrs) override;
 
    void parseEdges(const std::string& desc, ConstROEdgeVector& into,
                    const std::string& rid, bool& ok);
 
    void addPersonTrip(const SUMOSAXAttributes& attrs) override;
 
    void addWalk(const SUMOSAXAttributes& attrs) override;
 
    void parseWalkPositions(const SUMOSAXAttributes& attrs, const std::string& personID,
                            const ROEdge* fromEdge, const ROEdge*& toEdge,
                            double& departPos, double& arrivalPos, std::string& busStopID,
                            const ROPerson::PlanItem* const lastStage, bool& ok);
 
    void initLaneTree(NamedRTree* tree) override;
 
    ROEdge* retrieveEdge(const std::string& id) override;
 
protected:
    RONet& myNet;
 
    ConstROEdgeVector myActiveRoute;
 
    int myActiveRouteRepeat;
    SUMOTime myActiveRoutePeriod;
 
    std::vector<ROPerson::PlanItem*>* myActivePlan;
 
    OutputDevice_String* myActiveContainerPlan;
 
    int myActiveContainerPlanSize;
 
    const bool myTryRepair;
 
    const bool myEmptyDestinationsAllowed;
 
    MsgHandler* const myErrorOutput;
 
    const SUMOTime myBegin;
 
    const bool myKeepVTypeDist;
 
    const bool myUnsortedInput;
 
    RandomDistributor<SUMOVTypeParameter*>* myCurrentVTypeDistribution;
 
    std::string myCurrentVTypeDistributionID;
 
    RORouteDef* myCurrentAlternatives;
 
private:
    RORouteHandler(const RORouteHandler& s) = delete;
 
    RORouteHandler& operator=(const RORouteHandler& s) = delete;
};