The class storing the generated network. More...

#include <NGNet.h>

Public Member Functions
void	add (NGNode *node) throw ()
	Adds the given node to the network.
void	add (NGEdge *edge) throw ()
	Adds the given edge to the network.
void	createChequerBoard (int numX, int numY, SUMOReal spaceX, SUMOReal spaceY, SUMOReal attachLength) throw ()
	Creates a grid network.
void	createSpiderWeb (int numRadDiv, int numCircles, SUMOReal spaceRad, bool hasCenter) throw ()
	Creates a spider network.
NGNode *	findNode (int xPos, int yPos) throw ()
	Returns the node at the given position.
std::string	getNextFreeID () throw ()
	Returns the next free id.
	NGNet (NBNetBuilder &nb) throw ()
	Constructor.
size_t	nodeNo () const throw ()
	Returns the number of stored nodes.
SUMOReal	radialToX (SUMOReal radius, SUMOReal phi) throw ()
	Returns the x-position resulting from the given radius and angle.
SUMOReal	radialToY (SUMOReal radius, SUMOReal phi) throw ()
	Returns the y-position resulting from the given radius and angle.
void	toNB () const throw (ProcessError)
	Converts the stored network into its netbuilder-representation.
	~NGNet () throw ()
	Destructor.
Private Member Functions
void	connect (NGNode node1, NGNode node2) throw ()
	Connects both nodes with two edges, one for each direction.
	NGNet (const NGNet &)
	Invalidated copy constructor.
NGNet &	operator= (const NGNet &)
	Invalidated assignment operator.
Private Attributes
NGEdgeList	myEdgeList
	The list of links.
int	myLastID
	The last ID given to node or link.
NBNetBuilder &	myNetBuilder
	The builder used to build NB*-structures.
NGNodeList	myNodeList
	The list of nodes.

Detailed Description

The class storing the generated network.

An instance of this class stores both the edges and the nodes build during the generation of a network (using any type of generation algorithm). These instances are later transformed into netbuild-structures using toNB().

Definition at line 53 of file NGNet.h.

Constructor & Destructor Documentation

NGNet::NGNet ( NBNetBuilder & nb ) throw ()

Constructor.

Definition at line 53 of file NGNet.cpp.

NGNet::~NGNet ( ) throw ()

Destructor.

Definition at line 59 of file NGNet.cpp.

References myEdgeList, and myNodeList.

NGNet::NGNet ( const NGNet & ) [private]

Invalidated copy constructor.

Member Function Documentation

void NGNet::add ( NGNode * node ) throw ()

Adds the given node to the network.

The node is added to myNodeList.

Parameters:

[in] node The node to add

Definition at line 237 of file NGNet.cpp.

Referenced by NGRandomNetBuilder::createNet(), and NGRandomNetBuilder::createNewNode().

void NGNet::add ( NGEdge * edge ) throw ()

Adds the given edge to the network.

The edge is added to myEdgeList.

Parameters:

[in] edge The edge to add

Definition at line 243 of file NGNet.cpp.

void NGNet::connect	(	NGNode *	node1,
		NGNode *	node2
	)		throw () `[private]`

Connects both nodes with two edges, one for each direction.

Builds one link for each direction and appends the links to myEdgeList. The name of a link is as following: <FROM_NODE_ID>to<TO_NODE_ID>.

Parameters:

[in]	node1	The first node to connect
[in]	node2	The second node to connect

Definition at line 197 of file NGNet.cpp.

void NGNet::createChequerBoard	(	int	numX,
		int	numY,
		SUMOReal	spaceX,
		SUMOReal	spaceY,
		SUMOReal	attachLength
	)		throw ()

Creates a grid network.

Performs a souble-loop over numX, then numY. Builds NGNodes at the according positions and connects them using NGNet::connect. Stores both the nodes and the edges within the internal container.

The nodes get an id using <RUNNING_X>/<RUNNING_Y>. The ids of the links are set in NGNet::connect.

Parameters:

