com.conveyal.r5.otp2.api.path

Class EgressPathLeg<T extends TripScheduleInfo>

java.lang.Object

com.conveyal.r5.otp2.api.path.EgressPathLeg<T>

Type Parameters:

T - The TripSchedule type defined by the user of the range raptor API.

All Implemented Interfaces:

PathLeg<T>

public final class EgressPathLeg<T extends TripScheduleInfo>
extends Object
implements PathLeg<T>

Represent a egress leg in a path. The egress leg is the last leg arriving at the destination. The previous leg must be a transit leg - no other legs are allowed.

Constructor Summary

Constructors

Constructor and Description
EgressPathLeg(int fromStop, int fromTime, int toTime)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	fromStop() The stop index where the leg start, also called the leg departure stop index.
int	fromTime() The time when the leg start/depart from the leg origin.
int	hashCode()
boolean	isEgressLeg()
TransitPathLeg<T>	nextLeg() An access leg is always followed by a transit leg.
int	toTime() The time when the leg end/arrive at the leg destination.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.conveyal.r5.otp2.api.path.PathLeg

asEgressLeg, asTransferLeg, asTransitLeg, duration, isTransferLeg, isTransitLeg

Constructor Detail

EgressPathLeg

public EgressPathLeg(int fromStop,
                     int fromTime,
                     int toTime)

Method Detail

fromStop

public final int fromStop()

The stop index where the leg start, also called the leg departure stop index.

fromTime

public final int fromTime()

Description copied from interface: PathLeg

The time when the leg start/depart from the leg origin.

Specified by:

fromTime in interface PathLeg<T extends TripScheduleInfo>

toTime

public final int toTime()

Description copied from interface: PathLeg

The time when the leg end/arrive at the leg destination.

Specified by:

toTime in interface PathLeg<T extends TripScheduleInfo>

nextLeg

public final TransitPathLeg<T> nextLeg()

Description copied from interface: PathLeg

• An access leg is always followed by a transit leg.
• A transit leg can be followed by a new transit leg, an transfer leg or an egress leg.
• A transfer leg can only be followed by a transit leg.
• An egress leg is always the last leg and this method will throw a UnsupportedOperationException. Use the PathLeg.isEgressLeg() to check if the last leg is reached.

Specified by:

nextLeg in interface PathLeg<T extends TripScheduleInfo>

Returns:

Next leg in path.

Throws:

UnsupportedOperationException - - an egress leg is the last leg in a path and does not have a next leg.

isEgressLeg

public final boolean isEgressLeg()

Specified by:

isEgressLeg in interface PathLeg<T extends TripScheduleInfo>

Returns:

true if egress leg, if not false.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object