org.opentripplanner.routing.core

Class TransferTable

java.lang.Object

org.opentripplanner.routing.core.TransferTable

All Implemented Interfaces:

Serializable

public class TransferTable
extends Object
implements Serializable

This class represents all transfer information in the graph. Transfers are grouped by stop-to-stop pairs. Each transfer may consist of multiple specific transfers. See https://developers.google.com/transit/gtfs/reference#transfers_fields and https://support.google.com/transitpartners/answer/2450962 (heading Route-to-route and trip-to-trip transfers) for more details about the specifications.

See Also:

StopTransfer, SpecificTransfer, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransferTable.Transfer Deprecated.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	preferredTransfers Preferred transfers (or timed transfers, which are preferred as well) are present if true
protected HashMap<P2<FeedScopedId>,StopTransfer>	table Table which contains transfers between two stops

Constructor Summary

Constructors

Constructor and Description
TransferTable()

Method Summary

Modifier and Type	Method and Description
void	addTransferTime(Stop fromStop, Stop toStop, Route fromRoute, Route toRoute, Trip fromTrip, Trip toTrip, int transferTime) Add a transfer time to the transfer table.
int	determineTransferPenalty(int transferTime, int nonpreferredTransferPenalty) Determines the transfer penalty given a transfer time and a penalty for non-preferred transfers.
Iterable<TransferTable.Transfer>	getAllFirstSpecificTransfers() Deprecated.
int	getTransferTime(Stop fromStop, Stop toStop, Trip fromTrip, Trip toTrip, boolean forwardInTime) Get the transfer time that should be used when transferring from a trip to another trip.
boolean	hasPreferredTransfers()

Methods inherited from class java.lang.Object

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

Field Detail

table

protected HashMap<P2<FeedScopedId>,StopTransfer> table

Table which contains transfers between two stops

preferredTransfers

protected boolean preferredTransfers

Preferred transfers (or timed transfers, which are preferred as well) are present if true

Constructor Detail

TransferTable

public TransferTable()

Method Detail

hasPreferredTransfers

public boolean hasPreferredTransfers()

getTransferTime

public int getTransferTime(Stop fromStop,
                           Stop toStop,
                           Trip fromTrip,
                           Trip toTrip,
                           boolean forwardInTime)

Get the transfer time that should be used when transferring from a trip to another trip. Note that this function does not check whether another specific transfer exists with the same specificity, what is forbidden by the specifications.

Parameters:

fromStop - is the arriving stop

toStop - is the departing stop

fromTrip - is the arriving trip

toTrip - is the departing trip

forwardInTime - is true when moving forward in time; false when moving backwards in time (usually this will be the variable "boarding")

Returns:

the transfer time in seconds. May contain special (negative) values which meaning can be found in the StopTransfer.*_TRANSFER constants. If no transfer is found, StopTransfer.UNKNOWN_TRANSFER is returned.

addTransferTime

public void addTransferTime(Stop fromStop,
                            Stop toStop,
                            Route fromRoute,
                            Route toRoute,
                            Trip fromTrip,
                            Trip toTrip,
                            int transferTime)

Add a transfer time to the transfer table.

Parameters:

fromStop - is the arriving stop

toStop - is the departing stop

fromRoute - is the arriving route; is allowed to be null

toRoute - is the departing route; is allowed to be null

fromTrip - is the arriving trip; is allowed to be null

toTrip - is the departing trip; is allowed to be null

transferTime - is the transfer time in seconds. May contain special (negative) values which meaning can be found in the StopTransfer.*_TRANSFER constants. If no transfer is found, StopTransfer.UNKNOWN_TRANSFER is returned.

determineTransferPenalty

public int determineTransferPenalty(int transferTime,
                                    int nonpreferredTransferPenalty)

Determines the transfer penalty given a transfer time and a penalty for non-preferred transfers.

Parameters:

transferTime - is the transfer time

nonpreferredTransferPenalty - is the penalty for non-preferred transfers

Returns:

the transfer penalty

getAllFirstSpecificTransfers

@Deprecated
public Iterable<TransferTable.Transfer> getAllFirstSpecificTransfers()

Deprecated.

Public function for testing purposes only. Returns only the first specific transfers.

See Also:

TransferGraphLinker