MSE3Collector.h

Go to the documentation of this file.

/****************************************************************************/
// A detector of vehicles passing an area between entry/exit points
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
// Copyright (C) 2001-2011 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This program is free software; you can redistribute it and/or modify
//   it under the terms of the GNU General Public License as published by
//   the Free Software Foundation; either version 2 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef MSE3Collector_h
#define MSE3Collector_h


// ===========================================================================
// included modules
// ===========================================================================
#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#include <string>
#include <cassert>
#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) throw();



        bool notifyMove(SUMOVehicle& veh, SUMOReal , SUMOReal newPos, SUMOReal) throw();


        bool notifyLeave(SUMOVehicle& veh, SUMOReal lastPos, MSMoveReminder::Notification reason) throw();


    private:
        MSE3Collector& myCollector;

        SUMOReal myPosition;

    private:
        MSE3EntryReminder(const MSE3EntryReminder&);

        MSE3EntryReminder& operator=(const MSE3EntryReminder&);

    };



    class MSE3LeaveReminder : public MSMoveReminder {
    public:
        MSE3LeaveReminder(const MSCrossSection& crossSection, MSE3Collector& collector) throw();




        bool notifyMove(SUMOVehicle& veh, SUMOReal , SUMOReal newPos, SUMOReal) throw();


    private:
        MSE3Collector& myCollector;

        SUMOReal myPosition;

    private:
        MSE3LeaveReminder(const MSE3LeaveReminder&);

        MSE3LeaveReminder& operator=(const MSE3LeaveReminder&);

    };


    MSE3Collector(const std::string& id,
                  const CrossSectionVector& entries, const CrossSectionVector& exits,
                  SUMOReal haltingSpeedThreshold,
                  SUMOTime haltingTimeThreshold) throw();


    virtual ~MSE3Collector() throw();


    void reset() throw();


    void enter(SUMOVehicle& veh, SUMOReal entryTimestep) throw();


    void leave(SUMOVehicle& veh, SUMOReal leaveTimestep) throw();



    SUMOReal getCurrentMeanSpeed() const throw();


    SUMOReal getCurrentHaltingNumber() const throw();


    SUMOReal getVehiclesWithin() const throw();


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



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


    void writeXMLDetectorProlog(OutputDevice& dev) const throw(IOError);



    void detectorUpdate(const SUMOTime step) throw();


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;

    SUMOReal myHaltingSpeedThreshold;

    struct E3Values {
        SUMOReal entryTime;
        SUMOReal leaveTime;
        SUMOReal speedSum;
        unsigned haltings;
        SUMOReal haltingBegin;
        SUMOReal intervalSpeedSum;
        unsigned intervalHaltings;
        bool hadUpdate;
    };

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

    std::map<SUMOVehicle*, E3Values> myLeftContainer;



    SUMOReal myCurrentMeanSpeed;

    SUMOReal myCurrentHaltingsNumber;

    SUMOReal myCurrentTouchedVehicles;


    SUMOTime myLastResetTime;


private:
    MSE3Collector(const MSE3Collector&);

    MSE3Collector& operator=(const MSE3Collector&);


};


#endif

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