MSRoute.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2002-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
/****************************************************************************/
// A vehicle route
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <map>
#include <vector>
#include <algorithm>
#include <memory>
#include <utils/common/Named.h>
#include <utils/distribution/RandomDistributor.h>
#include <utils/common/RGBColor.h>
#include <utils/vehicle/SUMOVehicleParameter.h>
#include <utils/common/Parameterised.h>
#ifdef HAVE_FOX
#include <utils/foxtools/fxheader.h>
#include <FXThread.h>
#endif
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class MSEdge;
class MSLane;
class MSRoute;
class OutputDevice;
 
 
// ===========================================================================
// types definitions
// ===========================================================================
typedef std::vector<const MSEdge*> ConstMSEdgeVector;
typedef std::vector<MSEdge*> MSEdgeVector;
typedef ConstMSEdgeVector::const_iterator MSRouteIterator;
typedef std::shared_ptr<const MSRoute> ConstMSRoutePtr;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class MSRoute : public Named, public Parameterised {
public:
    MSRoute(const std::string& id, const ConstMSEdgeVector& edges,
            const bool isPermanent, const RGBColor* const c,
            const StopParVector& stops,
            SUMOTime replacedTime = -1,
            int replacedIndex = 0);
 
    virtual ~MSRoute();
 
    MSRouteIterator begin() const;
 
    MSRouteIterator end() const;
 
    int size() const;
 
    const MSEdge* getLastEdge() const;
 
    const MSEdge* getFirstEdge() const;
 
    void checkRemoval(bool force = false) const;
 
    int writeEdgeIDs(OutputDevice& os, int firstIndex = 0, int lastIndex = -1, bool withInternal = false, SUMOVehicleClass svc = SVC_IGNORING) const;
 
    bool contains(const MSEdge* const edge) const {
        return std::find(myEdges.begin(), myEdges.end(), edge) != myEdges.end();
    }
 
    bool containsAnyOf(const MSEdgeVector& edgelist) const;
 
    const MSEdge* operator[](int index) const;
 
 
    static void dict_saveState(OutputDevice& out);
 
    static void dict_clearState();
 
    const ConstMSEdgeVector& getEdges() const {
        return myEdges;
    }
 
    double getDistanceBetween(double fromPos, double toPos, const MSLane* fromLane, const MSLane* toLane, int routePosition = 0) const;
 
    double getDistanceBetween(double fromPos, double toPos, const MSRouteIterator& fromEdge, const MSRouteIterator& toEdge, bool includeInternal = true) const;
 
 
    const RGBColor& getColor() const;
 
    SUMOTime getPeriod() const {
        return myPeriod;
    }
 
    double getCosts() const {
        return myCosts;
    }
 
    double getSavings() const {
        return mySavings;
    }
 
    SUMOTime getReplacedTime() const {
        return myReplacedTime;
    }
 
    int getReplacedIndex() const {
        return myReplacedIndex;
    }
 
    void setPeriod(SUMOTime period) {
        myPeriod = period;
    }
 
    void setCosts(double costs) {
        myCosts = costs;
    }
    void setSavings(double savings) {
        mySavings = savings;
    }
 
    bool mustReroute() const {
        return myReroute;
    }
 
    void setReroute(bool reroute = true) {
        myReroute = reroute;
    }
 
    const StopParVector& getStops() const;
 
public:
    static bool dictionary(const std::string& id, ConstMSRoutePtr route);
 
    static bool dictionary(const std::string& id, RandomDistributor<ConstMSRoutePtr>* const routeDist, const bool permanent = true);
 
    static ConstMSRoutePtr dictionary(const std::string& id, SumoRNG* rng = 0);
 
    static bool hasRoute(const std::string& id);
 
    static RandomDistributor<ConstMSRoutePtr>* distDictionary(const std::string& id);
 
    static void clear();
 
    static void checkDist(const std::string& id);
 
    static void insertIDs(std::vector<std::string>& into);
 
private:
    ConstMSEdgeVector myEdges;
 
    const bool myAmPermanent;
 
    const RGBColor* const myColor;
 
    SUMOTime myPeriod;
 
    double myCosts;
 
    double mySavings;
 
    bool myReroute;
 
    StopParVector myStops;
 
    SUMOTime myReplacedTime;
 
    int myReplacedIndex;
 
private:
    typedef std::map<std::string, ConstMSRoutePtr> RouteDict;
 
    static RouteDict myDict;
 
    typedef std::map<std::string, std::pair<RandomDistributor<ConstMSRoutePtr>*, bool> > RouteDistDict;
 
    static RouteDistDict myDistDict;
 
#ifdef HAVE_FOX
    static FXMutex myDictMutex;
#endif
private:
    MSRoute& operator=(const MSRoute& s);
 
};