org.opentrafficsim.road.network.factory

Class LaneFactory

java.lang.Object

org.opentrafficsim.road.network.factory.LaneFactory

public final class LaneFactory
extends Object

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

$LastChangedDate: 2015-09-16 19:20:07 +0200 (Wed, 16 Sep 2015) $, @version $Revision: 1405 $, by $Author: averbraeck $, initial version 30 okt. 2014

Author:

Peter Knoppers

Method Summary

Modifier and Type	Method and Description
static OTSLine3D	makeBezier(OTSNode n1, OTSNode n2, OTSNode n3, OTSNode n4)
static Lane	makeLane(Network network, String name, OTSNode from, OTSNode to, OTSPoint3D[] intermediatePoints, LaneType laneType, Speed speedLimit, DEVSSimulatorInterface.TimeDoubleUnit simulator) Create a simple Lane.
static CrossSectionLink	makeLink(Network network, String name, Node from, Node to, OTSPoint3D[] intermediatePoints, DEVSSimulatorInterface.TimeDoubleUnit simulator) Create a Link along intermediate coordinates from one Node to another.
static Lane[]	makeMultiLane(Network network, String name, OTSNode from, OTSNode to, OTSPoint3D[] intermediatePoints, int laneCount, int laneOffsetAtStart, int laneOffsetAtEnd, LaneType laneType, Speed speedLimit, DEVSSimulatorInterface.TimeDoubleUnit simulator) Create a simple road with the specified number of Lanes. This method returns an array of Lane.
static Lane[]	makeMultiLane(Network network, String name, OTSNode from, OTSNode to, OTSPoint3D[] intermediatePoints, int laneCount, LaneType laneType, Speed speedLimit, DEVSSimulatorInterface.TimeDoubleUnit simulator) Create a simple road with the specified number of Lanes. This method returns an array of Lane.
static Lane[]	makeMultiLaneBezier(Network network, String name, OTSNode n1, OTSNode n2, OTSNode n3, OTSNode n4, int laneCount, int laneOffsetAtStart, int laneOffsetAtEnd, LaneType laneType, Speed speedLimit, DEVSSimulatorInterface.TimeDoubleUnit simulator) Create a simple road with the specified number of Lanes, based on a Bezier curve. This method returns an array of Lane.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

makeLink

public static CrossSectionLink makeLink(Network network,
                                        String name,
                                        Node from,
                                        Node to,
                                        OTSPoint3D[] intermediatePoints,
                                        DEVSSimulatorInterface.TimeDoubleUnit simulator)
                                 throws OTSGeometryException,
                                        NetworkException

Create a Link along intermediate coordinates from one Node to another.

Parameters:

network - the network

name - String; name of the new Link

from - Node; start Node of the new Link

to - Node; end Node of the new Link

intermediatePoints - OTSPoint3D[]; array of intermediate coordinates (may be null); the intermediate points may contain the coordinates of the from node and to node

simulator - the simulator for this network

Returns:

Link; the newly constructed Link

Throws:

OTSGeometryException - when the design line is degenerate (only one point or duplicate point)

NetworkException - if link already exists in the network, if name of the link is not unique, or if the start node or the end node of the link are not registered in the network.

makeLane

public static Lane makeLane(Network network,
                            String name,
                            OTSNode from,
                            OTSNode to,
                            OTSPoint3D[] intermediatePoints,
                            LaneType laneType,
                            Speed speedLimit,
                            DEVSSimulatorInterface.TimeDoubleUnit simulator)
                     throws NamingException,
                            NetworkException,
                            OTSGeometryException

Create a simple Lane.

Parameters:

network - the network

name - String; name of the Lane (and also of the Link that owns it)

from - Node; starting node of the new Lane

to - Node; ending node of the new Lane

intermediatePoints - OTSPoint3D[]; intermediate coordinates or null to create a straight road; the intermediate points may contain the coordinates of the from node and to node

laneType - LaneType; type of the new Lane

speedLimit - Speed; the speed limit on the new Lane

simulator - DEVSSimulatorInterface.TimeDoubleUnit; the simulator

Returns:

Lane; the new Lane

Throws:

NamingException - when names cannot be registered for animation

NetworkException - on network inconsistency

OTSGeometryException - when creation of center line or contour fails

makeMultiLane

public static Lane[] makeMultiLane(Network network,
                                   String name,
                                   OTSNode from,
                                   OTSNode to,
                                   OTSPoint3D[] intermediatePoints,
                                   int laneCount,
                                   int laneOffsetAtStart,
                                   int laneOffsetAtEnd,
                                   LaneType laneType,
                                   Speed speedLimit,
                                   DEVSSimulatorInterface.TimeDoubleUnit simulator)
                            throws NamingException,
                                   NetworkException,
                                   OTSGeometryException

