MSTransportableDevice_Routing.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2007-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
/****************************************************************************/
// A device that performs vehicle rerouting based on current edge speeds
/****************************************************************************/
#pragma once
#include <config.h>
 
#include "MSTransportableDevice.h"
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class MSLane;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class MSTransportableDevice_Routing : public MSTransportableDevice {
public:
    static void insertOptions(OptionsCont& oc);
 
    static bool checkOptions(OptionsCont& oc);
 
 
    static void buildDevices(MSTransportable& p, std::vector<MSTransportableDevice*>& into);
 
 
    ~MSTransportableDevice_Routing();
 
 
    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);
 
    std::string getParameter(const std::string& key) const;
 
    void setParameter(const std::string& key, const std::string& value);
 
 
private:
 
    MSTransportableDevice_Routing(MSTransportable& holder, const std::string& id, SUMOTime period);
 
    SUMOTime wrappedRerouteCommandExecute(SUMOTime currentTime);
 
 
private:
    SUMOTime myPeriod;
 
    SUMOTime myLastRouting;
 
    WrappingCommand< MSTransportableDevice_Routing >* myRerouteCommand;
 
    std::string myScope;
 
private:
    MSTransportableDevice_Routing(const MSTransportableDevice_Routing&);
 
    MSTransportableDevice_Routing& operator=(const MSTransportableDevice_Routing&);
 
 
};