MSTrafficLightLogic.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
// Copyright (C) 2001-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
/****************************************************************************/
// The parent class for traffic light logics
/****************************************************************************/
#ifndef MSTrafficLightLogic_h
#define MSTrafficLightLogic_h


// ===========================================================================
// included modules
// ===========================================================================
#include <config.h>

#include <map>
#include <string>
#include <bitset>
#include <utils/common/Command.h>
#include <utils/common/Parameterised.h>
#include <microsim/MSLogicJunction.h>
#include <microsim/MSLink.h>
#include "MSPhaseDefinition.h"


// ===========================================================================
// class declarations
// ===========================================================================
class MSNet;
class MSLink;
class MSTLLogicControl;
class NLDetectorBuilder;


// ===========================================================================
// class definitions
// ===========================================================================
class MSTrafficLightLogic : public Named, public Parameterised {
public:

    typedef std::vector<MSPhaseDefinition*> Phases;

    typedef std::vector<MSLink*> LinkVector;

    typedef std::vector<LinkVector> LinkVectorVector;

    typedef std::vector<MSLane*> LaneVector;

    typedef std::vector<LaneVector> LaneVectorVector;


public:
    MSTrafficLightLogic(MSTLLogicControl& tlcontrol,
                        const std::string& id,
                        const std::string& programID,
                        SUMOTime delay,
                        const std::map<std::string, std::string>& parameters);


    virtual void init(NLDetectorBuilder& nb);


    virtual ~MSTrafficLightLogic();




    virtual void addLink(MSLink* link, MSLane* lane, int pos);


    virtual void adaptLinkInformationFrom(const MSTrafficLightLogic& logic);


    std::map<MSLink*, LinkState> collectLinkStates() const;


    void resetLinkStates(const std::map<MSLink*, LinkState>& vals) const;




    virtual SUMOTime trySwitch() = 0;


    bool setTrafficLightSignals(SUMOTime t) const;




    const std::string& getProgramID() const {
        return myProgramID;
    }


    const LaneVectorVector& getLaneVectors() const {
        return myLanes;
    }


    const LaneVector& getLanesAt(int i) const {
        if (i < (int)myLanes.size()) {
            return myLanes[i];
        } else {
            return myEmptyLaneVector;
        }
    }


    const LinkVectorVector& getLinks() const {
        return myLinks;
    }


    const LinkVector& getLinksAt(int i) const {
        return myLinks[i];
    }


    int getLinkIndex(const MSLink* const link) const;


    virtual int getPhaseNumber() const = 0;


    virtual const Phases& getPhases() const = 0;


    virtual const MSPhaseDefinition& getPhase(int givenstep) const = 0;

    virtual const std::string getLogicType() const = 0;




    virtual int getCurrentPhaseIndex() const = 0;


    virtual const MSPhaseDefinition& getCurrentPhaseDef() const = 0;


    SUMOTime getDefaultCycleTime() const {
        return myDefaultCycleTime;
    }


    SUMOTime getNextSwitchTime() const;


    SUMOTime getSpentDuration() const;




    virtual SUMOTime getPhaseIndexAtTime(SUMOTime simStep) const = 0;


    virtual SUMOTime getOffsetFromIndex(int index) const = 0;


    virtual int getIndexFromOffset(SUMOTime offset) const = 0;




    void addOverridingDuration(SUMOTime duration);


    void setCurrentDurationIncrement(SUMOTime delay);


    virtual void changeStepAndDuration(MSTLLogicControl& tlcontrol,
                                       SUMOTime simStep, int step, SUMOTime stepDuration) = 0;



protected:
    class SwitchCommand : public Command {
    public:
        SwitchCommand(MSTLLogicControl& tlcontrol,
                      MSTrafficLightLogic* tlLogic,
                      SUMOTime nextSwitch);

        ~SwitchCommand();

        SUMOTime execute(SUMOTime currentTime);


        void deschedule(MSTrafficLightLogic* tlLogic);


        SUMOTime getNextSwitchTime() const {
            return myAssumedNextSwitch;
        }


    private:
        MSTLLogicControl& myTLControl;

        MSTrafficLightLogic* myTLLogic;

        SUMOTime myAssumedNextSwitch;

        bool myAmValid;

    private:
        SwitchCommand(const SwitchCommand&);

        SwitchCommand& operator=(const SwitchCommand&);

    };


protected:
    std::string myProgramID;

    LinkVectorVector myLinks;

    LaneVectorVector myLanes;

    std::vector<SUMOTime> myOverridingTimes;

    SUMOTime myCurrentDurationIncrement;

    SwitchCommand* mySwitchCommand;

    SUMOTime myDefaultCycleTime;

    static const LaneVector myEmptyLaneVector;

private:
    void initMesoTLSPenalties();


private:
    MSTrafficLightLogic(const MSTrafficLightLogic& s);

    MSTrafficLightLogic& operator=(const MSTrafficLightLogic& s);

};


#endif

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