Leg (OpenTripPlanner 1.4.0 API)

java.lang.Object
- org.opentripplanner.api.model.Leg

```
public class Leg
extends Object
```
One leg of a trip -- that is, a temporally continuous piece of the journey that takes place on a particular vehicle (or on foot).

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`agencyBrandingUrl`
`String`	`agencyId` For transit legs, the ID of the transit agency that operates the service used for this leg.
`String`	`agencyName`
`int`	`agencyTimeZoneOffset`
`String`	`agencyUrl`
`List<LocalizedAlert>`	`alerts`
`String`	`alightRule`
`int`	`arrivalDelay` For transit leg, the offset from the scheduled arrival-time of the alighting stop in this leg.
`String`	`boardRule`
`Boolean`	`callAndRide` True if this is a call-and-ride leg.
`int`	`departureDelay` For transit leg, the offset from the scheduled departure-time of the boarding stop in this leg.
`Double`	`distance` The distance traveled while traversing the leg in meters.
`Calendar`	`endTime` The date and time this leg ends.
`Calendar`	`flexCallAndRideMaxStartTime`
`Calendar`	`flexCallAndRideMinEndTime`
`double`	`flexDrtAdvanceBookMin` trip.drt_advance_book_min if this is a demand-response leg
`String`	`flexDrtDropOffMessage` Agency message if this is leg has a demand-response dropoff and the Trip has `drt_drop_off_message` defined.
`String`	`flexDrtPickupMessage` Agency message if this is leg has a demand-response pickup and the Trip has `drt_pickup_message` defined.
`String`	`flexFlagStopDropOffMessage` Agency message if this is leg has a flag stop dropoff and the Trip has `continuous_drop_off_message` defined.
`String`	`flexFlagStopPickupMessage` Agency message if this is leg has a flag stop pickup and the Trip has `continuous_pickup_message` defined.
`Place`	`from` The Place where the leg originates.
`String`	`headsign` For transit legs, the headsign of the bus or train being used.
`Integer`	`headway` The best estimate of the time between two arriving vehicles.
`Boolean`	`interlineWithPreviousLeg` For transit legs, if the rider should stay on the vehicle as it changes route names.
`Boolean`	`isNonExactFrequency` Is this a frequency-based trip with non-strict departure times?
`EncodedPolylineBean`	`legGeometry` The leg's geometry.
`String`	`mode` The mode (e.g., `Walk`) used when traversing this leg.
`Boolean`	`pathway` Is this leg a traversing pathways?
`Boolean`	`realTime` Whether there is real-time data about this Leg
`Boolean`	`rentedBike`
`String`	`route` For transit legs, the route of the bus or train being used.
`String`	`routeBrandingUrl` For transit leg, the route's branding URL (if one exists).
`String`	`routeColor` For transit leg, the route's (background) color (if one exists).
`FeedScopedId`	`routeId` For transit legs, the ID of the route.
`String`	`routeLongName`
`String`	`routeShortName`
`String`	`routeTextColor` For transit leg, the route's text color (if one exists).
`Integer`	`routeType` For transit legs, the type of the route.
`String`	`serviceDate` For transit legs, the service date of the trip.
`Calendar`	`startTime` The date and time this leg begins.
`List<Place>`	`stop` For transit legs, intermediate stops between the Place where the leg originates and the Place where the leg ends.
`Place`	`to` The Place where the leg begins.
`String`	`tripBlockId` For transit leg, the trip's block ID (if one exists).
`FeedScopedId`	`tripId` For transit legs, the ID of the trip.
`String`	`tripShortName` For transit leg, the trip's short name (if one exists).
`List<WalkStep>`	`walkSteps` A series of turn by turn instructions used for walking, biking and driving.

Constructor Summary

Constructors
Constructor and Description

Leg()

