MSInductLoop.h

Go to the documentation of this file.

/****************************************************************************/
// An unextended detector measuring at a fixed position on a fixed lane.
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo-sim.org/
// Copyright (C) 2001-2013 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This file is part of SUMO.
//   SUMO 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 3 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef MSInductLoop_h
#define MSInductLoop_h


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

#include <string>
#include <deque>
#include <map>
#include <functional>
#include <microsim/MSMoveReminder.h>
#include <microsim/output/MSDetectorFileOutput.h>


// ===========================================================================
// class declarations
// ===========================================================================
class MSLane;
class MSVehicle;
class OutputDevice;


// ===========================================================================
// class definitions
// ===========================================================================
class MSInductLoop
        : public MSMoveReminder, public MSDetectorFileOutput {
public:
    MSInductLoop(const std::string& id, MSLane* const lane,
                 SUMOReal positionInMeters, bool splitByType);


    ~MSInductLoop();


    virtual void reset();


    SUMOReal getPosition() const {
        return myPosition;
    }



    bool notifyMove(SUMOVehicle& veh, SUMOReal oldPos, SUMOReal newPos, SUMOReal newSpeed);


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






    SUMOReal getCurrentSpeed() const;


    SUMOReal getCurrentLength() const;


    SUMOReal getCurrentOccupancy() const;


    unsigned int getCurrentPassedNumber() const;


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


    SUMOReal getTimestepsSinceLastDetection() const;




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


    void writeXMLDetectorProlog(OutputDevice& dev) const;



    struct VehicleData {
        VehicleData(const std::string& id, SUMOReal vehLength, SUMOReal entryTimestep, SUMOReal leaveTimestep,
                    const std::string& typeID)
            : idM(id), lengthM(vehLength), entryTimeM(entryTimestep), leaveTimeM(leaveTimestep),
              speedM(lengthM / ((leaveTimeM - entryTimeM))), typeIDM(typeID) {}

        std::string idM;
        SUMOReal lengthM;
        SUMOReal entryTimeM;
        SUMOReal leaveTimeM;
        SUMOReal speedM;
        std::string typeIDM;
    };


    virtual std::vector<VehicleData> collectVehiclesOnDet(SUMOTime t) const;


protected:

    virtual void enterDetectorByMove(SUMOVehicle& veh, SUMOReal entryTimestep);


    virtual void leaveDetectorByMove(SUMOVehicle& veh, SUMOReal leaveTimestep);


    virtual void leaveDetectorByLaneChange(SUMOVehicle& veh, SUMOReal lastPos);


protected:

    static inline SUMOReal speedSum(SUMOReal sumSoFar, const MSInductLoop::VehicleData& data) {
        return sumSoFar + data.speedM;
    }

    static inline SUMOReal lengthSum(SUMOReal sumSoFar, const MSInductLoop::VehicleData& data) {
        return sumSoFar + data.lengthM;
    }


protected:
    const SUMOReal myPosition;

    bool mySplitByType;

    SUMOReal myLastLeaveTime;

    SUMOReal myLastOccupancy;

    unsigned myDismissedVehicleNumber;


    typedef std::deque< VehicleData > VehicleDataCont;

    VehicleDataCont myVehicleDataCont;

    VehicleDataCont myLastVehicleDataCont;


    typedef std::map< SUMOVehicle*, SUMOReal > VehicleMap;

    VehicleMap myVehiclesOnDet;

    void writeTypedXMLOutput(OutputDevice& dev, SUMOTime startTime, SUMOTime stopTime,
                             const std::string& type, const VehicleDataCont& vdc, const VehicleMap& vm);

private:
    MSInductLoop(const MSInductLoop&);

    MSInductLoop& operator=(const MSInductLoop&);


};


#endif

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