org.opentrafficsim.road.gtu.lane.perception

Class LaneStructureRecord

java.lang.Object

org.opentrafficsim.road.gtu.lane.perception.LaneStructureRecord

All Implemented Interfaces:

Serializable

public class LaneStructureRecord
extends Object
implements Serializable

A LaneStructureRecord contains information about the lanes that can be accessed from this lane by a GTUType. It tells whether there is a left and/or right lane by pointing to other LaneStructureRecords, and which successor LaneStructureRecord(s) there are at the end of the lane of this LaneStructureRecord. All information (left, right, next) is calculated relative to the driving direction of the GTU that owns this structure.

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

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Feb 21, 2016

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LaneStructureRecord(Lane lane, org.opentrafficsim.core.gtu.GTUDirectionality direction, org.djunits.value.vdouble.scalar.Length startDistance)

Method Summary

Modifier and Type	Method and Description
void	addNext(LaneStructureRecord next)
void	addPrev(LaneStructureRecord prev)
boolean	allowsRoute(org.opentrafficsim.core.network.route.Route route, org.opentrafficsim.core.gtu.GTUType gtuType) Returns whether this lane allows the route to be followed.
boolean	allowsRouteAtEnd(org.opentrafficsim.core.network.route.Route route, org.opentrafficsim.core.gtu.GTUType gtuType) Returns whether the end of this lane allows the route to be followed.
org.djunits.value.vdouble.scalar.Length	getCutOffEnd() Returns distance where the structure was cut-off.
org.djunits.value.vdouble.scalar.Length	getCutOffStart() Returns distance where the structure was cut-off.
org.opentrafficsim.core.gtu.GTUDirectionality	getDirection()
org.djunits.value.vdouble.scalar.Length	getDistanceToPosition(org.djunits.value.vdouble.scalar.Length longitudinalPosition) Returns total distance towards the object at the given position.
org.opentrafficsim.core.network.Node	getFromNode()
Lane	getLane()
LaneStructureRecord	getLeft()
List<LaneStructureRecord>	getNext()
List<LaneStructureRecord>	getPrev()
LaneStructureRecord	getRight()
org.djunits.value.vdouble.scalar.Length	getStartDistance()
org.opentrafficsim.core.network.Node	getToNode()
boolean	isCutOffEnd() Returns whether this lane has no next records as the lane structure was cut-off.
boolean	isCutOffStart() Returns whether this lane has no previous records as the lane structure was cut-off.
boolean	isLinkMerge()
boolean	isLinkSplit()
void	setCutOffEnd(org.djunits.value.vdouble.scalar.Length cutOffEnd) Sets this record as being cut-off, i.e.
void	setCutOffStart(org.djunits.value.vdouble.scalar.Length cutOffStart) Sets this record as being cut-off, i.e.
void	setLeft(LaneStructureRecord left)
void	setNextList(List<LaneStructureRecord> nextList)
void	setPrevList(List<LaneStructureRecord> prevList)
void	setRight(LaneStructureRecord right)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LaneStructureRecord

public LaneStructureRecord(Lane lane,
                           org.opentrafficsim.core.gtu.GTUDirectionality direction,
                           org.djunits.value.vdouble.scalar.Length startDistance)

Parameters:

lane - the lane of the LSR

direction - the direction on which we process this lane

startDistance - distance to start of the record, negative for backwards

Method Detail

getFromNode

public final org.opentrafficsim.core.network.Node getFromNode()

Returns:

the 'from' node of the link belonging to this lane, in the driving direction.

getToNode

public final org.opentrafficsim.core.network.Node getToNode()

Returns:

the 'to' node of the link belonging to this lane, in the driving direction.

getDistanceToPosition

public final org.djunits.value.vdouble.scalar.Length getDistanceToPosition(org.djunits.value.vdouble.scalar.Length longitudinalPosition)

Returns total distance towards the object at the given position. This method accounts for the GTU directionality.

Parameters:

longitudinalPosition - position on the design line

Returns:

total distance towards the object at the given position

isLinkSplit

public final boolean isLinkSplit()

Returns:

whether the link to which this lane belongs splits, i.e. some of the parallel, connected lanes lead to a different destination than others

isLinkMerge

public final boolean isLinkMerge()

Returns:

whether the link to which this lane belongs merges, i.e. some of the parallel, connected lanes follow from a different origin than others

allowsRoute

public final boolean allowsRoute(org.opentrafficsim.core.network.route.Route route,
                                 org.opentrafficsim.core.gtu.GTUType gtuType)
                          throws org.opentrafficsim.core.network.NetworkException

Returns whether this lane allows the route to be followed.

Parameters:

route - Route; the route to follow

gtuType - GTUType; gtu type

Returns:

whether this lane allows the route to be followed

Throws:

org.opentrafficsim.core.network.NetworkException - if no destination node

