org.opentrafficsim.core.network

Class OTSNode

java.lang.Object

org.opentrafficsim.core.network.OTSNode

All Implemented Interfaces:

Serializable, Locatable, Node

public class OTSNode
extends Object
implements Node, Locatable, Serializable

The Node is a point with an id. It is used in the network to connect Links.

Copyright (c) 2013-2015 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2016-04-23 23:05:47 +0200 (Sat, 23 Apr 2016) $, @version $Revision: 1976 $, by $Author: averbraeck $, initial version Aug 19, 2014

Author:

Alexander Verbraeck, Peter Knoppers, Guus Tamminga

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OTSNode(String id, OTSPoint3D point) Construction of a Node.
OTSNode(String id, OTSPoint3D point, org.djunits.value.vdouble.scalar.Direction direction, org.djunits.value.vdouble.scalar.Direction slope) Construction of a Node.

Method Summary

Modifier and Type	Method and Description
void	addConnection(GTUType gtuType, Link incomingLink, Link outgoingLink) Add a single connection for a GTU type to the connections map.
void	addConnections(GTUType gtuType, Link incomingLink, Set<Link> outgoingLinks) Add a set of connections for a GTU type to the connections map.
void	addLink(Link link) Add a link to this Node.
boolean	equals(Object obj)
Bounds	getBounds()
org.djunits.value.vdouble.scalar.Direction	getDirection()
String	getId()
Set<Link>	getLinks()
DirectedPoint	getLocation()
OTSPoint3D	getPoint()
org.djunits.value.vdouble.scalar.Direction	getSlope()
int	hashCode()
boolean	isDirectionallyConnectedTo(GTUType gtuType, Node toNode) Note: this method does not take into account explicitly defined connections, as the previous link is not given.
Set<Link>	nextLinks(GTUType gtuType, Link prevLink) Determine the links connecting from the previous link via this Node for the given GTU type.
void	removeLink(Link link) Remove a link from this Node.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OTSNode

public OTSNode(String id,
               OTSPoint3D point,
               org.djunits.value.vdouble.scalar.Direction direction,
               org.djunits.value.vdouble.scalar.Direction slope)

Construction of a Node.

Parameters:

id - the id of the Node.

point - the point with usually an x and y setting.

direction - the 3D direction. "East" is 0 degrees. "North" is 90 degrees (1/2 pi radians).

slope - the slope as an angle. Horizontal is 0 degrees.

OTSNode

public OTSNode(String id,
               OTSPoint3D point)

Construction of a Node.

Parameters:

id - the id of the Node.

point - the point with usually an x and y setting.

Method Detail

getId

public final String getId()

Specified by:

getId in interface Node

Returns:

node id.

getPoint

public final OTSPoint3D getPoint()

Specified by:

getPoint in interface Node

Returns:

point.

addLink

public final void addLink(Link link)

Add a link to this Node.

Specified by:

addLink in interface Node

Parameters:

link - the link to add.

removeLink

public final void removeLink(Link link)

Remove a link from this Node.

Specified by:

removeLink in interface Node

Parameters:

link - the link to remove.

addConnection

public final void addConnection(GTUType gtuType,
                                Link incomingLink,
                                Link outgoingLink)
                         throws NetworkException

Add a single connection for a GTU type to the connections map. The data structures will be created is it does not exist yet.

Parameters:

gtuType - the GTU type for which this connection is made

incomingLink - the link that connects to this Node

outgoingLink - the link that the GTU can use to depart from this Node when coming from the incoming link

Throws:

NetworkException - in case one of the links is not (correctly) connected to this Node

addConnections

public final void addConnections(GTUType gtuType,
                                 Link incomingLink,
                                 Set<Link> outgoingLinks)
                          throws NetworkException

Add a set of connections for a GTU type to the connections map. The data structures will be created is it does not exist yet.

Parameters:

gtuType - the GTU type for which this connection is made

incomingLink - the link that connects to this Node

outgoingLinks - a set of links that the GTU can use to depart from this Node when coming from the incoming link

Throws:

NetworkException - in case one of the links is not (correctly) connected to this Node

getLinks

public final Set<Link> getLinks()

Specified by:

getLinks in interface Node

Returns:

a safe copy of the links connected to this Node

nextLinks

public final Set<Link> nextLinks(GTUType gtuType,
                                 Link prevLink)
                          throws NetworkException

Determine the links connecting from the previous link via this Node for the given GTU type.

Specified by:

nextLinks in interface Node

Parameters:

gtuType - the GTU type to determine the next links for

prevLink - the incoming link to the Node

Returns:

a set of links connecting from the previous link via this Node for the given GTU type

Throws:

NetworkException - if thhe incoming link is not connected to this node for the given GTU type

isDirectionallyConnectedTo

public final boolean isDirectionallyConnectedTo(GTUType gtuType,
                                                Node toNode)

Note: this method does not take into account explicitly defined connections, as the previous link is not given.
Check if the current node is linked to the given Node in the specified direction for the given GTUType. This can mean there is a Link from this node to toNode, and the LongitudinalDirectionality for the Link between this node and toNode is FORWARD or BOTH; or there is a Link from toNode to this node, and the LongitudinalDirectionality for the Link between toNode and this node is BACKWARD or BOTH for the provided GTUType.

Specified by:

isDirectionallyConnectedTo in interface Node

Parameters:

gtuType - the GTU type to check the connection for.

toNode - the to node

Returns:

whether two nodes are linked in the specified direction.

getDirection

public final org.djunits.value.vdouble.scalar.Direction getDirection()

Specified by:

getDirection in interface Node

Returns:

the 3D direction. "East" is 0 degrees. "North" is 90 degrees (1/2 pi radians).

getSlope

public final org.djunits.value.vdouble.scalar.Direction getSlope()

Specified by:

getSlope in interface Node

Returns:

the slope as an angle. Horizontal is 0 degrees.

getLocation

public final DirectedPoint getLocation()

Specified by:

getLocation in interface Locatable

Specified by:

getLocation in interface Node

getBounds

public final Bounds getBounds()

Specified by:

getBounds in interface Locatable

Specified by:

getBounds in interface Node

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object