org.opentrafficsim.road.gtu.lane.perception

Class InfrastructureLaneChangeInfo

java.lang.Object

org.opentrafficsim.road.gtu.lane.perception.InfrastructureLaneChangeInfo

All Implemented Interfaces:

Serializable, Comparable<InfrastructureLaneChangeInfo>

Direct Known Subclasses:

InfrastructureLaneChangeInfoToledo

public class InfrastructureLaneChangeInfo
extends Object
implements Comparable<InfrastructureLaneChangeInfo>, Serializable

Contains information by which drivers know when they need to leave a lane in order to be able to stay on the infrastructure and follow their route.

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

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version May 2, 2016

Author:

Wouter Schakel

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InfrastructureLaneChangeInfo(int requiredNumberOfLaneChanges, org.djunits.value.vdouble.scalar.Length remainingDistance, boolean deadEnd) Constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(InfrastructureLaneChangeInfo infrastructureLaneChangeInfo)
org.djunits.value.vdouble.scalar.Length	getRemainingDistance()
int	getRequiredNumberOfLaneChanges()
boolean	isDeadEnd()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

InfrastructureLaneChangeInfo

public InfrastructureLaneChangeInfo(int requiredNumberOfLaneChanges,
                                    org.djunits.value.vdouble.scalar.Length remainingDistance,
                                    boolean deadEnd)

Constructor.

Parameters:

requiredNumberOfLaneChanges - required number of lane changes

remainingDistance - remaining distance to perform required lane changes

deadEnd - whether this reason to change lane is due to a dead-end

Throws:

IllegalArgumentException - if required number of lane changes or remaining distance is negative

NullPointerException - if remaining distance is null

Method Detail

getRequiredNumberOfLaneChanges

public final int getRequiredNumberOfLaneChanges()

Returns:

requiredNumberOfLaneChanges required number of lane changes.

getRemainingDistance

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

Returns:

remainingDistance remaining distance to perform required lane changes.

isDeadEnd

public boolean isDeadEnd()

Returns:

whether this reason to change lane is due to a dead-end.

toString

public String toString()

Overrides:

toString in class Object

compareTo

public final int compareTo(InfrastructureLaneChangeInfo infrastructureLaneChangeInfo)

Specified by:

compareTo in interface Comparable<InfrastructureLaneChangeInfo>