RORouteDef.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2002-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
/****************************************************************************/
// Base class for a vehicle's route definition
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <iostream>
#include <memory>
#include <utils/common/Named.h>
#include <utils/router/SUMOAbstractRouter.h>
#include "RORoute.h"
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class ROEdge;
class OptionsCont;
class ROVehicle;
class OutputDevice;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class RORouteDef : public Named {
public:
    RORouteDef(const std::string& id, const int lastUsed,
               const bool tryRepair, const bool mayBeDisconnected);
 
 
    virtual ~RORouteDef() {}
 
 
    void addLoadedAlternative(std::shared_ptr<RORoute> alternative) {
        myAlternatives.push_back(alternative);
    }
 
    void addAlternativeDef(const RORouteDef* alternative);
 
    void validateAlternatives(const ROVehicle* veh, MsgHandler* errorHandler);
 
    std::shared_ptr<RORoute> buildCurrentRoute(SUMOAbstractRouter<ROEdge, ROVehicle>& router, SUMOTime begin,
            const ROVehicle& veh) const;
 
    void preComputeCurrentRoute(SUMOAbstractRouter<ROEdge, ROVehicle>& router, SUMOTime begin,
                                const ROVehicle& veh) const;
 
    bool repairCurrentRoute(SUMOAbstractRouter<ROEdge, ROVehicle>& router, SUMOTime begin,
                            const ROVehicle& veh, ConstROEdgeVector oldEdges, ConstROEdgeVector& newEdges,
                            bool isTrip = false) const;
 
    std::shared_ptr<RORoute> addAlternative(SUMOAbstractRouter<ROEdge, ROVehicle>& router,
                                            const ROVehicle* const, std::shared_ptr<RORoute> current, SUMOTime begin,
                                            MsgHandler* errorHandler);
 
    const ROEdge* getOrigin() const;
    const ROEdge* getDestination() const;
 
    std::shared_ptr<const RORoute> getFirstRoute() const {
        if (myAlternatives.empty()) {
            return nullptr;
        }
        return myAlternatives.front();
    }
 
    std::shared_ptr<const RORoute> getUsedRoute() const {
        return myAlternatives[myLastUsed];
    }
 
    OutputDevice& writeXMLDefinition(OutputDevice& dev, const ROVehicle* const veh,
                                     bool asAlternatives, bool withExitTimes, bool withCost, bool withLength) const;
 
 
    RORouteDef* copy(const std::string& id, const SUMOTime stopOffset) const;
 
    double getOverallProb() const;
 
 
    bool discardSilent() const {
        return myDiscardSilent;
    }
 
 
    static void setUsingJTRR() {
        myUsingJTRR = true;
    }
 
    static void setSkipNew() {
        mySkipNewRoutes = true;
    }
 
protected:
    static bool backTrack(SUMOAbstractRouter<ROEdge, ROVehicle>& router,
                          ConstROEdgeVector::const_iterator& i, int lastMandatory, const ROEdge* nextMandatory,
                          ConstROEdgeVector& newEdges, const ROVehicle& veh, SUMOTime begin);
 
protected:
    mutable std::shared_ptr<RORoute> myPrecomputed;
 
    mutable int myLastUsed;
 
    std::vector<std::shared_ptr<RORoute> > myAlternatives;
 
    mutable bool myNewRoute;
 
    const bool myTryRepair;
    const bool myMayBeDisconnected;
 
    mutable bool myDiscardSilent;
 
    static bool myUsingJTRR;
    static bool mySkipNewRoutes;
 
private:
    RORouteDef(const RORouteDef& src) = delete;
 
    RORouteDef& operator=(const RORouteDef& src) = delete;
 
};