MSE3Collector.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2003-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 detector of vehicles passing an area between entry/exit points
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <vector>
#include <limits>
#include <microsim/MSMoveReminder.h>
#include <microsim/output/MSDetectorFileOutput.h>
#include <utils/common/Named.h>
#include <microsim/output/MSCrossSection.h>
#include <utils/common/UtilExceptions.h>
#ifdef HAVE_FOX
#include <utils/foxtools/fxheader.h>
#endif
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class SUMOTrafficObject;
class OutputDevice;
class MSTransportable;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class MSE3Collector : public MSDetectorFileOutput {
public:
    class MSE3EntryReminder : public MSMoveReminder {
    public:
        MSE3EntryReminder(const MSCrossSection& crossSection, MSE3Collector& collector);
 
 
 
        bool notifyEnter(SUMOTrafficObject& veh, Notification reason, const MSLane* enteredLane);
 
        bool notifyMove(SUMOTrafficObject& veh, double, double newPos, double);
 
 
        bool notifyLeave(SUMOTrafficObject& veh, double lastPos, MSMoveReminder::Notification reason, const MSLane* enteredLane = 0);
 
 
        double getPosition() const {
            return myPosition;
        }
 
    private:
        MSE3Collector& myCollector;
 
        double myPosition;
 
    private:
        MSE3EntryReminder(const MSE3EntryReminder&);
 
        MSE3EntryReminder& operator=(const MSE3EntryReminder&);
 
    };
 
 
 
    class MSE3LeaveReminder : public MSMoveReminder {
    public:
        MSE3LeaveReminder(const MSCrossSection& crossSection, MSE3Collector& collector);
 
 
 
 
        bool notifyEnter(SUMOTrafficObject& veh, Notification reason, const MSLane* enteredLane);
 
        bool notifyMove(SUMOTrafficObject& veh, double oldPos, double newPos, double);
 
        bool notifyLeave(SUMOTrafficObject& veh, double lastPos, MSMoveReminder::Notification reason, const MSLane* enteredLane = 0);
 
        double getPosition() const {
            return myPosition;
        }
 
 
    private:
        MSE3Collector& myCollector;
 
        double myPosition;
 
    private:
        MSE3LeaveReminder(const MSE3LeaveReminder&);
 
        MSE3LeaveReminder& operator=(const MSE3LeaveReminder&);
 
    };
 
 
    MSE3Collector(const std::string& id,
                  const CrossSectionVector& entries, const CrossSectionVector& exits,
                  double haltingSpeedThreshold,
                  SUMOTime haltingTimeThreshold,
                  const std::string name, const std::string& vTypes,
                  const std::string& nextEdges,
                  int detectPersons, bool openEntry, bool expectArrival);
 
 
    virtual ~MSE3Collector();
 
 
    void reset();
 
 
    void enter(const SUMOTrafficObject& veh, const double entryTimestep, const double fractionTimeOnDet, MSE3EntryReminder* entryReminder, bool isBackward = false);
 
 
    void leaveFront(const SUMOTrafficObject& veh, const double leaveTimestep);
 
 
    void leave(const SUMOTrafficObject& veh, const double leaveTimestep, const double fractionTimeOnDet, bool isBackward = false);
 
    const CrossSectionVector& getEntries() const;
 
    const CrossSectionVector& getExits() const;
 
 
    double getCurrentMeanSpeed() const;
 
 
    int getCurrentHaltingNumber() const;
 
 
    int getVehiclesWithin() const;
 
 
    std::vector<std::string> getCurrentVehicleIDs() const;
 
 
    double getLastIntervalMeanTravelTime() const {
        return myLastMeanTravelTime;
    }
 
    double getLastIntervalMeanHaltsPerVehicle() const {
        return myLastMeanHaltsPerVehicle;
    }
 
    double getLastIntervalMeanTimeLoss() const {
        return myLastMeanTimeLoss;
    }
 
    int getLastIntervalVehicleSum() const {
        return myLastVehicleSum;
    }
 
 
    void writeXMLOutput(OutputDevice& dev, SUMOTime startTime, SUMOTime stopTime);
 
 
    void writeXMLDetectorProlog(OutputDevice& dev) const;
 
 
 
    void detectorUpdate(const SUMOTime step);
 
    virtual void clearState(SUMOTime step);
 
protected:
    void notifyMovePerson(MSTransportable* p, MSMoveReminder* rem, double detPos, int dir, double pos);
 
protected:
    std::string myName;
 
    CrossSectionVector myEntries;
 
    CrossSectionVector myExits;
 
    std::vector<MSE3EntryReminder*> myEntryReminders;
 
    std::vector<MSE3LeaveReminder*> myLeaveReminders;
 
 
    // @brief Time-threshold to determine if a vehicle is halting.
    SUMOTime myHaltingTimeThreshold;
 
    double myHaltingSpeedThreshold;
 
    struct E3Values {
        double entryTime;
        double frontLeaveTime;
        double backLeaveTime;
        double speedSum;
        int haltings;
        SUMOTime haltingBegin;
        double intervalSpeedSum;
        int intervalHaltings;
        SUMOTime timeLoss;
        SUMOTime intervalTimeLoss;
        bool hadUpdate;
        MSE3EntryReminder* entryReminder;
    };
 
    std::map<const SUMOTrafficObject*, E3Values> myEnteredContainer;
 
    std::vector<E3Values> myLeftContainer;
 
#ifdef HAVE_FOX
    FXMutex myContainerMutex;
#endif
 
 
    double myCurrentMeanSpeed;
 
    int myCurrentHaltingsNumber;
 
    double myLastMeanTravelTime;
    double myLastMeanHaltsPerVehicle;
    double myLastMeanTimeLoss;
    int myLastVehicleSum;
 
    SUMOTime myLastResetTime;
 
    const bool myOpenEntry;
    const bool myExpectArrival;
 
private:
    MSE3Collector(const MSE3Collector&);
 
    MSE3Collector& operator=(const MSE3Collector&);
 
 
};