org.opentrafficsim.road.network.factory

Class LaneFactory

java.lang.Object

org.opentrafficsim.road.network.factory.LaneFactory

All Implemented Interfaces:

org.djunits.unit.UNITS, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR, org.opentrafficsim.core.OTS_SCALAR

public final class LaneFactory
extends Object
implements org.opentrafficsim.core.OTS_SCALAR

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-09-16 19:20:07 +0200 (Wed, 16 Sep 2015) $, @version $Revision: 1405 $, by $Author: averbraeck $, initial version 30 okt. 2014

Author:

Peter Knoppers

Nested Class Summary

Nested classes/interfaces inherited from interface org.djunits.value.vdouble.scalar.DOUBLE_SCALAR

org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Acceleration, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.AnglePlane, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.AngleSlope, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.AngleSolid, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Area, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Density, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Dimensionless, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.ElectricalCharge, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.ElectricalCurrent, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.ElectricalPotential, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.ElectricalResistance, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Energy, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.FlowMass, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.FlowVolume, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Force, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Frequency, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Length, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.LinearDensity, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Mass, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Power, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Pressure, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Speed, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Temperature, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Time, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Torque, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Volume

Field Summary

Fields inherited from interface org.djunits.unit.UNITS

ABAMPERE, ABCOULOMB, ABVOLT, ACRE, AMPERE, ARCMINUTE, ARCSECOND, ARE, ATMOSPHERE_STANDARD, ATMOSPHERE_TECHNICAL, ATOMIC_UNIT, BAR, BARYE, BTU_ISO, BTU_IT, CALORIE_IT, CENTESIMAL_ARCMINUTE, CENTESIMAL_ARCSECOND, CENTIMETER, CENTIMETER_MERCURY, COULOMB, CUBIC_CENTIMETER, CUBIC_DECIMETER, CUBIC_FEET_PER_MINUTE, CUBIC_FEET_PER_SECOND, CUBIC_FOOT, CUBIC_INCH, CUBIC_INCH_PER_MINUTE, CUBIC_INCH_PER_SECOND, CUBIC_KM, CUBIC_METER, CUBIC_METER_PER_DAY, CUBIC_METER_PER_HOUR, CUBIC_METER_PER_MINUTE, CUBIC_METER_PER_SECOND, CUBIC_MILE, CUBIC_YARD, DALTON, DAY, DECIMETER, DEG, DEGREE, DEGREE_CELSIUS, DEGREE_FAHRENHEIT, DEGREE_RANKINE, DEGREE_REAUMUR, DEKAMETER, DYNE, ELECTRONVOLT, EMU, ERG, ERG_PER_SECOND, ESU, EXA_ELECTRONVOLT, FARADAY, FOOT, FOOT_MERCURY, FOOT_PER_SECOND, FOOT_PER_SECOND_2, FOOT_POUND_FORCE, FOOT_POUND_FORCE_PER_HOUR, FOOT_POUND_FORCE_PER_MINUTE, FOOT_POUND_FORCE_PER_SECOND, FRANKLIN, GAL, GALLON_IMP, GALLON_PER_DAY, GALLON_PER_HOUR, GALLON_PER_MINUTE, GALLON_PER_SECOND, GALLON_US_FLUID, GIGA_ELECTRONVOLT, GIGAHERTZ, GIGAWATT, GIGAWATT_HOUR, GRAD, GRAM, GRAM_PER_CENTIMETER_3, HECTARE, HECTOMETER, HECTOPASCAL, HERTZ, HORSEPOWER_METRIC, HOUR, INCH, INCH_MERCURY, INCH_PER_SECOND_2, INCH_POUND_FORCE, JOULE, KELVIN, KG_PER_METER_3, KGF_PER_SQUARE_MM, KILO_ELECTRONVOLT, KILOAMPERE, KILOCALORIE, KILOGRAM, KILOGRAM_FORCE, KILOGRAM_PER_SECOND, KILOHERTZ, KILOMETER, KILOOHM, KILOPASCAL, KILOVOLT, KILOWATT, KILOWATT_HOUR, KM_PER_HOUR, KM_PER_HOUR_2, KNOT, KNOT_PER_SECOND, LITER, LITER_PER_DAY, LITER_PER_HOUR, LITER_PER_MINUTE, LITER_PER_SECOND, MEGA_ELECTRONVOLT, MEGAHERTZ, MEGAOHM, MEGAVOLT, MEGAWATT, MEGAWATT_HOUR, METER, METER_KILOGRAM_FORCE, METER_PER_SECOND, METER_PER_SECOND_2, MICROAMPERE, MICROVOLT, MICROWATT_HOUR, MILE, MILE_PER_HOUR, MILE_PER_HOUR_2, MILE_PER_HOUR_PER_SECOND, MILLI_ELECTRONVOLT, MILLIAMPERE, MILLIAMPERE_HOUR, MILLIBAR, MILLIMETER, MILLIMETER_MERCURY, MILLIOHM, MILLISECOND, MILLIVOLT, MILLIWATT_HOUR, MINUTE, NANOAMPERE, NAUTICAL_MILE, NEWTON, NEWTON_METER, OHM, OUNCE, OUNCE_FORCE, OUNCE_IMP_FLUID, OUNCE_US_FLUID, PASCAL, PER_CENTIMETER, PER_DAY, PER_DECIMETER, PER_DEKAMETER, PER_FOOT, PER_HECTOMETER, PER_HOUR, PER_INCH, PER_KILOMETER, PER_METER, PER_MILE, PER_MILLIMETER, PER_MILLISECOND, PER_MINUTE, PER_NAUTICAL_MILE, PER_SECOND, PER_WEEK, PER_YARD, PETA_ELECTRONVOLT, PIEZE, PINT_IMP, PINT_US_FLUID, POUND, POUND_FOOT, POUND_FORCE, POUND_INCH, POUND_PER_SECOND, POUND_PER_SQUARE_FOOT, POUND_PER_SQUARE_INCH, QUART_IMP, QUART_US_FLUID, RAD, RADIAN, RPM, SECOND, SLOPE_ARCMINUTE, SLOPE_ARCSECOND, SLOPE_CENTESIMAL_ARCMINUTE, SLOPE_CENTESIMAL_ARCSECOND, SLOPE_DEGREE, SLOPE_GRAD, SLOPE_RADIAN, SQUARE_CENTIMETER, SQUARE_DEGREE, SQUARE_FOOT, SQUARE_INCH, SQUARE_METER, SQUARE_MILE, SQUARE_MILLIMETER, SQUARE_YARD, STANDARD_GRAVITY, STATAMPERE, STATCOULOMB, STATVOLT, STERADIAN, STHENE, STHENE_METER, STHENE_METER_PER_SECOND, TERA_ELECTRONVOLT, TERAHERTZ, TERAWATT_HOUR, TON_FORCE, TON_LONG, TON_METRIC, TON_SHORT, TONNE, TORR, VOLT, WATT, WATT_HOUR, WEEK, YARD

