MSE3Collector.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
// Copyright (C) 2003-2018 German Aerospace Center (DLR) and others.
// This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v2.0
// which accompanies this distribution, and is available at
// http://www.eclipse.org/legal/epl-v20.html
// SPDX-License-Identifier: EPL-2.0
/****************************************************************************/
// A detector of vehicles passing an area between entry/exit points
/****************************************************************************/
#ifndef MSE3Collector_h
#define MSE3Collector_h


// ===========================================================================
// included modules
// ===========================================================================
#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>


// ===========================================================================
// class declarations
// ===========================================================================
class SUMOVehicle;
class OutputDevice;


// ===========================================================================
// class definitions
// ===========================================================================
class MSE3Collector : public MSDetectorFileOutput {
public:
    class MSE3EntryReminder : public MSMoveReminder {
    public:
        MSE3EntryReminder(const MSCrossSection& crossSection, MSE3Collector& collector);



        bool notifyEnter(SUMOVehicle& veh, Notification reason, const MSLane* enteredLane);

        bool notifyMove(SUMOVehicle& veh, double , double newPos, double);


        bool notifyLeave(SUMOVehicle& veh, double lastPos, MSMoveReminder::Notification reason, const MSLane* enteredLane = 0);


    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(SUMOVehicle& veh, Notification reason, const MSLane* enteredLane);

        bool notifyMove(SUMOVehicle& veh, double oldPos, double newPos, double);

        bool notifyLeave(SUMOVehicle& veh, double lastPos, MSMoveReminder::Notification reason, const MSLane* enteredLane = 0);


    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& vTypes, bool openEntry);


    virtual ~MSE3Collector();


    void reset();


    void enter(const SUMOVehicle& veh, const double entryTimestep, const double fractionTimeOnDet);


    void leaveFront(const SUMOVehicle& veh, const double leaveTimestep);


    void leave(const SUMOVehicle& veh, const double leaveTimestep, const double fractionTimeOnDet);



    double getCurrentMeanSpeed() const;


    int getCurrentHaltingNumber() const;


    int getVehiclesWithin() const;


    std::vector<std::string> getCurrentVehicleIDs() const;



    void writeXMLOutput(OutputDevice& dev, SUMOTime startTime, SUMOTime stopTime);


    void writeXMLDetectorProlog(OutputDevice& dev) const;



    void detectorUpdate(const SUMOTime step);


protected:
    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;
        double haltingBegin;
        double intervalSpeedSum;
        int intervalHaltings;
        SUMOTime timeLoss;
        SUMOTime intervalTimeLoss;
        bool hadUpdate;
    };

    std::map<const SUMOVehicle*, E3Values> myEnteredContainer;

    std::vector<E3Values> myLeftContainer;



    double myCurrentMeanSpeed;

    int myCurrentHaltingsNumber;


    SUMOTime myLastResetTime;

    const bool myOpenEntry;

private:
    MSE3Collector(const MSE3Collector&);

    MSE3Collector& operator=(const MSE3Collector&);


};


#endif

/****************************************************************************/