org.opentrafficsim.core.network

Class OTSNode

java.lang.Object

org.opentrafficsim.core.network.OTSNode

All Implemented Interfaces:

Serializable, LocatableInterface, Node

public class OTSNode
extends Object
implements Node, LocatableInterface, 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: 2015-10-27 22:41:34 +0100 (Tue, 27 Oct 2015) $, @version $Revision: 1495 $, 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.Angle.Abs direction, org.djunits.value.vdouble.scalar.Angle.Abs slope) Construction of a Node.

Method Summary

Modifier and Type	Method and Description
void	addLinkIn(Link linkIn) Add an incoming link to this Node.
void	addLinkOut(Link linkOut) Add an outgoing link to this Node.
boolean	equals(Object obj)
Bounds	getBounds()
org.djunits.value.vdouble.scalar.Angle.Abs	getDirection()
String	getId()
Set<Link>	getLinksIn()
Set<Link>	getLinksOut()
DirectedPoint	getLocation()
OTSPoint3D	getPoint()
org.djunits.value.vdouble.scalar.Angle.Abs	getSlope()
int	hashCode()
boolean	isDirectionallyConnectedTo(GTUType gtuType, Node toNode) Check if the current node is linked to the given Node in the specified direction for the given GTUType.
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.Angle.Abs direction,
               org.djunits.value.vdouble.scalar.Angle.Abs 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.

addLinkIn

public final void addLinkIn(Link linkIn)

Add an incoming link to this Node.

Specified by:

addLinkIn in interface Node

Parameters:

linkIn - the link to add.

addLinkOut

public final void addLinkOut(Link linkOut)

Add an outgoing link to this Node.

Specified by:

addLinkOut in interface Node

Parameters:

linkOut - the link to add.

getLinksIn

public final Set<Link> getLinksIn()

Specified by:

getLinksIn in interface Node

Returns:

linksIn.

getLinksOut

public final Set<Link> getLinksOut()

Specified by:

getLinksOut in interface Node

Returns:

linksOut.

isDirectionallyConnectedTo

public final boolean isDirectionallyConnectedTo(GTUType gtuType,
                                                Node toNode)

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.Angle.Abs 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.Angle.Abs 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 LocatableInterface

Specified by:

getLocation in interface Node

getBounds

public final Bounds getBounds()

Specified by:

getBounds in interface LocatableInterface

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