NLDetectorBuilder.h

Go to the documentation of this file.

/****************************************************************************/
// Builds detectors for microsim
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
// Copyright (C) 2001-2012 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 NLDetectorBuilder_h
#define NLDetectorBuilder_h


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

#include <string>
#include <microsim/MSNet.h>
#include <microsim/traffic_lights/MSTLLogicControl.h>
#include <microsim/output/MSE3Collector.h>


// ===========================================================================
// class declarations
// ===========================================================================
class MSDetectorFileOutput;
class MSLane;
class MSEdge;

#ifdef HAVE_MESOSIM
class MEInductLoop;
class MESegment;
#endif


// ===========================================================================
// class definitions
// ===========================================================================
class NLDetectorBuilder {
public:
    NLDetectorBuilder(MSNet& net) ;


    virtual ~NLDetectorBuilder() ;



    void buildInductLoop(const std::string& id,
                         const std::string& lane, SUMOReal pos, int splInterval,
                         OutputDevice& device, bool friendlyPos, bool splitByType) throw(InvalidArgument);


    void buildInstantInductLoop(const std::string& id,
                                const std::string& lane, SUMOReal pos,
                                OutputDevice& device, bool friendlyPos) throw(InvalidArgument);


    void buildE2Detector(const std::string& id, const std::string& lane, SUMOReal pos, SUMOReal length,
                         bool cont, int splInterval, OutputDevice& device, SUMOTime haltingTimeThreshold,
                         SUMOReal haltingSpeedThreshold, SUMOReal jamDistThreshold,
                         bool friendlyPos) throw(InvalidArgument);


    void buildE2Detector(const std::string& id, const std::string& lane, SUMOReal pos, SUMOReal length,
                         bool cont, MSTLLogicControl::TLSLogicVariants& tlls,
                         OutputDevice& device, SUMOTime haltingTimeThreshold,
                         SUMOReal haltingSpeedThreshold, SUMOReal jamDistThreshold,
                         bool friendlyPos) throw(InvalidArgument);


    void buildE2Detector(const std::string& id, const std::string& lane, SUMOReal pos, SUMOReal length,
                         bool cont, MSTLLogicControl::TLSLogicVariants& tlls, const std::string& tolane,
                         OutputDevice& device, SUMOTime haltingTimeThreshold,
                         SUMOReal haltingSpeedThreshold, SUMOReal jamDistThreshold,
                         bool friendlyPos) throw(InvalidArgument);


    void beginE3Detector(const std::string& id, OutputDevice& device, int splInterval,
                         SUMOReal haltingSpeedThreshold, SUMOTime haltingTimeThreshold) throw(InvalidArgument);


    void addE3Entry(const std::string& lane, SUMOReal pos, bool friendlyPos) throw(InvalidArgument);


    void addE3Exit(const std::string& lane, SUMOReal pos, bool friendlyPos) throw(InvalidArgument);


    void endE3Detector() throw(InvalidArgument);


    std::string getCurrentE3ID() const ;


    void buildVTypeProbe(const std::string& id,
                         const std::string& vtype, SUMOTime frequency,
                         OutputDevice& device) throw(InvalidArgument);


    void buildRouteProbe(const std::string& id, const std::string& edge,
                         SUMOTime frequency, SUMOTime begin,
                         OutputDevice& device) throw(InvalidArgument);




    virtual MSDetectorFileOutput* createInductLoop(const std::string& id,
            MSLane* lane, SUMOReal pos, bool splitByType) ;


    virtual MSDetectorFileOutput* createInstantInductLoop(const std::string& id,
            MSLane* lane, SUMOReal pos, OutputDevice& od) ;

#ifdef HAVE_MESOSIM

    virtual MEInductLoop* createMEInductLoop(const std::string& id,
            MESegment* s, SUMOReal pos) ;
#endif


    virtual MSDetectorFileOutput* createSingleLaneE2Detector(const std::string& id,
            DetectorUsage usage, MSLane* lane, SUMOReal pos, SUMOReal length,
            SUMOTime haltingTimeThreshold,
            SUMOReal haltingSpeedThreshold,
            SUMOReal jamDistThreshold) ;


    virtual MSDetectorFileOutput* createMultiLaneE2Detector(
        const std::string& id, DetectorUsage usage, MSLane* lane, SUMOReal pos,
        SUMOTime haltingTimeThreshold, SUMOReal haltingSpeedThreshold,
        SUMOReal jamDistThreshold) ;


    virtual MSDetectorFileOutput* createE3Detector(const std::string& id,
            const CrossSectionVector& entries, const CrossSectionVector& exits,
            SUMOReal haltingSpeedThreshold, SUMOTime haltingTimeThreshold) ;


    void createEdgeLaneMeanData(const std::string& id, SUMOTime frequency,
                                SUMOTime begin, SUMOTime end, const std::string& type,
                                const bool useLanes, const bool withEmpty, const bool withInternal, const bool trackVehicles,
                                const SUMOReal maxTravelTime, const SUMOReal minSamples,
                                const SUMOReal haltSpeed, const std::string& vTypes,
                                OutputDevice& device) throw(InvalidArgument);



    MSDetectorFileOutput* buildSingleLaneE2Det(const std::string& id,
            DetectorUsage usage, MSLane* lane, SUMOReal pos, SUMOReal length,
            SUMOTime haltingTimeThreshold, SUMOReal haltingSpeedThreshold,
            SUMOReal jamDistThreshold) ;


    MSDetectorFileOutput* buildMultiLaneE2Det(const std::string& id, DetectorUsage usage, MSLane* lane, SUMOReal pos, SUMOReal length,
            SUMOTime haltingTimeThreshold, SUMOReal haltingSpeedThreshold,
            SUMOReal jamDistThreshold) ;




protected:
    class E3DetectorDefinition {
    public:
        E3DetectorDefinition(const std::string& id,
                             OutputDevice& device, SUMOReal haltingSpeedThreshold,
                             SUMOTime haltingTimeThreshold, int splInterval) ;

        ~E3DetectorDefinition() ;

        std::string myID;
        OutputDevice& myDevice;
        SUMOReal myHaltingSpeedThreshold;
        SUMOTime myHaltingTimeThreshold;
        CrossSectionVector myEntries;
        CrossSectionVector myExits;
        int mySampleInterval;

    private:
        E3DetectorDefinition(const E3DetectorDefinition&);

        E3DetectorDefinition& operator=(const E3DetectorDefinition&);

    };


protected:
    SUMOReal getPositionChecking(SUMOReal pos, MSLane* lane, bool friendlyPos,
                                 const std::string& detid) throw(InvalidArgument);


    void convUncontE2PosLength(const std::string& id, MSLane* clane,
                               SUMOReal& pos, SUMOReal& length, bool frinedly_pos) throw(InvalidArgument);


    void convContE2PosLength(const std::string& id, MSLane* clane,
                             SUMOReal& pos, SUMOReal& length, bool frinedly_pos) throw(InvalidArgument);




    MSEdge* getEdgeChecking(const std::string& edgeID, SumoXMLTag type,
                            const std::string& detid) throw(InvalidArgument);


    MSLane* getLaneChecking(const std::string& laneID, SumoXMLTag type,
                            const std::string& detid) throw(InvalidArgument);


    void checkSampleInterval(int splInterval, SumoXMLTag type, const std::string& id) throw(InvalidArgument);


protected:
    MSNet& myNet;


private:
    E3DetectorDefinition* myE3Definition;


private:
    NLDetectorBuilder(const NLDetectorBuilder&);

    NLDetectorBuilder& operator=(const NLDetectorBuilder&);

};


#endif

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