NBTrafficLightLogic.h

Go to the documentation of this file.

/****************************************************************************/
// A SUMO-compliant built logic for a traffic light
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.dlr.de/
// Copyright (C) 2001-2017 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 NBTrafficLightLogic_h
#define NBTrafficLightLogic_h


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

#include <vector>
#include <string>
#include <bitset>
#include <utility>
#include <set>
#include "NBConnectionDefs.h"
#include <utils/common/SUMOTime.h>
#include <utils/common/Named.h>
#include <utils/common/Parameterised.h>


// ===========================================================================
// class declarations
// ===========================================================================
class OutputDevice;


// ===========================================================================
// class definitions
// ===========================================================================
class NBTrafficLightLogic : public Named, public Parameterised {
public:
    class PhaseDefinition {
    public:
        SUMOTime duration;
        SUMOTime minDur;
        SUMOTime maxDur;

        std::string state;

        PhaseDefinition(SUMOTime durationArg, const std::string& stateArg, SUMOTime minDurArg, SUMOTime maxDurArg) :
            duration(durationArg),
            minDur(minDurArg),
            maxDur(maxDurArg),
            state(stateArg) { }

        ~PhaseDefinition() { }

        bool operator!=(const PhaseDefinition& pd) const {
            return pd.duration != duration || pd.state != state;
        }

    };


    NBTrafficLightLogic(const std::string& id, const std::string& subid, int noLinks,
                        SUMOTime offset = 0, TrafficLightType type = TLTYPE_STATIC);


    NBTrafficLightLogic(const NBTrafficLightLogic* logic);


    ~NBTrafficLightLogic();


    void addStep(SUMOTime duration, const std::string& state, int index = -1);
    void addStep(SUMOTime duration, const std::string& state, SUMOTime minDur, SUMOTime maxDur, int index = -1);


    void setPhaseState(int phaseIndex, int tlIndex, LinkState linkState);

    void setPhaseDuration(int phaseIndex, SUMOTime duration);
    void setPhaseMinDuration(int phaseIndex, SUMOTime duration);
    void setPhaseMaxDuration(int phaseIndex, SUMOTime duration);

    /* @brief deletes the phase at the given index
     * @note thhrows InvalidArgument on out-of range index
    */
    void deletePhase(int index);

    /* @brief deletes all phases and reset the expect number of links
    */
    void resetPhases();

    void closeBuilding(bool checkVarDurations = true);


    SUMOTime getDuration() const;


    void setOffset(SUMOTime offset) {
        myOffset = offset;
    }


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


    const std::vector<PhaseDefinition>& getPhases() const {
        return myPhases;
    }


    SUMOTime getOffset() const {
        return myOffset;
    };


    int getNumLinks() {
        return myNumLinks;
    }

    TrafficLightType getType() const {
        return myType;
    }

    void setType(TrafficLightType type) {
        myType = type;
    }

private:
    int myNumLinks;

    const std::string mySubID;

    SUMOTime myOffset;

    typedef std::vector<PhaseDefinition> PhaseDefinitionVector;

    PhaseDefinitionVector myPhases;

    TrafficLightType myType;

    static const char allowedStatesInitializer[];
    static const std::string ALLOWED_STATES;

private:
    NBTrafficLightLogic& operator=(const NBTrafficLightLogic& s);

};


#endif

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