allowsRouteAtEnd

public final boolean allowsRouteAtEnd(org.opentrafficsim.core.network.route.Route route,
                                      org.opentrafficsim.core.gtu.GTUType gtuType)
                               throws org.opentrafficsim.core.network.NetworkException

Returns whether the end of this lane allows the route to be followed.

Parameters:

route - Route; the route to follow

gtuType - GTUType; gtu type

Returns:

whether the end of this lane allows the route to be followed

Throws:

org.opentrafficsim.core.network.NetworkException - if no destination node

getLeft

public final LaneStructureRecord getLeft()

Returns:

the left LSR or null if not available. Left and right are relative to the driving direction.

setLeft

public final void setLeft(LaneStructureRecord left)

Parameters:

left - set the left LSR or null if not available. Left and right are relative to the driving direction.

getRight

public final LaneStructureRecord getRight()

Returns:

the right LSR or null if not available. Left and right are relative to the driving direction

setRight

public final void setRight(LaneStructureRecord right)

Parameters:

right - set the right LSR or null if not available. Left and right are relative to the driving direction

getNext

public final List<LaneStructureRecord> getNext()

Returns:

the next LSRs. The list is empty if no LSRs are available. Next is relative to the driving direction, not to the design line direction.

setNextList

public final void setNextList(List<LaneStructureRecord> nextList)
                       throws org.opentrafficsim.core.gtu.GTUException

Parameters:

nextList - set the next LSRs. The list is empty if no LSRs are available. Next is relative to the driving direction, not to the design line direction.

Throws:

org.opentrafficsim.core.gtu.GTUException - if the records is cut-off at the end

addNext

public final void addNext(LaneStructureRecord next)
                   throws org.opentrafficsim.core.gtu.GTUException

Parameters:

next - a next LSRs to add. Next is relative to the driving direction, not to the design line direction.

Throws:

org.opentrafficsim.core.gtu.GTUException - if the records is cut-off at the end

getPrev

public final List<LaneStructureRecord> getPrev()

Returns:

the previous LSRs. The list is empty if no LSRs are available. Previous is relative to the driving direction, not to the design line direction.

setPrevList

public final void setPrevList(List<LaneStructureRecord> prevList)
                       throws org.opentrafficsim.core.gtu.GTUException

Parameters:

prevList - set the next LSRs. The list is empty if no LSRs are available. Previous is relative to the driving direction, not to the design line direction.

Throws:

org.opentrafficsim.core.gtu.GTUException - if the records is cut-off at the start

addPrev

public final void addPrev(LaneStructureRecord prev)
                   throws org.opentrafficsim.core.gtu.GTUException

Parameters:

prev - a previous LSRs to add. Previous is relative to the driving direction, not to the design line direction.

Throws:

org.opentrafficsim.core.gtu.GTUException - if the records is cut-off at the start

setCutOffEnd

public final void setCutOffEnd(org.djunits.value.vdouble.scalar.Length cutOffEnd)
                        throws org.opentrafficsim.core.gtu.GTUException

Sets this record as being cut-off, i.e. there are no next records due to cut-off.

Parameters:

cutOffEnd - where this lane was cut-off (in the driving direction) resulting in no prev lanes

Throws:

org.opentrafficsim.core.gtu.GTUException - if there are next records

setCutOffStart

public final void setCutOffStart(org.djunits.value.vdouble.scalar.Length cutOffStart)
                          throws org.opentrafficsim.core.gtu.GTUException

Sets this record as being cut-off, i.e. there are no previous records due to cut-off.

Parameters:

cutOffStart - where this lane was cut-off (in the driving direction) resulting in no next lanes

Throws:

org.opentrafficsim.core.gtu.GTUException - if there are previous records

isCutOffEnd

public final boolean isCutOffEnd()

Returns whether this lane has no next records as the lane structure was cut-off.

Returns:

whether this lane has no next records as the lane structure was cut-off

isCutOffStart

public final boolean isCutOffStart()

Returns whether this lane has no previous records as the lane structure was cut-off.

Returns:

whether this lane has no previous records as the lane structure was cut-off

getCutOffEnd

public final org.djunits.value.vdouble.scalar.Length getCutOffEnd()

Returns distance where the structure was cut-off.

Returns:

distance where the structure was cut-off

getCutOffStart

public final org.djunits.value.vdouble.scalar.Length getCutOffStart()

Returns distance where the structure was cut-off.

Returns:

distance where the structure was cut-off

getLane

public final Lane getLane()

Returns:

the lane of the LSR

getDirection

public final org.opentrafficsim.core.gtu.GTUDirectionality getDirection()

Returns:

the direction in which we process this lane

getStartDistance

public final org.djunits.value.vdouble.scalar.Length getStartDistance()

Returns:

distance to start in the driving direction, from the reference position

toString

public final String toString()

Overrides:

toString in class Object