Method Summary

Modifier and Type	Method and Description
static Lane	makeLane(String name, org.opentrafficsim.core.network.OTSNode from, org.opentrafficsim.core.network.OTSNode to, org.opentrafficsim.core.geometry.OTSPoint3D[] intermediatePoints, LaneType laneType, org.djunits.value.vdouble.scalar.Speed.Abs speedLimit, org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator) Create a simple Lane.
static CrossSectionLink	makeLink(String name, org.opentrafficsim.core.network.OTSNode from, org.opentrafficsim.core.network.OTSNode to, org.opentrafficsim.core.geometry.OTSPoint3D[] intermediatePoints) Create a Link along intermediate coordinates from one Node to another.
static Lane[]	makeMultiLane(String name, org.opentrafficsim.core.network.OTSNode from, org.opentrafficsim.core.network.OTSNode to, org.opentrafficsim.core.geometry.OTSPoint3D[] intermediatePoints, int laneCount, int laneOffsetAtStart, int laneOffsetAtEnd, LaneType laneType, org.djunits.value.vdouble.scalar.Speed.Abs speedLimit, org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator) Create a simple road with the specified number of Lanes. This method returns an array of Lane.
static Lane[]	makeMultiLane(String name, org.opentrafficsim.core.network.OTSNode from, org.opentrafficsim.core.network.OTSNode to, org.opentrafficsim.core.geometry.OTSPoint3D[] intermediatePoints, int laneCount, LaneType laneType, org.djunits.value.vdouble.scalar.Speed.Abs speedLimit, org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator) Create a simple road with the specified number of Lanes. 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(String name,
                                        org.opentrafficsim.core.network.OTSNode from,
                                        org.opentrafficsim.core.network.OTSNode to,
                                        org.opentrafficsim.core.geometry.OTSPoint3D[] intermediatePoints)

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

