MSMeanData_Net.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2004-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
/****************************************************************************/
// Network state mean data collector for edges/lanes
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <vector>
#include <set>
#include <limits>
#include "MSMeanData.h"
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class OutputDevice;
class MSEdgeControl;
class MSEdge;
class MSLane;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class MSMeanData_Net : public MSMeanData {
public:
    class MSLaneMeanDataValues : public MSMeanData::MeanDataValues {
    public:
        MSLaneMeanDataValues(MSLane* const lane, const double length, const bool doAdd,
                             const MSMeanData_Net* parent);
 
        virtual ~MSLaneMeanDataValues();
 
        void reset(bool afterWrite = false);
 
        void addTo(MSMeanData::MeanDataValues& val) const;
 
 
        bool notifyLeave(SUMOTrafficObject& veh, double lastPos, MSMoveReminder::Notification reason, const MSLane* enteredLane = 0);
 
 
        bool notifyEnter(SUMOTrafficObject& veh, MSMoveReminder::Notification reason, const MSLane* enteredLane = 0);
 
        bool isEmpty() const;
 
        void write(OutputDevice& dev, long long int attributeMask, const SUMOTime period,
                   const int numLanes, const double speedLimit, const double defaultTravelTime,
                   const int numVehicles = -1) const;
 
        double getAttributeValue(SumoXMLAttr a, const SUMOTime period, const double numLanes, const double speedLimit) const;
 
        double getOccupancy(SUMOTime period, int numLanes) const;
 
    protected:
        void notifyMoveInternal(const SUMOTrafficObject& veh,
                                const double frontOnLane, const double timeOnLane, const double,
                                const double meanSpeedVehicleOnLane,
                                const double travelledDistanceFrontOnLane,
                                const double travelledDistanceVehicleOnLane,
                                const double meanLengthOnLane);
 
    private:
//        /// @brief Calculate the vehicle front's distance to myLane's end for a vehicle that called notifyMoveInternal()
//        ///        maxDist gives the maximal distance to search back from the vehicle's current lane to myLane
//        ///        returns INVALID_DOUBLE if myLane wasn't found in that range
//        double getVehicleDistToMyLane(const SUMOVehicle& veh, double maxDist);
 
    public:
        int nVehDeparted;
 
        int nVehArrived;
 
        int nVehEntered;
 
        int nVehLeft;
 
        int nVehVaporized;
 
        int nVehTeleported;
 
        double waitSeconds;
 
        double timeLoss;
 
    private:
        int nVehLaneChangeFrom;
 
        int nVehLaneChangeTo;
 
        double frontSampleSeconds;
 
        double frontTravelledDistance;
 
        double vehLengthSum;
 
        double occupationSum;
 
        double minimalVehicleLength;
 
 
        const MSMeanData_Net* myParent;
 
    };
 
 
public:
    MSMeanData_Net(const std::string& id,
                   const SUMOTime dumpBegin, const SUMOTime dumpEnd,
                   const bool useLanes, const bool withEmpty, const bool printDefaults,
                   const bool withInternal, const bool trackVehicles, const int detectPersons,
                   const double maxTravelTime, const double minSamples,
                   const double haltSpeed, const std::string& vTypes,
                   const std::string& writeAttributes,
                   const std::vector<MSEdge*>& edges,
                   bool aggregate);
 
 
    virtual ~MSMeanData_Net();
 
    std::vector<std::string> getAttributeNames() const;
 
    double getAttributeValue(const MSLane* lane, SumoXMLAttr a, double defaultValue) const;
 
protected:
    MSMeanData::MeanDataValues* createValues(MSLane* const lane, const double length, const bool doAdd) const;
 
    void resetOnly(SUMOTime stopTime);
 
private:
    const double myHaltSpeed;
 
    MSMeanData_Net(const MSMeanData_Net&);
 
    MSMeanData_Net& operator=(const MSMeanData_Net&);
 
};