NBConnection.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2024 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// The class holds a description of a connection between two edges
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include "NBEdge.h"
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class NBNode;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class NBConnection {
public:
    NBConnection(NBEdge* from, NBEdge* to);
 
    NBConnection(NBEdge* from, int fromLane, NBEdge* to, int toLane, int tlIndex = InvalidTlIndex, int tlIndex2 = InvalidTlIndex);
 
    NBConnection(const std::string& fromID, NBEdge* from,
                 const std::string& toID, NBEdge* to);
 
    NBConnection(const NBConnection& c);
 
    virtual ~NBConnection();
 
    NBEdge* getFrom() const;
 
    NBEdge* getTo() const;
 
    bool replaceFrom(NBEdge* which, NBEdge* by);
 
    bool replaceFrom(NBEdge* which, int whichLane, NBEdge* by, int byLane);
 
    bool replaceTo(NBEdge* which, NBEdge* by);
 
    bool replaceTo(NBEdge* which, int whichLane, NBEdge* by, int byLane);
 
    void shiftLaneIndex(NBEdge* edge, int offset, int threshold = -1);
 
    bool check(const NBEdgeCont& ec);
 
    int getFromLane() const;
 
    int getToLane() const;
 
    int getTLIndex() const {
        return myTlIndex;
    }
    int getTLIndex2() const {
        return myTlIndex2;
    }
 
    // @brief reset the tlIndex
    void setTLIndex(int tlIndex) {
        myTlIndex = tlIndex;
    }
    void setTLIndex2(int tlIndex) {
        myTlIndex2 = tlIndex;
    }
 
    std::string getID() const;
 
    friend bool operator<(const NBConnection& c1, const NBConnection& c2);
 
    bool operator==(const NBConnection& c) const;
 
    bool operator!=(const NBConnection& c) const {
        return !(*this == c);
    }
 
    friend std::ostream& operator<<(std::ostream& os, const NBConnection& c);
 
    const static int InvalidTlIndex;
    const static NBConnection InvalidConnection;
 
private:
    NBEdge* checkFrom(const NBEdgeCont& ec);
 
    NBEdge* checkTo(const NBEdgeCont& ec);
 
private:
    NBEdge* myFrom, *myTo;
 
    std::string myFromID, myToID;
 
    int myFromLane, myToLane;
 
    // @brief the index within the controlling tls if this connection is tls-controlled
    int myTlIndex;
    int myTlIndex2;
};