Constructors
Constructor and Description
`Leg()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAlert(Alert alert, Locale locale)`
`double`	`getDuration()` The leg's duration in seconds
`Boolean`	`isTransitLeg()` Whether this leg is a transit leg or not.
`void`	`setTimeZone(TimeZone timeZone)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - startTime
```
public Calendar startTime
```
    The date and time this leg begins.
  - endTime
```
public Calendar endTime
```
    The date and time this leg ends.
  - departureDelay
```
public int departureDelay
```
    For transit leg, the offset from the scheduled departure-time of the boarding stop in this leg. "scheduled time of departure at boarding stop" = startTime - departureDelay
  - arrivalDelay
```
public int arrivalDelay
```
    For transit leg, the offset from the scheduled arrival-time of the alighting stop in this leg. "scheduled time of arrival at alighting stop" = endTime - arrivalDelay
  - realTime
```
public Boolean realTime
```
    Whether there is real-time data about this Leg
  - isNonExactFrequency
```
public Boolean isNonExactFrequency
```
    Is this a frequency-based trip with non-strict departure times?
  - headway
```
public Integer headway
```
    The best estimate of the time between two arriving vehicles. This is particularly important for non-strict frequency trips, but could become important for real-time trips, strict frequency trips, and scheduled trips with empirical headways.
  - distance
```
public Double distance
```
    The distance traveled while traversing the leg in meters.
  - pathway
```
public Boolean pathway
```
    Is this leg a traversing pathways?
  - mode
```
public String mode
```
    The mode (e.g., Walk) used when traversing this leg.
  - route
```
public String route
```
    For transit legs, the route of the bus or train being used. For non-transit legs, the name of the street being traversed.
  - agencyName
```
public String agencyName
```
  - agencyUrl
```
public String agencyUrl
```
  - agencyBrandingUrl
```
public String agencyBrandingUrl
```
  - agencyTimeZoneOffset
```
public int agencyTimeZoneOffset
```
  - routeColor
```
public String routeColor
```
    For transit leg, the route's (background) color (if one exists). For non-transit legs, null.
  - routeType
```
public Integer routeType
```
    For transit legs, the type of the route. Non transit -1 When 0-7: 0 Tram, 1 Subway, 2 Train, 3 Bus, 4 Ferry, 5 Cable Car, 6 Gondola, 7 Funicular When equal or highter than 100, it is coded using the Hierarchical Vehicle Type (HVT) codes from the European TPEG standard Also see http://groups.google.com/group/gtfs-changes/msg/ed917a69cf8c5bef
  - routeId
```
public FeedScopedId routeId
```
    For transit legs, the ID of the route. For non-transit legs, null.
  - routeTextColor
```
public String routeTextColor
```
    For transit leg, the route's text color (if one exists). For non-transit legs, null.
  - interlineWithPreviousLeg
```
public Boolean interlineWithPreviousLeg
```
    For transit legs, if the rider should stay on the vehicle as it changes route names.
  - tripShortName
```
public String tripShortName
```
    For transit leg, the trip's short name (if one exists). For non-transit legs, null.
  - tripBlockId
```
public String tripBlockId
```
    For transit leg, the trip's block ID (if one exists). For non-transit legs, null.
  - headsign
```
public String headsign
```
    For transit legs, the headsign of the bus or train being used. For non-transit legs, null.
  - agencyId
```
public String agencyId
```
    For transit legs, the ID of the transit agency that operates the service used for this leg. For non-transit legs, null.
  - tripId
```
public FeedScopedId tripId
```
    For transit legs, the ID of the trip. For non-transit legs, null.
  - serviceDate
```
public String serviceDate
```
    For transit legs, the service date of the trip. For non-transit legs, null.
  - routeBrandingUrl
```
public String routeBrandingUrl
```
    For transit leg, the route's branding URL (if one exists). For non-transit legs, null.
  - from
```
public Place from
```
    The Place where the leg originates.
  - to
```
public Place to
```
    The Place where the leg begins.
  - stop
```
public List<Place> stop
```
    For transit legs, intermediate stops between the Place where the leg originates and the Place where the leg ends. For non-transit legs, null. This field is optional i.e. it is always null unless "showIntermediateStops" parameter is set to "true" in the planner request.
  - legGeometry
```
public EncodedPolylineBean legGeometry
```
    The leg's geometry.
  - walkSteps
```
public List<WalkStep> walkSteps
```
    A series of turn by turn instructions used for walking, biking and driving.
  - alerts
```
public List<LocalizedAlert> alerts
```
  - routeShortName
```
public String routeShortName
```
  - routeLongName
```
public String routeLongName
```
  - boardRule
```
public String boardRule
```
  - alightRule
```
public String alightRule
```
  - rentedBike
```
public Boolean rentedBike
```
  - callAndRide
```
public Boolean callAndRide
```
    True if this is a call-and-ride leg.
  - flexCallAndRideMaxStartTime
```
public Calendar flexCallAndRideMaxStartTime
```
  - flexCallAndRideMinEndTime
```
public Calendar flexCallAndRideMinEndTime
```
  - flexDrtAdvanceBookMin
```
public double flexDrtAdvanceBookMin
```
    trip.drt_advance_book_min if this is a demand-response leg
  - flexDrtPickupMessage
```
public String flexDrtPickupMessage
```
    Agency message if this is leg has a demand-response pickup and the Trip has `drt_pickup_message` defined.
  - flexDrtDropOffMessage
```
public String flexDrtDropOffMessage
```
    Agency message if this is leg has a demand-response dropoff and the Trip has `drt_drop_off_message` defined.
  - flexFlagStopPickupMessage
```
public String flexFlagStopPickupMessage
```
    Agency message if this is leg has a flag stop pickup and the Trip has `continuous_pickup_message` defined.
  - flexFlagStopDropOffMessage
```
public String flexFlagStopDropOffMessage
```
    Agency message if this is leg has a flag stop dropoff and the Trip has `continuous_drop_off_message` defined.
- Constructor Detail
  - Leg
```
public Leg()
```
- Method Detail
  - isTransitLeg
```
public Boolean isTransitLeg()
```
    Whether this leg is a transit leg or not.
    
    Returns:
    
    Boolean true if the leg is a transit leg
  - getDuration
```
public double getDuration()
```
    The leg's duration in seconds
  - addAlert
```
public void addAlert(Alert alert,
                     Locale locale)
```
  - setTimeZone
```
public void setTimeZone(TimeZone timeZone)
```

Class Leg

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

startTime

endTime

departureDelay

arrivalDelay

realTime

isNonExactFrequency

headway

distance

pathway

mode

route

agencyName

agencyUrl

agencyBrandingUrl

agencyTimeZoneOffset

routeColor

routeType

routeId

routeTextColor

interlineWithPreviousLeg

tripShortName

tripBlockId

headsign

agencyId

tripId

serviceDate

routeBrandingUrl

from

to

stop

legGeometry

walkSteps

alerts

routeShortName

routeLongName

boardRule

alightRule

rentedBike

callAndRide

flexCallAndRideMaxStartTime

flexCallAndRideMinEndTime

flexDrtAdvanceBookMin

flexDrtPickupMessage

flexDrtDropOffMessage

flexFlagStopPickupMessage

flexFlagStopDropOffMessage

Constructor Detail

Leg

Method Detail

isTransitLeg

getDuration

addAlert

setTimeZone