MSInductLoop.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2004-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
/****************************************************************************/
// An unextended detector measuring at a fixed position on a fixed lane.
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <deque>
#include <map>
#include <queue>
#include <functional>
#include <microsim/MSMoveReminder.h>
#include <microsim/output/MSDetectorFileOutput.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class MSLane;
class MESegment;
class MSVehicle;
class OutputDevice;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class MSInductLoop
    : public MSMoveReminder, public MSDetectorFileOutput {
public:
    MSInductLoop(const std::string& id, MSLane* const lane,
                 double positionInMeters,
                 double length, std::string name,
                 const std::string& vTypes,
                 const std::string& nextEdges,
                 int detectPersons,
                 const bool needLocking);
 
 
    ~MSInductLoop();
 
 
    virtual void reset() override;
 
    std::string getName() const {
        return myName;
    }
 
    double getPosition() const {
        return myPosition;
    }
 
    double getEndPosition() const {
        return myEndPosition;
    }
 
 
 
    bool notifyEnter(SUMOTrafficObject& veh, Notification reason, const MSLane* enteredLane = 0) override;
 
    bool notifyMove(SUMOTrafficObject& veh, double oldPos, double newPos, double newSpeed) override;
 
 
    bool notifyLeave(SUMOTrafficObject& veh, double lastPos, MSMoveReminder::Notification reason, const MSLane* enteredLane = 0) override;
 
 
 
 
 
 
    double getSpeed(const int offset) const;
 
 
    double getVehicleLength(const int offset) const;
 
 
    double getOccupancy() const;
 
    double getEnteredNumber(const int offset) const;
 
 
    std::vector<std::string> getVehicleIDs(const int offset) const;
 
    double getIntervalOccupancy(bool lastInterval = false) const;
    double getIntervalMeanSpeed(bool lastInterval = false) const;
    int getIntervalVehicleNumber(bool lastInterval = false) const;
    std::vector<std::string> getIntervalVehicleIDs(bool lastInterval = false) const;
 
    double getTimeSinceLastDetection() const;
 
    double getOccupancyTime() const;
 
    double getArrivalDelay() const;
 
    SUMOTime getLastDetectionTime() const;
 
    double getOverrideTime() const {
        return myOverrideTime;
    }
 
 
    /* @brief Persistently overrides the measured time since detection with the given value.
     * Setting a negative value resets the override
     */
    void overrideTimeSinceDetection(double time);
 
    void saveState(OutputDevice& out) const override;
 
    void loadState(const SUMOSAXAttributes& attrs, const SUMOTime offset) override;
 
 
    void writeXMLOutput(OutputDevice& dev, SUMOTime startTime, SUMOTime stopTime) override;
 
 
    void writeXMLDetectorProlog(OutputDevice& dev) const override;
 
    void detectorUpdate(const SUMOTime step) override;
 
 
    struct VehicleData {
        VehicleData(const SUMOTrafficObject& v, double entryTimestep,
                    double leaveTimestep, const bool leftEarly, const double detLength = 0);
 
        std::string idM;
        double lengthM;
        double entryTimeM;
        double leaveTimeM;
        double speedM;
        std::string typeIDM;
        bool leftEarlyM;
    };
 
 
    std::vector<VehicleData> collectVehiclesOnDet(SUMOTime t, bool includeEarly = false, bool leaveTime = false, bool forOccupancy = false, bool lastInterval = false) const;
 
    virtual void setSpecialColor(const RGBColor* /*color*/) {};
 
    virtual void setVisible(bool /*show*/) {};
 
    virtual void clearState(SUMOTime time) override;
 
protected:
 
    static inline double speedSum(double sumSoFar, const MSInductLoop::VehicleData& data) {
        return sumSoFar + data.speedM;
    }
 
    static inline double lengthSum(double sumSoFar, const MSInductLoop::VehicleData& data) {
        return sumSoFar + data.lengthM;
    }
 
    void notifyMovePerson(MSTransportable* p, int dir, double pos);
 
    typedef std::priority_queue<SUMOTime, std::vector<SUMOTime>, std::greater<SUMOTime>> TimeQueue;
    static void discardOldTimes(TimeQueue& tq, SUMOTime now);
    static std::vector<SUMOTime> getTimes(TimeQueue tq, SUMOTime now);
 
protected:
    std::string myName;
 
    const double myPosition;
 
    const double myEndPosition;
 
    const bool myNeedLock;
 
    double myLastLeaveTime;
 
    mutable TimeQueue myNextMesoLeaveTimes;
    mutable TimeQueue myLastMesoLeaveTimes;
 
    double myOverrideTime;
 
    double myOverrideEntryTime;
 
    int myEnteredVehicleNumber;
 
    typedef std::deque< VehicleData > VehicleDataCont;
 
    VehicleDataCont myVehicleDataCont;
 
    VehicleDataCont myLastVehicleDataCont;
 
    std::map<SUMOTrafficObject*, double> myVehiclesOnDet;
 
    SUMOTime myLastIntervalEnd;
    SUMOTime myLastIntervalBegin;
 
    MESegment* mySegment;
 
    double mySegmentPos;
 
private:
    MSInductLoop(const MSInductLoop&);
 
    MSInductLoop& operator=(const MSInductLoop&);
 
 
};