MSDevice_Vehroutes.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2009-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 which collects info on the vehicle trip
/****************************************************************************/
#pragma once
#include <config.h>
 
#include "MSVehicleDevice.h"
#include <microsim/MSNet.h>
#include <microsim/MSVehicle.h>
#include <utils/common/SUMOTime.h>
#include <utils/iodevices/OutputDevice_String.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class MSEdge;
class MSRoute;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class MSDevice_Vehroutes : public MSVehicleDevice {
public:
    static void init();
 
    static void insertOptions(OptionsCont& oc);
 
    static MSDevice_Vehroutes* buildVehicleDevices(SUMOVehicle& v, std::vector<MSVehicleDevice*>& into, int maxRoutes = std::numeric_limits<int>::max());
 
 
    static void writePendingOutput(const bool includeUnfinished);
 
 
public:
    ~MSDevice_Vehroutes();
 
 
 
 
    bool notifyEnter(SUMOTrafficObject& veh, MSMoveReminder::Notification reason, const MSLane* enteredLane = 0);
 
 
    bool notifyLeave(SUMOTrafficObject& veh, double lastPos, Notification reason, const MSLane* enteredLane = 0);
 
    const std::string deviceName() const {
        return "vehroute";
    }
 
    void notifyStopEnded();
 
    void generateOutput(OutputDevice* tripinfoOut) const;
 
 
    ConstMSRoutePtr getRoute(int index) const;
 
 
    void saveState(OutputDevice& out) const;
 
    void loadState(const SUMOSAXAttributes& attrs);
 
    struct SortedRouteInfo {
        OutputDevice* routeOut = nullptr;
 
        std::map<const SUMOTime, int> departureCounts;
 
        std::map<const SUMOTime, std::map<const std::string, std::string> > routeXML;
    };
 
    static void registerTransportableDepart(SUMOTime depart);
    static void writeSortedOutput(SortedRouteInfo* routeInfo, SUMOTime depart, const std::string& id, const std::string& xmlOutput);
 
private:
    MSDevice_Vehroutes(SUMOVehicle& holder, const std::string& id, int maxRoutes);
 
 
    void writeXMLRoute(OutputDevice& os, int index = -1) const;
 
 
    void writeOutput(const bool hasArrived) const;
 
 
    void addRoute(const std::string& info);
 
private:
    static bool mySaveExits;
 
    static bool myLastRouteOnly;
 
    static bool myDUAStyle;
 
    static bool myWriteCosts;
 
    static bool mySorted;
 
    static bool myIntendedDepart;
 
    static bool myRouteLength;
 
    static bool mySkipPTLines;
 
    static bool myIncludeIncomplete;
 
    static bool myWriteStopPriorEdges;
 
    static bool myWriteInternal;
 
    class StateListener : public MSNet::VehicleStateListener {
    public:
        ~StateListener() {}
 
        void vehicleStateChanged(const SUMOVehicle* const vehicle, MSNet::VehicleState to, const std::string& info = "");
 
        std::map<const SUMOVehicle*, MSDevice_Vehroutes*, ComparatorNumericalIdLess> myDevices;
 
    };
 
 
    static StateListener myStateListener;
 
    static SortedRouteInfo myRouteInfos;
 
 
    class RouteReplaceInfo {
    public:
        RouteReplaceInfo(const MSEdge* const edge_, const SUMOTime time_, ConstMSRoutePtr const route_,
                         const std::string& info_, int lastRouteIndex_, int newRouteIndex_) :
            edge(edge_), time(time_), route(route_), info(info_),
            lastRouteIndex(lastRouteIndex_),
            newRouteIndex(newRouteIndex_)
        {}
 
        ~RouteReplaceInfo() { }
 
        const MSEdge* edge;
 
        SUMOTime time;
 
        ConstMSRoutePtr route;
 
        std::string info;
 
        // (vehicle may or may not have driven to the end of it)
        int lastRouteIndex;
 
        // (new route may or may not include prior driven route edges)
        int newRouteIndex;
 
    };
 
    ConstMSRoutePtr myCurrentRoute;
 
    std::vector<RouteReplaceInfo> myReplacedRoutes;
 
    std::vector<SUMOTime> myExits;
 
    const int myMaxRoutes;
 
    const MSEdge* myLastSavedAt;
 
    int myLastRouteIndex;
 
    int myDepartLane;
 
    double myDepartPos;
 
    double myDepartSpeed;
 
    double myDepartPosLat;
 
    std::vector<const MSEdge*> myPriorEdges;
 
    OutputDevice_String myStopOut;
 
private:
    MSDevice_Vehroutes(const MSDevice_Vehroutes&);
 
    MSDevice_Vehroutes& operator=(const MSDevice_Vehroutes&);
 
 
};