RONet.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
/****************************************************************************/
// The router's network representation
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <vector>
#include <utils/common/MsgHandler.h>
#include <utils/common/NamedObjectCont.h>
#include <utils/distribution/RandomDistributor.h>
#include <utils/vehicle/SUMOVehicleParameter.h>
#include <utils/vehicle/SUMOVTypeParameter.h>
#include "ROLane.h"
#include "RORoutable.h"
#include "RORouteDef.h"
 
#ifdef HAVE_FOX
#include <utils/foxtools/MFXWorkerThread.h>
#endif
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class ROEdge;
class RONode;
class ROPerson;
class ROVehicle;
class ROAbstractEdgeBuilder;
class OptionsCont;
class OutputDevice;
 
typedef MapMatcher<ROEdge, ROLane, RONode> ROMapMatcher;
 
// ===========================================================================
// class definitions
// ===========================================================================
class RONet {
public:
 
    typedef std::map<const SUMOTime, std::vector<RORoutable*> > RoutablesMap;
    typedef std::map<const ROEdge*, RouterProhibition> Prohibitions;
    typedef std::map<const ROLane*, RouterProhibition> LaneProhibitions;
 
    RONet();
 
 
    static RONet* getInstance();
 
 
    virtual ~RONet();
 
 
    void addSpeedRestriction(const std::string& id, const SUMOVehicleClass svc, const double speed);
 
 
    const std::map<SUMOVehicleClass, double>* getRestrictions(const std::string& id) const;
 
    bool hasSpeedRestrictions() const {
        return !mySpeedRestrictions.empty();
    }
 
    bool hasParamRestrictions() const {
        return myHaveParamRestrictions;
    }
 
    void setParamRestrictions() {
        myHaveParamRestrictions = true;
    }
 
    double getPreference(const std::string& routingType, const SUMOVTypeParameter& pars) const;
 
    void addPreference(const std::string& routingType, SUMOVehicleClass svc, double prio);
    void addPreference(const std::string& routingType, std::string vType, double prio);
 
 
 
    /* @brief Adds a read edge to the network
     *
     * If the edge is already known (another one with the same id exists),
     *  an error is generated and given to msg-error-handler. The edge
     *  is deleted in this case and false is returned.
     *
     * @param[in] edge The edge to add
     * @return Whether the edge was added (if not, it was deleted, too)
     */
    virtual bool addEdge(ROEdge* edge);
 
 
    /* @brief Adds a district and connecting edges to the network
     *
     * If the district is already known (another one with the same id exists),
     *  an error is generated and given to msg-error-handler. The edges
     *  are deleted in this case and false is returned.
     *
     * @param[in] id The district to add
     * @return Whether the district was added
     */
    bool addDistrict(const std::string id, ROEdge* source, ROEdge* sink);
 
 
    /* @brief Adds a district and connecting edges to the network
     *
     * If the district is already known (another one with the same id exists),
     *  an error is generated and given to msg-error-handler. The edges
     *  are deleted in this case and false is returned.
     *
     * @param[in] id The district to add
     * @return Whether the district was added
     */
    bool addDistrictEdge(const std::string tazID, const std::string edgeID, const bool isSource);
 
    void addJunctionTaz(ROAbstractEdgeBuilder& eb);
 
    void setBidiEdges(const std::map<ROEdge*, std::string>& bidiMap);
 
    const std::map<std::string, std::pair<std::vector<std::string>, std::vector<std::string> > >& getDistricts() const {
        return myDistricts;
    }
 
    ROEdge* getEdge(const std::string& name) const {
        return myEdges.get(name);
    }
 
 
    ROEdge* getEdgeForLaneID(const std::string& laneID) const;
 
    ROLane* getLane(const std::string& laneID) const;
 
    /* @brief Adds a read node to the network
     *
     * If the node is already known (another one with the same id exists),
     *  an error is generated and given to msg-error-handler. The node
     *  is deleted in this case
     *
     * @param[in] node The node to add
     */
    void addNode(RONode* node);
 
 
    RONode* getNode(const std::string& id) const {
        return myNodes.get(id);
    }
 
 
    /* @brief Adds a read stopping place (bus, train, container, parking)  to the network
     *
     * If the place is already known (another one with the same id and category exists),
     *  an error is generated and given to msg-error-handler. The stop
     *  is deleted in this case
     *
     * @param[in] id The name of the stop to add
     * @param[in] category The type of stop
     * @param[in] stop The detailed stop description
     */
    void addStoppingPlace(const std::string& id, const SumoXMLTag category, SUMOVehicleParameter::Stop* stop);
 
