NLDetectorBuilder.h

Go to the documentation of this file.

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


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

#include <string>
#include <utils/common/PhysicalTypeDefs.h>
#include <microsim/MSNet.h>
#include <microsim/output/MSE2Collector.h>
#include <microsim/output/MSE3Collector.h>
#include <microsim/traffic_lights/MSTLLogicControl.h>

#ifdef _MESSAGES
#include <microsim/output/MSMsgInductLoop.h>
#endif


// ===========================================================================
// class declarations
// ===========================================================================
class MSInductLoop;
class MS_E2_ZS_CollectorOverLanes;
class MSTrafficLightLogic;
class MSDetectorControl;
class MSLane;

#ifdef HAVE_MESOSIM
class MEInductLoop;
class MESegment;
#endif


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


    virtual ~NLDetectorBuilder() throw();



#ifdef _MESSAGES

    void
    buildMsgDetector(const std::string &id,
                     const std::string &lane, SUMOReal pos, int splInterval,
                     const std::string &msg,
                     OutputDevice& device, bool friendlyPos) throw(InvalidArgument);
#endif

    void buildInductLoop(const std::string &id,
                         const std::string &lane, SUMOReal pos, int splInterval,
                         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,
                         MetersPerSecond 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,
                         MetersPerSecond 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,
                         MetersPerSecond haltingSpeedThreshold, SUMOReal jamDistThreshold,
                         bool friendlyPos) throw(InvalidArgument);


    void beginE3Detector(const std::string &id, OutputDevice& device, int splInterval,
                         MetersPerSecond 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 throw();


    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);




#ifdef _MESSAGES

    virtual MSMsgInductLoop *createMsgInductLoop(const std::string &id, const std::string &msg,
            MSLane *lane, SUMOReal pos) throw();
#endif

    virtual MSInductLoop *createInductLoop(const std::string &id,
                                           MSLane *lane, SUMOReal pos) throw();


#ifdef HAVE_MESOSIM

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


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


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


    virtual MSE3Collector *createE3Detector(const std::string &id,
                                            const CrossSectionVector &entries, const CrossSectionVector &exits,
                                            MetersPerSecond haltingSpeedThreshold, SUMOTime haltingTimeThreshold) throw();


    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);



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


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




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

        ~E3DetectorDefinition() throw();

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

    private:
        E3DetectorDefinition(const E3DetectorDefinition&);

        E3DetectorDefinition& operator=(const E3DetectorDefinition&);

    };


protected:
    MSLane *getLaneChecking(const std::string &id,
                            const std::string &detid) throw(InvalidArgument);


    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);


protected:
    MSNet &myNet;


private:
    E3DetectorDefinition *myE3Definition;


private:
    NLDetectorBuilder(const NLDetectorBuilder&);

    NLDetectorBuilder& operator=(const NLDetectorBuilder&);

};


#endif

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