Parameters:

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)

Returns:

Link; the newly constructed Link

makeLane

public static Lane makeLane(String name,
                            org.opentrafficsim.core.network.OTSNode from,
                            org.opentrafficsim.core.network.OTSNode to,
                            org.opentrafficsim.core.geometry.OTSPoint3D[] intermediatePoints,
                            LaneType laneType,
                            org.djunits.value.vdouble.scalar.Speed.Abs speedLimit,
                            org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator)
                     throws NamingException,
                            org.opentrafficsim.core.network.NetworkException,
                            org.opentrafficsim.core.geometry.OTSGeometryException

Create a simple Lane.

Parameters:

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

laneType - LaneType; type of the new Lane

speedLimit - DoubleScalar.Abs<SpeedUnit>; the speed limit on the new Lane

simulator - OTSDEVSSimulatorInterface; the simulator

Returns:

Lane; the new Lane

Throws:

NamingException - when names cannot be registered for animation

org.opentrafficsim.core.network.NetworkException - on network inconsistency

org.opentrafficsim.core.geometry.OTSGeometryException - when creation of center line or contour fails

makeMultiLane

public static Lane[] makeMultiLane(String name,
                                   org.opentrafficsim.core.network.OTSNode from,
                                   org.opentrafficsim.core.network.OTSNode to,
                                   org.opentrafficsim.core.geometry.OTSPoint3D[] intermediatePoints,
                                   int laneCount,
                                   int laneOffsetAtStart,
                                   int laneOffsetAtEnd,
                                   LaneType laneType,
                                   org.djunits.value.vdouble.scalar.Speed.Abs speedLimit,
                                   org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator)
                            throws NamingException,
                                   org.opentrafficsim.core.network.NetworkException,
                                   org.opentrafficsim.core.geometry.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:

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

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 - DoubleScalar.Abs<SpeedUnit>; the speed limit on all lanes

simulator - OTSDEVSSimulatorInterface; the simulator

Returns:

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

Throws:

NamingException - when names cannot be registered for animation

org.opentrafficsim.core.network.NetworkException - on topological problems

org.opentrafficsim.core.geometry.OTSGeometryException - when creation of center line or contour fails

makeMultiLane

public static Lane[] makeMultiLane(String name,
                                   org.opentrafficsim.core.network.OTSNode from,
                                   org.opentrafficsim.core.network.OTSNode to,
                                   org.opentrafficsim.core.geometry.OTSPoint3D[] intermediatePoints,
                                   int laneCount,
                                   LaneType laneType,
                                   org.djunits.value.vdouble.scalar.Speed.Abs speedLimit,
                                   org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface simulator)
                            throws NamingException,
                                   org.opentrafficsim.core.network.NetworkException,
                                   org.opentrafficsim.core.geometry.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:

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

laneCount - int; number of lanes in the road

laneType - LaneType; type of the new Lanes

speedLimit - DoubleScalar.Abs<SpeedUnit> the speed limit (applies to all generated lanes)

simulator - OTSDEVSSimulatorInterface; the simulator

Returns:

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

Throws:

NamingException - when names cannot be registered for animation

org.opentrafficsim.core.network.NetworkException - on topological problems

org.opentrafficsim.core.geometry.OTSGeometryException - when creation of center line or contour fails