    const SUMOVehicleParameter::Stop* getStoppingPlace(const std::string& id, const SumoXMLTag category) const {
        if (myStoppingPlaces.count(category) > 0) {
            return myStoppingPlaces.find(category)->second.get(id);
        }
        return 0;
    }
 
    const std::string getStoppingPlaceName(const std::string& id) const;
 
    const std::string getStoppingPlaceElement(const std::string& id) const;
 
 
 
 
 
    bool checkVType(const std::string& id);
 
 
    virtual bool addVehicleType(SUMOVTypeParameter* type);
 
 
    bool addVTypeDistribution(const std::string& id, RandomDistributor<SUMOVTypeParameter*>* vehTypeDistribution);
 
 
    const RandomDistributor<SUMOVTypeParameter*>* getVTypeDistribution(const std::string& id) {
        const auto it = myVTypeDistDict.find(id);
        return it != myVTypeDistDict.end() ? it ->second : nullptr;
    }
 
 
    SUMOVTypeParameter* getVehicleTypeSecure(const std::string& id);
 
 
    /* @brief Adds a route definition to the network
     *
     * If the route definition is already known (another one with
     *  the same id exists), false is returned, but the route definition
     *  is not deleted.
     *
     * @param[in] def The route definition to add
     * @return Whether the route definition could be added
     * @todo Rename myRoutes to myRouteDefinitions
     */
    bool addRouteDef(RORouteDef* def);
 
 
    RORouteDef* getRouteDef(const std::string& name) const {
        return myRoutes.get(name);
    }
 
 
    /* @brief Adds a vehicle to the network
     *
     * If the vehicle is already known (another one with the same id
     *  exists), false is returned, but the vehicle is not deleted.
     *
     * Otherwise, the number of loaded routes ("myReadRouteNo") is increased.
     *
     * @param[in] id The id of the vehicle to add
     * @param[in] veh The vehicle to add
     * @return Whether the vehicle could be added
     */
    virtual bool addVehicle(const std::string& id, ROVehicle* veh);
 
    bool knowsVehicle(const std::string& id) const;
 
    SUMOTime getDeparture(const std::string& vehID) const;
 
    /* @brief Adds a flow of vehicles to the network
     *
     * If the flow is already known (another one with the same id
     *  exists), false is returned, but the vehicle parameter are not deleted.
     *
     * Otherwise, the number of loaded routes ("myReadRouteNo") is increased.
     *
     * @param[in] flow The parameter of the flow to add
     * @return Whether the flow could be added
     */
    bool addFlow(SUMOVehicleParameter* flow, const bool randomize);
 
 
    /* @brief Adds a person to the network
     *
     * @param[in] person   The person to add
     */
    bool addPerson(ROPerson* person);
 
 
    /* @brief Adds a container to the network
     *
     * @param[in] depart The departure time of the container
     * @param[in] desc   The xml description of the container
     */
    void addContainer(const SUMOTime depart, const std::string desc);
    // @}
 
 
 
 
    SUMOTime saveAndRemoveRoutesUntil(OptionsCont& options,
                                      const RORouterProvider& provider, SUMOTime time);
 
 
    bool furtherStored();
 
 
    void openOutput(const OptionsCont& options);
 
 
    void writeIntermodal(const OptionsCont& options, ROIntermodalRouter& router) const;
 
 
    void cleanup();
 
 
    int getEdgeNumber() const;
 
    int getInternalEdgeNumber() const;
 
    const NamedObjectCont<ROEdge*>& getEdgeMap() const {
        return myEdges;
    }
 
    static void adaptIntermodalRouter(ROIntermodalRouter& router);
 
    bool hasPermissions() const;
 
    void setPermissionsFound();
 
    bool hasBidiEdges() const {
        return myHasBidiEdges;
    }
 
    bool hasLoadedEffort() const;
 
    double getMaxTraveltime() const {
        return myMaxTraveltime;
    }
 
    const Prohibitions& getProhibitions() const {
        return myProhibitions;
    }
 
    void updateLaneProhibitions(SUMOTime begin);
 
    void addProhibition(const ROEdge* edge, const RouterProhibition& prohibition);
    void addLaneProhibition(const ROLane* lane, const RouterProhibition& prohibition);
 
    OutputDevice* getRouteOutput(const bool alternative = false) {
        if (alternative) {
            return myRouteAlternativesOutput;
        }
        return myRoutesOutput;
    }
 
#ifdef HAVE_FOX
    MFXWorkerThread::Pool& getThreadPool() {
        return myThreadPool;
    }
 