[in]	numX	The number of nodes in x-direction
[in]	numY	The number of nodes in y-direction
[in]	spaceX	The space between nodes in x-direction
[in]	spaceY	The space between nodes in y-direction
[in]	attachLength	The length of streets attached at the border

See also:: NGNet::connect

Definition at line 87 of file NGNet.cpp.

References NGNode::setX(), and NGNode::setY().

Referenced by buildNetwork().

void NGNet::createSpiderWeb	(	int	numRadDiv,
		int	numCircles,
		SUMOReal	spaceRad,
		bool	hasCenter
	)		throw ()

Creates a spider network.

Creates a spider web by going through all arms and then all circles in a loop. Builds the NGNodes at the positions obtained using radialToX and radialToY and connects them using NGNet::connect. Builds optionally a center node, and connects it, too.

The nodes get an id using <RUNNING_ARM_NUMBER>/<RUNNING_CIRCLE_NUMBER>. The ids of the links are set in NGNet::connect.

Parameters:

[in]	numRadDiv	The number of arms to build
[in]	numCircles	The number of circles to build
[in]	spaceRad	The distance between the circles
[in]	hasCenter	Information whether a center node shall be built

See also:: NGNet::connect

Todo:: consolidate the name of the center node

Definition at line 151 of file NGNet.cpp.

References PI, NGNode::setX(), NGNode::setY(), and SUMOReal.

Referenced by buildNetwork().

NGNode * NGNet::findNode	(	int	xPos,
		int	yPos
	)		throw ()

Returns the node at the given position.

Searches for a node with the given position within myNodeList. Returns the matching node, if one exists, or 0 otherwise.

Parameters:

[in]	xPos	The x-position of the searched node
[in]	yPos	The y-position of the searched node

Returns:: The node with the given position, or 0 if no such node exists

Definition at line 76 of file NGNet.cpp.

std::string NGNet::getNextFreeID ( ) throw ()

Returns the next free id.

Uses the value of myLastID to return a new (numeric) id. Increases myLastID.

Returns:: A new, unique numerical id

Definition at line 70 of file NGNet.cpp.

References myLastID.

Referenced by NGRandomNetBuilder::createNet(), and NGRandomNetBuilder::createNewNode().

size_t NGNet::nodeNo ( ) const throw ()

Returns the number of stored nodes.

Returns:: The number of stored nodes

Definition at line 249 of file NGNet.cpp.

References myNodeList.

Referenced by NGRandomNetBuilder::createNet().

NGNet& NGNet::operator= ( const NGNet & ) [private]

Invalidated assignment operator.

SUMOReal NGNet::radialToX	(	SUMOReal	radius,
		SUMOReal	phi
	)		throw ()

Returns the x-position resulting from the given radius and angle.

Parameters:

[in]	radius	The radius of the circle
[in]	phi	The angle the position is located at

Returns:: The x-position at the described circle at angle phi

Definition at line 139 of file NGNet.cpp.

SUMOReal NGNet::radialToY	(	SUMOReal	radius,
		SUMOReal	phi
	)		throw ()

Returns the y-position resulting from the given radius and angle.

Parameters:

[in]	radius	The radius of the circle
[in]	phi	The angle the position is located at

Returns:: The y-position at the described circle at angle phi

Definition at line 145 of file NGNet.cpp.

void NGNet::toNB ( ) const throw (ProcessError)

Converts the stored network into its netbuilder-representation.

Goes through all stored nodes, first, converts them into their netbuilder representations using NGNode::buildNBNode, and stores the built NBNodes into the net builder myNetBuilder.

Then, the method goes through all edges, converts them into their netbuilder representations using NGEdge::buildNBEdge, and stores the built NBEdges into the net builder myNetBuilder.

If one of the nodes is controlled by a tls and the built logic could not be added to net builder's storage, a ProcessError is thrown. This in fact may only happen when two same ids occur, what is not possible.

Exceptions:

ProcessError If a built tls logic could not be added (should never happen)