MSDevice_Tripinfo.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2009-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
/****************************************************************************/
// A device which collects info on the vehicle trip
/****************************************************************************/
#pragma once
#include <config.h>
 
#include "MSVehicleDevice.h"
#include <utils/common/SUMOTime.h>
 
// ===========================================================================
// class declarations
// ===========================================================================
class SUMOVehicle;
class SUMOTrafficObject;
 
// ===========================================================================
// class definitions
// ===========================================================================
class MSDevice_Tripinfo : public MSVehicleDevice {
public:
    static void insertOptions(OptionsCont& oc);
 
    static void buildVehicleDevices(SUMOVehicle& v, std::vector<MSVehicleDevice*>& into);
 
    static void generateOutputForUnfinished();
 
    static void addPedestrianData(double walkLength, SUMOTime walkDuration, SUMOTime walkTimeLoss);
 
    static void addRideTransportData(const bool isPerson, const double distance, const SUMOTime duration,
                                     const SUMOVehicleClass vClass, const std::string& line, const SUMOTime waitingTime);
 
    static std::string printStatistics();
 
    static void writeStatistics(OutputDevice& od);
 
    static double getAvgRouteLength();
    static double getAvgTripSpeed();
    static double getAvgDuration();
    static double getAvgWaitingTime();
    static double getAvgTimeLoss();
    static double getAvgDepartDelay();
    static double getAvgDepartDelayWaiting();
    static double getTotalDepartDelay();
 
    static double getAvgBikeRouteLength();
    static double getAvgBikeTripSpeed();
    static double getAvgBikeDuration();
    static double getAvgBikeWaitingTime();
    static double getAvgBikeTimeLoss();
    static double getAvgBikeDepartDelay();
    static double getTotalBikeDepartDelay();
 
    static double getAvgWalkRouteLength();
    static double getAvgWalkDuration();
    static double getAvgWalkTimeLoss();
 
    static double getAvgRideRouteLength();
    static double getAvgRideWaitingTime();
    static double getAvgRideDuration();
 
public:
    ~MSDevice_Tripinfo();
 
 
    static void cleanup();
 
 
 
    bool notifyMove(SUMOTrafficObject& veh, double oldPos, double newPos, double newSpeed);
 
    bool notifyIdle(SUMOTrafficObject& veh);
 
    bool notifyEnter(SUMOTrafficObject& veh, MSMoveReminder::Notification reason, const MSLane* enteredLane = 0);
 
 
    bool notifyLeave(SUMOTrafficObject& veh, double lastPos, MSMoveReminder::Notification reason, const MSLane* enteredLane = 0);
 
 
    const std::string deviceName() const {
        return "tripinfo";
    }
 
    void generateOutput(OutputDevice* tripinfoOut) const;
 
    void saveState(OutputDevice& out) const;
 
    void loadState(const SUMOSAXAttributes& attrs);
 
    void updateStopTime(const SUMOTime time) {
        myStoppingTime += time;
    }
 
 
    std::string getParameter(const std::string& key) const;
 
    static std::string getGlobalParameter(const std::string& prefixedKey);
 
    void recordMesoParkingTimeLoss(SUMOTime waitingTime);
 
private:
    MSDevice_Tripinfo(SUMOVehicle& holder, const std::string& id);
 
 
protected:
    void notifyMoveInternal(const SUMOTrafficObject& veh,
                            const double frontOnLane,
                            const double timeOnLane,
                            const double meanSpeedFrontOnLane,
                            const double meanSpeedVehicleOnLane,
                            const double travelledDistanceFrontOnLane,
                            const double travelledDistanceVehicleOnLane,
                            const double meanLengthOnLane);
 
    void updateParkingStopTime();
 
    static void printRideStatistics(std::ostringstream& msg, const std::string& category, const std::string& modeName, const int index);
 
    static void writeRideStatistics(OutputDevice& od, const std::string& category, const int index);
 
    static bool lowAcceleration(const SUMOTrafficObject& veh);
 
private:
    std::string myDepartLane;
 
    double myDepartSpeed;
 
    double myDepartPosLat;
 
    SUMOTime myWaitingTime;
 
    bool myAmWaiting;
 
    int myWaitingCount;
 
    SUMOTime myStoppingTime;
 
    SUMOTime myParkingStarted;
 
    SUMOTime myArrivalTime;
 
    std::string myArrivalLane;
 
    double myArrivalPos;
 
    double myArrivalPosLat;
 
    double myArrivalSpeed;
 
    MSMoveReminder::Notification myArrivalReason;
 
    SUMOTime myMesoTimeLoss;
 
    double myRouteLength;
 
    static std::set<const MSDevice_Tripinfo*, ComparatorNumericalIdLess> myPendingOutput;
 
    static int myVehicleCount;
    static int myUndepartedVehicleCount;
    static double myTotalRouteLength;
    static double myTotalSpeed;
    static SUMOTime myTotalDuration;
    static SUMOTime myTotalWaitingTime;
    static SUMOTime myTotalTimeLoss;
    static SUMOTime myTotalDepartDelay;
    static SUMOTime myWaitingDepartDelay;
 
    static int myBikeCount;
    static double myTotalBikeRouteLength;
    static double myTotalBikeSpeed;
    static SUMOTime myTotalBikeDuration;
    static SUMOTime myTotalBikeWaitingTime;
    static SUMOTime myTotalBikeTimeLoss;
    static SUMOTime myTotalBikeDepartDelay;
 
    static int myWalkCount;
    static double myTotalWalkRouteLength;
    static SUMOTime myTotalWalkDuration;
    static SUMOTime myTotalWalkTimeLoss;
 
    static std::vector<int> myRideCount;
    static std::vector<int> myRideBusCount;
    static std::vector<int> myRideRailCount;
    static std::vector<int> myRideTaxiCount;
    static std::vector<int> myRideBikeCount;
    static std::vector<int> myRideAbortCount;
    static std::vector<SUMOTime> myTotalRideWaitingTime;
    static std::vector<double> myTotalRideRouteLength;
    static std::vector<SUMOTime> myTotalRideDuration;
 
private:
    MSDevice_Tripinfo(const MSDevice_Tripinfo&);
 
    MSDevice_Tripinfo& operator=(const MSDevice_Tripinfo&);
 
 
};