    class WorkerThread : public MFXWorkerThread, public RORouterProvider {
    public:
        WorkerThread(MFXWorkerThread::Pool& pool,
                     const RORouterProvider& original)
            : MFXWorkerThread(pool), RORouterProvider(original) {}
        virtual ~WorkerThread() {
            stop();
        }
    };
 
    class BulkmodeTask : public MFXWorkerThread::Task {
    public:
        BulkmodeTask(const bool value) : myValue(value) {}
        void run(MFXWorkerThread* context) {
            static_cast<WorkerThread*>(context)->setBulkMode(myValue);
        }
    private:
        const bool myValue;
    private:
        BulkmodeTask& operator=(const BulkmodeTask&);
    };
#endif
 
 
private:
    void checkFlows(SUMOTime time, MsgHandler* errorHandler);
 
    void createBulkRouteRequests(const RORouterProvider& provider, const SUMOTime time, const bool removeLoops);
 
private:
    static RONet* myInstance;
 
    std::map<std::string, SUMOTime> myVehIDs;
 
    std::set<std::string> myPersonIDs;
 
    NamedObjectCont<RONode*> myNodes;
 
    NamedObjectCont<ROEdge*> myEdges;
 
    std::map<SumoXMLTag, NamedObjectCont<SUMOVehicleParameter::Stop*> > myStoppingPlaces;
 
    NamedObjectCont<SUMOVTypeParameter*> myVehicleTypes;
 
    typedef std::map< std::string, RandomDistributor<SUMOVTypeParameter*>* > VTypeDistDictType;
    VTypeDistDictType myVTypeDistDict;
 
    bool myDefaultVTypeMayBeDeleted;
 
    bool myDefaultPedTypeMayBeDeleted;
 
    bool myDefaultBikeTypeMayBeDeleted;
 
    bool myDefaultTaxiTypeMayBeDeleted;
 
    bool myDefaultRailTypeMayBeDeleted;
 
    NamedObjectCont<RORouteDef*> myRoutes;
 
    RoutablesMap myRoutables;
 
    NamedObjectCont<SUMOVehicleParameter*> myFlows;
 
    bool myHaveActiveFlows;
 
    typedef std::multimap<const SUMOTime, const std::string> ContainerMap;
    ContainerMap myContainers;
 
    std::vector<const RORoutable*> myPTVehicles;
 
    std::map<std::string, std::vector<SUMOTime> > myDepartures;
 
    std::map<std::string, std::pair<std::vector<std::string>, std::vector<std::string> > > myDistricts;
 
    OutputDevice* myRoutesOutput;
 
    OutputDevice* myRouteAlternativesOutput;
 
    OutputDevice* myTypesOutput;
 
    int myReadRouteNo;
 
    int myDiscardedRouteNo;
 
    int myWrittenRouteNo;
 
    bool myHavePermissions;
 
    std::map<std::string, std::map<SUMOVehicleClass, double> > mySpeedRestrictions;
 
    bool myHaveParamRestrictions;
 
    std::map<SUMOVehicleClass, std::map<std::string, double> > myVClassPreferences;
    std::map<std::string, std::map<std::string, double> > myVTypePreferences;
 
    int myNumInternalEdges;
 
    MsgHandler* myErrorHandler;
 
    const bool myKeepVTypeDist;
 
    const bool myDoPTRouting;
 
    const bool myKeepFlows;
 
    bool myHasBidiEdges;
 
    const double myMaxTraveltime;
 
    Prohibitions myProhibitions;
    LaneProhibitions myLaneProhibitions;
    std::map<SUMOTime, std::set<const ROLane*> > myLaneProhibitionTimes;
 
#ifdef HAVE_FOX
private:
    class RoutingTask : public MFXWorkerThread::Task {
    public:
        RoutingTask(RORoutable* v, const bool removeLoops, MsgHandler* errorHandler)
            : myRoutable(v), myRemoveLoops(removeLoops), myErrorHandler(errorHandler) {}
        void run(MFXWorkerThread* context);
    private:
        RORoutable* const myRoutable;
        const bool myRemoveLoops;
        MsgHandler* const myErrorHandler;
    private:
        RoutingTask& operator=(const RoutingTask&);
    };
 
 
private:
    MFXWorkerThread::Pool myThreadPool;
#endif
 
private:
    RONet(const RONet& src);
 
    RONet& operator=(const RONet& src);
 
};