MSTrafficLightLogic.h

Go to the documentation of this file.

/****************************************************************************/
// The parent class for traffic light logics
/****************************************************************************/
// 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 MSTrafficLightLogic_h
#define MSTrafficLightLogic_h


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

#include <map>
#include <string>
#include <bitset>
#include <utils/common/Command.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:

    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 &subid, SUMOTime delay) throw();


    virtual void init(NLDetectorBuilder &nb) throw(ProcessError);


    virtual ~MSTrafficLightLogic() throw();




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


    virtual void adaptLinkInformationFrom(const MSTrafficLightLogic &logic) throw();


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


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




    virtual SUMOTime trySwitch(bool isActive) throw() = 0;


    virtual void setLinkPriorities() const throw() = 0;


    virtual bool setTrafficLightSignals() const throw() = 0;




    const std::string &getID() const throw() {
        return myID;
    }


    const std::string &getSubID() const throw() {
        return mySubID;
    }


    const LaneVectorVector &getLanes() const throw() {
        return myLanes;
    }


    const LaneVector &getLanesAt(unsigned int i) const throw() {
        return myLanes[i];
    }


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


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


    int getLinkIndex(const MSLink * const link) const throw();


    virtual unsigned int getPhaseNumber() const throw() = 0;


    virtual const Phases &getPhases() const throw() = 0;


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




    virtual unsigned int getCurrentPhaseIndex() const throw() = 0;


    virtual const MSPhaseDefinition &getCurrentPhaseDef() const throw() = 0;


    unsigned int getDefaultCycleTime() const throw() {
        return myDefaultCycleTime;
    }


    SUMOTime getNextSwitchTime() const throw();




    virtual unsigned int getPhaseIndexAtTime(SUMOTime simStep) const throw() = 0;


    virtual unsigned int getOffsetFromIndex(unsigned int index) const throw() = 0;


    virtual unsigned int getIndexFromOffset(unsigned int offset) const throw() = 0;




    void addOverridingDuration(SUMOTime duration) throw();


    void setCurrentDurationIncrement(SUMOTime delay) throw();


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





    void setParameter(const std::map<std::string, std::string> &params) throw();


    std::string getParameterValue(const std::string &key) const throw();


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

        ~SwitchCommand() throw();

        SUMOTime execute(SUMOTime currentTime) throw(ProcessError);


        void deschedule(MSTrafficLightLogic *tlLogic) throw();


        SUMOTime getNextSwitchTime() const throw() {
            return myAssumedNextSwitch;
        }


    private:
        MSTLLogicControl &myTLControl;

        MSTrafficLightLogic *myTLLogic;

        SUMOTime myAssumedNextSwitch;

        bool myAmValid;

    private:
        SwitchCommand(const SwitchCommand&);

        SwitchCommand& operator=(const SwitchCommand&);

    };

protected:
    std::map<std::string, std::string> myParameter;

    std::string myID, mySubID;

    LinkVectorVector myLinks;

    LaneVectorVector myLanes;

    std::vector<SUMOTime> myOverridingTimes;

    SUMOTime myCurrentDurationIncrement;

    SwitchCommand *mySwitchCommand;

    unsigned int myDefaultCycleTime;


private:
    MSTrafficLightLogic(const MSTrafficLightLogic &s);

    MSTrafficLightLogic& operator=(const MSTrafficLightLogic &s);

};


#endif

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