org.opentripplanner.api.model

Class Itinerary

java.lang.Object

org.opentripplanner.api.model.Itinerary

public class Itinerary
extends Object

An Itinerary is one complete way of getting from the start location to the end location.

Field Summary

Fields

Modifier and Type	Field and Description
Long	duration Duration of the trip on this itinerary, in seconds.
Double	elevationGained How much elevation is gained, in total, over the course of the trip, in meters.
Double	elevationLost How much elevation is lost, in total, over the course of the trip, in meters.
Calendar	endTime Time that the trip arrives.
Fare	fare The cost of this trip
List<Leg>	legs A list of Legs.
Calendar	startTime Time that the trip departs.
boolean	tooSloped This itinerary has a greater slope than the user requested (but there are no possible itineraries with a good slope).
Integer	transfers The number of transfers this trip has.
long	transitTime How much time is spent on transit, in seconds.
long	waitingTime How much time is spent waiting for transit to arrive, in seconds.
Double	walkDistance How far the user has to walk, in meters.
boolean	walkLimitExceeded Indicates that the walk limit distance has been exceeded for this itinerary when true.
long	walkTime How much time is spent walking, in seconds.

Constructor Summary

Constructors

Constructor and Description
Itinerary()

Method Summary

Modifier and Type	Method and Description
void	addLeg(Leg leg) adds leg to array list
void	fixupDates(CalendarServiceData service)
void	removeLeg(Leg leg) remove the leg from the list of legs

Methods inherited from class java.lang.Object

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

Field Detail

duration

public Long duration

Duration of the trip on this itinerary, in seconds.

startTime

public Calendar startTime

Time that the trip departs.

endTime

public Calendar endTime

Time that the trip arrives.

walkTime

public long walkTime

How much time is spent walking, in seconds.

transitTime

public long transitTime

How much time is spent on transit, in seconds.

waitingTime

public long waitingTime

How much time is spent waiting for transit to arrive, in seconds.

walkDistance

public Double walkDistance

How far the user has to walk, in meters.

walkLimitExceeded

public boolean walkLimitExceeded

Indicates that the walk limit distance has been exceeded for this itinerary when true.

elevationLost

public Double elevationLost

How much elevation is lost, in total, over the course of the trip, in meters. As an example, a trip that went from the top of Mount Everest straight down to sea level, then back up K2, then back down again would have an elevationLost of Everest + K2.

elevationGained

public Double elevationGained

How much elevation is gained, in total, over the course of the trip, in meters. See elevationLost.

transfers

public Integer transfers

The number of transfers this trip has.

fare

public Fare fare

The cost of this trip

legs

public List<Leg> legs

A list of Legs. Each Leg is either a walking (cycling, car) portion of the trip, or a transit trip on a particular vehicle. So a trip where the use walks to the Q train, transfers to the 6, then walks to their destination, has four legs.

tooSloped

public boolean tooSloped

This itinerary has a greater slope than the user requested (but there are no possible itineraries with a good slope).

Constructor Detail

Itinerary

public Itinerary()

Method Detail

addLeg

public void addLeg(Leg leg)

adds leg to array list

Parameters:

leg -

removeLeg

public void removeLeg(Leg leg)

remove the leg from the list of legs

Parameters:

leg - object to be removed

fixupDates

public void fixupDates(CalendarServiceData service)