Create a simple road with the specified number of Lanes.
This method returns an array of Lane. These lanes are embedded in a Link that can be accessed through the getParentLink method of the Lane.

Parameters:

network - the network

name - String; name of the Link

from - Node; starting node of the new Lane

to - Node; ending node of the new Lane

intermediatePoints - OTSPoint3D[]; intermediate coordinates or null to create a straight road; the intermediate points may contain the coordinates of the from node and to node

laneCount - int; number of lanes in the road

laneOffsetAtStart - int; extra offset from design line in lane widths at start of link

laneOffsetAtEnd - int; extra offset from design line in lane widths at end of link

laneType - LaneType; type of the new Lanes

speedLimit - Speed; the speed limit on all lanes

simulator - DEVSSimulatorInterface.TimeDoubleUnit; the simulator

Returns:

Lane<String, String>[]; array containing the new Lanes

Throws:

NamingException - when names cannot be registered for animation

NetworkException - on topological problems

OTSGeometryException - when creation of center line or contour fails

makeMultiLane

public static Lane[] makeMultiLane(Network network,
                                   String name,
                                   OTSNode from,
                                   OTSNode to,
                                   OTSPoint3D[] intermediatePoints,
                                   int laneCount,
                                   LaneType laneType,
                                   Speed speedLimit,
                                   DEVSSimulatorInterface.TimeDoubleUnit simulator)
                            throws NamingException,
                                   NetworkException,
                                   OTSGeometryException

Create a simple road with the specified number of Lanes.
This method returns an array of Lane. These lanes are embedded in a Link that can be accessed through the getParentLink method of the Lane.

Parameters:

network - the network

name - String; name of the Link

from - Node; starting node of the new Lane

to - Node; ending node of the new Lane

intermediatePoints - OTSPoint3D[]; intermediate coordinates or null to create a straight road; the intermediate points may contain the coordinates of the from node and to node

laneCount - int; number of lanes in the road

laneType - LaneType; type of the new Lanes

speedLimit - Speed the speed limit (applies to all generated lanes)

simulator - DEVSSimulatorInterface.TimeDoubleUnit; the simulator

Returns:

Lane<String, String>[]; array containing the new Lanes

Throws:

NamingException - when names cannot be registered for animation

NetworkException - on topological problems

OTSGeometryException - when creation of center line or contour fails

makeMultiLaneBezier

public static Lane[] makeMultiLaneBezier(Network network,
                                         String name,
                                         OTSNode n1,
                                         OTSNode n2,
                                         OTSNode n3,
                                         OTSNode n4,
                                         int laneCount,
                                         int laneOffsetAtStart,
                                         int laneOffsetAtEnd,
                                         LaneType laneType,
                                         Speed speedLimit,
                                         DEVSSimulatorInterface.TimeDoubleUnit simulator)
                                  throws NamingException,
                                         NetworkException,
                                         OTSGeometryException

Create a simple road with the specified number of Lanes, based on a Bezier curve.
This method returns an array of Lane. These lanes are embedded in a Link that can be accessed through the getParentLink method of the Lane.

Parameters:

network - the network

name - String; name of the Link

n1 - Node; control node for the start direction

n2 - Node; starting node of the new Lane

n3 - Node; ending node of the new Lane

n4 - Node; control node for the end direction

laneCount - int; number of lanes in the road

laneOffsetAtStart - int; extra offset from design line in lane widths at start of link

laneOffsetAtEnd - int; extra offset from design line in lane widths at end of link

laneType - LaneType; type of the new Lanes

speedLimit - Speed; the speed limit on all lanes

simulator - DEVSSimulatorInterface.TimeDoubleUnit; the simulator

Returns:

Lane<String, String>[]; array containing the new Lanes

Throws:

NamingException - when names cannot be registered for animation

NetworkException - on topological problems

OTSGeometryException - when creation of center line or contour fails

makeBezier

public static OTSLine3D makeBezier(OTSNode n1,
                                   OTSNode n2,
                                   OTSNode n3,
                                   OTSNode n4)
                            throws OTSGeometryException

Parameters:

n1 - node 1

n2 - node 2

n3 - node 3

n4 - node 4

Returns:

line between n2 and n3 with start-direction n1-->n2 and end-direction n3-->n4

Throws:

OTSGeometryException - on failure of Bezier curve creation