NGNode.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
/****************************************************************************/
// A netgen-representation of a node
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <list>
#include <utils/common/Named.h>
#include <utils/geom/Position.h>
#include <utils/geom/GeomHelper.h>
#include <utils/common/UtilExceptions.h>
#include "NGEdge.h"
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class NBNode;
class NBEdge;
class NBNetBuilder;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class NGNode : public Named {
public:
    NGNode(const std::string& id);
 
 
    NGNode(const std::string& id, int xPos, int yPos);
 
 
    NGNode(const std::string& id, int xID, int yID, bool amCenter);
 
 
    ~NGNode();
 
 
    const Position& getPosition() const {
        return myPosition;
    }
 
 
    int getMaxNeighbours() {
        return myMaxNeighbours;
    }
 
 
    void setMaxNeighbours(int value) {
        myMaxNeighbours = value;
    }
 
 
    void setX(double x) {
        myPosition.set(x, myPosition.y());
    }
 
 
    void setY(double y) {
        myPosition.set(myPosition.x(), y);
    }
 
    void setFringe() {
        myAmFringe = true;
    }
 
    NBNode* buildNBNode(NBNetBuilder& nb, const Position& perturb) const;
 
 
    void addLink(NGEdge* link);
 
 
    void removeLink(NGEdge* link);
 
 
    const NGEdgeList& getLinks() const {
        return myLinkList;
    }
 
    bool connected(const NGNode* const node, const bool withDir = false) const;
 
 
    bool samePos(int xPos, int yPos) const {
        return myXID == xPos && myYID == yPos;
    }
 
private:
    int myXID;
 
    int myYID;
 
    NGEdgeList myLinkList;
 
    Position myPosition;
 
    int myMaxNeighbours;
 
    bool myAmCenter;
 
    bool myAmFringe;
 
};
 
typedef std::list<NGNode*> NGNodeList;