GNEJunction.h

Go to the documentation of this file.

/****************************************************************************/
// A class for visualizing and editing junctions in netedit (adapted from
// GUIJunctionWrapper)
/****************************************************************************/
// 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 GNEJunction_h
#define GNEJunction_h


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

#include "GNENetElement.h"

// ===========================================================================
// class declarations
// ===========================================================================
class GNENet;
class GNEEdge;
class GNECrossing;
class NBTrafficLightDefinition;

// ===========================================================================
// class definitions
// ===========================================================================
class GNEJunction : public GNENetElement {

    friend class GNEChange_TLS;
    friend class GNEChange_Crossing;

public:
    GNEJunction(NBNode& nbn, GNENet* net, bool loaded = false);

    virtual ~GNEJunction();


    GUIGLObjectPopupMenu* getPopUpMenu(GUIMainWindow& app, GUISUMOAbstractView& parent);

    GUIParameterTableWindow* getParameterWindow(GUIMainWindow& app, GUISUMOAbstractView& parent);

    Boundary getCenteringBoundary() const;

    void drawGL(const GUIVisualizationSettings& s) const;

    Boundary getBoundary() const;

    NBNode* getNBNode() const;

    void addIncomingGNEEdge(GNEEdge* edge);

    void addOutgoingGNEEdge(GNEEdge* edge);

    void removeIncomingGNEEdge(GNEEdge* edge);

    void removeOutgoingGNEEdge(GNEEdge* edge);

    const std::vector<GNEEdge*>& getGNEEdges() const;

    const std::vector<GNEEdge*>& getGNEIncomingEdges() const;

    const std::vector<GNEEdge*>& getGNEOutgoingEdges() const;

    const std::vector<GNECrossing*>& getGNECrossings() const;

    void markAsCreateEdgeSource();

    void unMarkAsCreateEdgeSource();

    void selectTLS(bool selected);

    void updateGeometry();

    void move(Position pos);

    void registerMove(GNEUndoList* undoList);

    void updateShapesAndGeometries();

    /* @brief method for getting the Attribute of an XML key
     * @param[in] key The attribute key
     * @return string with the value associated to key
     */
    std::string getAttribute(SumoXMLAttr key) const;

    /* @brief method for setting the attribute and letting the object perform additional changes
     * @param[in] key The attribute key
     * @param[in] value The new value
     * @param[in] undoList The undoList on which to register changes
     */
    void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);

    /* @brief method for checking if the key and their correspond attribute are valids
     * @param[in] key The attribute key
     * @param[in] value The value asociated to key key
     * @return true if the value is valid, false in other case
     */
    bool isValid(SumoXMLAttr key, const std::string& value);

    void setResponsible(bool newVal);

    /* @brief notify junction that one of its edges has changed its shape, and
     * therefore the junction shape is no longer valid */
    void invalidateShape();

    /* @brief update validity of this junctions logic
     * if the logic is invalidated, existing connections are removed via undo-list
     * so that the previous state can be restored
     * also calls invalidateTLS
     * @param[in] valid The new validity of the junction
     * @note: this should always be called with an active command group */
    void setLogicValid(bool valid, GNEUndoList* undoList = 0, const std::string& status = GUESSED);

    void markAsModified(GNEUndoList* undoList);

    /* @brief invalidates loaded or edited TLS
     * @param[in] deletedConnection If a valid connection is given a replacement def with this connection removed
     *   but all other information intact will be computed instead of guessing a new tlDef
     * @note: this should always be called with an active command group */
    void invalidateTLS(GNEUndoList* undoList, const NBConnection& deletedConnection = NBConnection::InvalidConnection);

    void removeFromCrossings(GNEEdge* edge, GNEUndoList* undoList);

    bool isLogicValid();

    void dropGNECrossings();

private:
    NBNode& myNBNode;

    std::vector<GNEEdge*> myGNEEdges;

    std::vector<GNEEdge*> myGNEIncomingEdges;

    std::vector<GNEEdge*> myGNEOutgoingEdges;

    Position myOrigPos;

    SUMOReal myMaxSize;

    Boundary myBoundary;

    bool myAmCreateEdgeSource;

    std::string myLogicStatus;

    bool myAmResponsible;

    bool myHasValidLogic;

    bool myAmTLSSelected;

    std::vector<GNECrossing*> myGNECrossings;

private:
    GNEJunction(const GNEJunction&);

    GNEJunction& operator=(const GNEJunction&);

    void setAttribute(SumoXMLAttr key, const std::string& value);

    void setPosition(Position pos);

    void setColor(const GUIVisualizationSettings& s, bool bubble) const;

    SUMOReal getColorValue(const GUIVisualizationSettings& s, bool bubble) const;

    void addTrafficLight(NBTrafficLightDefinition* tlDef, bool forceInsert);

    void removeTrafficLight(NBTrafficLightDefinition* tlDef);

    void rebuildGNECrossings();
};


#endif

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