MSDevice_Routing.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2007-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 device that performs vehicle rerouting based on current edge speeds
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <set>
#include <vector>
#include <map>
#include <utils/common/SUMOTime.h>
#include <utils/common/WrappingCommand.h>
#include <microsim/MSVehicle.h>
#include "MSVehicleDevice.h"
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class MSLane;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class MSDevice_Routing : public MSVehicleDevice {
public:
    static void insertOptions(OptionsCont& oc);
 
    static bool checkOptions(OptionsCont& oc);
 
 
    static void buildVehicleDevices(SUMOVehicle& v, std::vector<MSVehicleDevice*>& into);
 
 
    ~MSDevice_Routing();
 
 
 
 
    bool notifyEnter(SUMOTrafficObject& veh, MSMoveReminder::Notification reason, const MSLane* enteredLane = 0);
 
    void notifyStopEnded();
 
 
    const std::string deviceName() const {
        return "rerouting";
    }
 
    void saveState(OutputDevice& out) const;
 
    void loadState(const SUMOSAXAttributes& attrs);
 
    void reroute(const SUMOTime currentTime, const bool onInit = false);
 
 
    void skipRouting(const SUMOTime currentTime) {
        mySkipRouting = currentTime;
    }
 
    SUMOTime getPeriod() const {
        return myPeriod;
    }
 
    bool mayRerouteRailSignal() const {
        return myRerouteRailSignal;
    }
 
    std::string getParameter(const std::string& key) const;
 
    void setParameter(const std::string& key, const std::string& value);
 
    void setActive(bool active) {
        myActive = active;
    }
 
    bool sufficientSaving(double oldCost, double newCost);
 
private:
 
    MSDevice_Routing(SUMOVehicle& holder, const std::string& id, SUMOTime period, SUMOTime preInsertionPeriod);
 
    SUMOTime preInsertionReroute(const SUMOTime currentTime);
 
    SUMOTime wrappedRerouteCommandExecute(SUMOTime currentTime);
 
    void rebuildRerouteCommand(SUMOTime start);
 
private:
    SUMOTime myPeriod;
 
    SUMOTime myPreInsertionPeriod;
 
    SUMOTime myLastRouting;
 
    SUMOTime mySkipRouting;
 
    WrappingCommand< MSDevice_Routing >* myRerouteCommand;
 
    bool myRerouteRailSignal;
 
    SUMOTime myLastLaneEntryTime;
 
    bool myRerouteAfterStop;
 
    // Only reroute if the new route is faster than the current route by factor
    double myThresholdFactor;
 
    // Only reroute if the new route is faster than the current route by seconds
    double myThresholdTime;
 
    bool myActive;
 
private:
    MSDevice_Routing(const MSDevice_Routing&);
 
    MSDevice_Routing& operator=(const MSDevice_Routing&);
 
 
};