NGEdge Class Reference

#include <NGEdge.h>

---

Detailed Description

A netgen-representation of an edge.

Please note that the edge makes itself known to the from- and the to-nodes on initialisation and removes this information from the nodes when being deleted. This implicates that nodes have to be deleted after the edges.

Definition at line 58 of file NGEdge.h.

Public Member Functions
NBEdge *	buildNBEdge (NBNetBuilder &nb) const throw (ProcessError)
	Builds and returns this link's netbuild-representation.
NGNode *	getEndNode () throw ()
	Returns this link's end node.
const std::string &	getID () const throw ()
	Returns this link's id.
NGNode *	getStartNode () throw ()
	Returns this link's start node.
	NGEdge (const std::string &id, NGNode *startNode, NGNode *endNode) throw ()
	Constructor.
	~NGEdge () throw ()
	Destructor.
Private Attributes
NGNode *	myEndNode
	The node the edge ends at.
std::string	myID
	The id of the edge.
NGNode *	myStartNode
	The node the edge starts at.

---

Constructor & Destructor Documentation

NGEdge::NGEdge	(	const std::string &	id,
		NGNode *	startNode,
		NGNode *	endNode
	)			throw ()

Constructor.

Adds itself to the start and the end node's lists of connections.

Parameters:

[in]	id	The id of the link
[in]	StarNGNode	The begin node
[in]	EndNode	The end node

Definition at line 57 of file NGEdge.cpp.

        : myID(id), myStartNode(startNode), myEndNode(endNode) {
    myStartNode->addLink(this);
    myEndNode->addLink(this);
}

NGEdge::~NGEdge

(

)

throw ()

Destructor.

Removes itself from the start and the end node's lists of connections.

Definition at line 64 of file NGEdge.cpp.

References myEndNode, myStartNode, and NGNode::removeLink().

                        {
    myStartNode->removeLink(this);
    myEndNode->removeLink(this);
}

---

Member Function Documentation

NBEdge * NGEdge::buildNBEdge

(

NBNetBuilder &

nb

)

const throw (ProcessError)

Builds and returns this link's netbuild-representation.

Returns an edge built using the known values. Other values, such as the number of lanes, are gathered from defaults. The starting and the ending node must have been built in prior.

Parameters:

[in]

nb

The netbuilder to retrieve the referenced nodes from

Returns:

The built edge

Definition at line 71 of file NGEdge.cpp.

References NGNode::getID(), myEndNode, myID, and myStartNode.

                                                              {
    return new NBEdge(
               myID, // id
               nb.getNodeCont().retrieve(myStartNode->getID()), // from
               nb.getNodeCont().retrieve(myEndNode->getID()), // to
               "netgen-default", // type
               nb.getTypeCont().getDefaultSpeed(),
               nb.getTypeCont().getDefaultNoLanes(),
               nb.getTypeCont().getDefaultPriority()
           );
}

NGNode* NGEdge::getEndNode

(

)

throw () [inline]

Returns this link's end node.

Returns:

The end node of the link

Definition at line 100 of file NGEdge.h.

References myEndNode.

                                 {
        return myEndNode;
    };

const std::string& NGEdge::getID

(

)

const throw () [inline]

Returns this link's id.

Returns:

The id of the link

Definition at line 82 of file NGEdge.h.

References myID.

                                           {
        return myID;
    }

NGNode* NGEdge::getStartNode

(

)

throw () [inline]

Returns this link's start node.

Returns:

The start node of the link

Definition at line 91 of file NGEdge.h.

References myStartNode.

                                   {
        return myStartNode;
    };

---

Field Documentation

NGNode* NGEdge::myEndNode [private]

The node the edge ends at.

Definition at line 125 of file NGEdge.h.

Referenced by buildNBEdge(), getEndNode(), and ~NGEdge().

std::string NGEdge::myID [private]

The id of the edge.

Definition at line 119 of file NGEdge.h.

Referenced by buildNBEdge(), and getID().

NGNode* NGEdge::myStartNode [private]

The node the edge starts at.

Definition at line 122 of file NGEdge.h.

Referenced by buildNBEdge(), getStartNode(), and ~NGEdge().

---

The documentation for this class was generated from the following files:

• NGEdge.h
• NGEdge.cpp