NGNode.h

Go to the documentation of this file.

/****************************************************************************/
// A netgen-representation of a node
/****************************************************************************/
// 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 NGNode_h
#define NGNode_h


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

#include <list>
#include <utils/geom/Position2D.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:
    NGNode() throw();


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


    NGNode(const std::string &id, int xPos, int yPos) throw();


    NGNode(const std::string &id, int xID, int yID, bool amCenter) throw();


    ~NGNode() throw();


    const std::string &getID() const throw() {
        return myID;
    }


    const Position2D &getPosition() const throw() {
        return myPosition;
    }


    SUMOReal getMaxNeighbours() throw() {
        return myMaxNeighbours;
    }


    void setMaxNeighbours(SUMOReal value) throw() {
        myMaxNeighbours = value;
    }


    void setX(SUMOReal x) throw() {
        myPosition.set(x, myPosition.y());
    }


    void setY(SUMOReal y) throw() {
        myPosition.set(myPosition.x(), y);
    }


    NBNode *buildNBNode(NBNetBuilder &nb) const throw(ProcessError);


    void addLink(NGEdge *link) throw();


    void removeLink(NGEdge *link) throw();


    bool connected(NGNode *node) const throw();


    bool samePos(int xPos, int yPos) const throw() {
        return xID==xPos && yID==yPos;
    }

    // NGRandomNetBuilder needs access to links
    friend class NGRandomNetBuilder;

private:
    int xID;

    int yID;

    NGEdgeList LinkList;

    std::string myID;

    Position2D myPosition;

    SUMOReal myMaxNeighbours;

    bool myAmCenter;

};

typedef std::list<NGNode*> NGNodeList;



#endif

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