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.sourceforge.net/
// Copyright (C) 2001-2011 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 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>


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


// ===========================================================================
// class definitions
// ===========================================================================
class NBTrafficLightLogic : public Named {
public:
    class PhaseDefinition {
    public:
        SUMOTime duration;

        std::string state;

        PhaseDefinition(SUMOTime durationArg, const std::string& stateArg) throw()
            : duration(durationArg), state(stateArg) { }

        ~PhaseDefinition() throw() { }

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

    };


    NBTrafficLightLogic(const std::string& id, const std::string& subid, unsigned int noLinks) throw();


    NBTrafficLightLogic(const NBTrafficLightLogic* logic);


    ~NBTrafficLightLogic() throw();


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


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

    void setPhaseDuration(unsigned int phaseIndex, SUMOTime duration);

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

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

    void closeBuilding() throw();


    SUMOTime getDuration() const throw();


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


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


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


    SUMOTime getOffset() const {
        return myOffset;
    };


    unsigned int getNumLinks() {
        return myNumLinks;
    }


private:
    unsigned int myNumLinks;

    const std::string mySubID;

    SUMOTime myOffset;

    typedef std::vector<PhaseDefinition> PhaseDefinitionVector;

    PhaseDefinitionVector myPhases;

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


};


#endif

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