NBTrafficLightDefinition.h

Go to the documentation of this file.

/****************************************************************************/
// The base class for traffic light logic definitions
/****************************************************************************/
// 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 NBTrafficLightDefinition_h
#define NBTrafficLightDefinition_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 <utils/common/Named.h>
#include <utils/common/VectorHelper.h>
#include <utils/common/SUMOTime.h>
#include <utils/common/UtilExceptions.h>
#include "NBCont.h"
#include "NBConnection.h"
#include "NBConnectionDefs.h"
#include "NBLinkPossibilityMatrix.h"


// ===========================================================================
// class declarations
// ===========================================================================
class NBNode;
class OptionsCont;
class NBTrafficLightLogic;


// ===========================================================================
// class definitions
// ===========================================================================
class NBTrafficLightDefinition : public Named {
public:
    enum TLColor {
        TLCOLOR_RED,
        TLCOLOR_YELLOW,
        TLCOLOR_REDYELLOW,
        TLCOLOR_GREEN,
        TLCOLOR_BLINK
    };


    NBTrafficLightDefinition(const std::string &id,
                             const std::vector<NBNode*> &junctions) throw();


    NBTrafficLightDefinition(const std::string &id,
                             NBNode *junction) throw();


    NBTrafficLightDefinition(const std::string &id) throw();


    virtual ~NBTrafficLightDefinition() throw();


    NBTrafficLightLogic *compute(const NBEdgeCont &ec, OptionsCont &oc) throw();




    void addNode(NBNode *node) throw();


    void removeNode(NBNode *node) throw();


    const std::vector<NBNode*> &getNodes() const throw() {
        return myControlledNodes;
    }


    bool mustBrake(const NBEdge * const from, const NBEdge * const to) const throw();


    bool mustBrake(const NBConnection &possProhibited,
                   const NBConnection &possProhibitor,
                   bool regardNonSignalisedLowerPriority) const throw();

    bool mustBrake(const NBEdge * const possProhibitedFrom, const NBEdge * const possProhibitedTo,
                   const NBEdge * const possProhibitorFrom, const NBEdge * const possProhibitorTo,
                   bool regardNonSignalisedLowerPriority) const throw();


    bool forbids(const NBEdge * const possProhibitorFrom, const NBEdge * const possProhibitorTo,
                 const NBEdge * const possProhibitedFrom, const NBEdge * const possProhibitedTo,
                 bool regardNonSignalisedLowerPriority) const throw();


    bool foes(const NBEdge * const from1, const NBEdge * const to1,
              const NBEdge * const from2, const NBEdge * const to2) const throw();


    virtual void setTLControllingInformation(const NBEdgeCont &ec) const throw() = 0;


    virtual void setParticipantsInformation() throw();


    void addControlledInnerEdges(const std::vector<std::string> &edges) throw();


    virtual void remapRemoved(NBEdge *removed,
                              const EdgeVector &incoming, const EdgeVector &outgoing) throw() = 0;


    virtual void replaceRemoved(NBEdge *removed, int removedLane,
                                NBEdge *by, int byLane) throw() = 0;


    bool isLeftMover(const NBEdge * const from, const NBEdge * const to) const throw();


    const EdgeVector &getIncomingEdges() const throw();


protected:
    virtual NBTrafficLightLogic *myCompute(const NBEdgeCont &ec,
                                           unsigned int brakingTime) throw() = 0;


    std::pair<unsigned int, unsigned int> getSizes() const throw();


    virtual void collectLinks() throw(ProcessError);


    void collectEdges() throw();


    unsigned int computeBrakingTime(SUMOReal minDecel) const throw();


protected:
    std::vector<NBNode*> myControlledNodes;

    EdgeVector myIncomingEdges;

    EdgeVector myEdgesWithin;

    NBConnectionVector myControlledLinks;

    std::vector<std::string> myControlledInnerEdges;


};


#endif

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