TripPattern Data Type

Represents a group of trips on a route, with the same direction id that all call at the same sequence of stops. For each stop, there is a list of departure times, running times, arrival times, dwell times, and wheelchair accessibility information (one of each of these per trip per stop). Trips are assumed to be non-overtaking, so that an earlier trip never arrives after a later trip.

This is called a JOURNEY_PATTERN in the Transmodel vocabulary. However, GTFS calls a Transmodel JOURNEY a "trip", thus TripPattern.

The id is a unique identifier for this trip pattern. For GTFS feeds this is generally generated in the format FeedId:Agency:RouteId:DirectionId:PatternNumber. For NeTEx the JourneyPattern id is used.

Implemented Interfaces
Cloneable, LogInfo
Properties
name data type constraints description
name string   The human-readable, unique name for this trip pattern.
route Route   The GTFS Route of all trips in this pattern.
mode TransitMode   Convenience method to get the route traverse mode, the mode for all trips in this pattern.
stopPattern StopPattern  
geometry LineString  
stops array of StopLocation   Read only list of stops
direction Direction   The direction for all the trips in this pattern.
scheduledTimetable Timetable   This is the "original" timetable holding the scheduled stop times from GTFS, with no realtime updates applied. If realtime stoptime updates are applied, next/previous departure searches will be conducted using a different, updated timetable in a snapshot.
createdByRealtimeUpdater boolean required Has the TripPattern been created by a real-time update.
originalTripPattern TripPattern  
tripHeadsign I18NString  
feedId string   Get the feed id this trip pattern belongs to.
routingTripPattern RoutingTripPattern  
Properties inherited from AbstractTransitEntity
id FeedScopedId  

Example

{
  "name" : "...",
  "route" : {
    "agency" : {
      "name" : "...",
      "timezone" : "...",
      "url" : "...",
      "lang" : "...",
      "phone" : "...",
      "fareUrl" : "...",
      "brandingUrl" : "...",
      "id" : { }
    },
    "operator" : {
      "name" : "...",
      "url" : "...",
      "phone" : "...",
      "id" : { }
    },
    "branding" : {
      "name" : "...",
      "shortName" : "...",
      "url" : "...",
      "image" : "...",
      "description" : "...",
      "id" : { }
    },
    "groupsOfRoutes" : [ {
      "name" : "...",
      "shortName" : "...",
      "privateCode" : "...",
      "description" : "...",
      "id" : { }
    }, {
      "name" : "...",
      "shortName" : "...",
      "privateCode" : "...",
      "description" : "...",
      "id" : { }
    } ],
    "shortName" : "...",
    "longName" : { },
    "mode" : "FUNICULAR",
    "description" : "...",
    "gtfsType" : 12345,
    "gtfsSortOrder" : 12345,
    "netexSubmode" : { },
    "url" : "...",
    "color" : "...",
    "textColor" : "...",
    "bikesAllowed" : "ALLOWED",
    "flexibleLineType" : "...",
    "name" : "...",
    "id" : {
      "feedId" : "...",
      "id" : "..."
    }
  },
  "mode" : "COACH",
  "stopPattern" : {
    "size" : 12345
  },
  "geometry" : {
    "coordinate" : {
      "y" : 12345.0,
      "z" : 12345.0,
      "x" : 12345.0,
      "m" : 12345.0,
      "valid" : true
    },
    "boundary" : {
      "envelope" : { },
      "length" : 12345.0,
      "geometryType" : "...",
      "boundary" : { },
      "rectangle" : true,
      "centroid" : { },
      "simple" : true,
      "interiorPoint" : { },
      "factory" : { },
      "valid" : true,
      "coordinate" : { },
      "precisionModel" : { },
      "envelopeInternal" : { },
      "boundaryDimension" : 12345,
      "dimension" : 12345,
      "area" : 12345.0,
      "empty" : true,
      "userData" : { },
      "numGeometries" : 12345,
      "numPoints" : 12345,
      "SRID" : 12345,
      "coordinates" : [ { }, { } ]
    },
    "empty" : true,
    "boundaryDimension" : 12345,
    "coordinateSequence" : {
      "dimension" : 12345,
      "measures" : 12345
    },
    "coordinates" : [ {
      "y" : 12345.0,
      "z" : 12345.0,
      "x" : 12345.0,
      "m" : 12345.0,
      "valid" : true
    }, {
      "y" : 12345.0,
      "z" : 12345.0,
      "x" : 12345.0,
      "m" : 12345.0,
      "valid" : true
    } ],
    "ring" : true,
    "length" : 12345.0,
    "numPoints" : 12345,
    "closed" : true,
    "startPoint" : {
      "simple" : true,
      "x" : 12345.0,
      "boundaryDimension" : 12345,
      "coordinateSequence" : { },
      "coordinate" : { },
      "geometryType" : "...",
      "y" : 12345.0,
      "empty" : true,
      "dimension" : 12345,
      "coordinates" : [ { }, { } ],
      "boundary" : { },
      "numPoints" : 12345,
      "envelope" : { },
      "length" : 12345.0,
      "rectangle" : true,
      "centroid" : { },
      "interiorPoint" : { },
      "factory" : { },
      "valid" : true,
      "precisionModel" : { },
      "envelopeInternal" : { },
      "area" : 12345.0,
      "userData" : { },
      "numGeometries" : 12345,
      "SRID" : 12345
    },
    "endPoint" : {
      "simple" : true,
      "x" : 12345.0,
      "boundaryDimension" : 12345,
      "coordinateSequence" : { },
      "coordinate" : { },
      "geometryType" : "...",
      "y" : 12345.0,
      "empty" : true,
      "dimension" : 12345,
      "coordinates" : [ { }, { } ],
      "boundary" : { },
      "numPoints" : 12345,
      "envelope" : { },
      "length" : 12345.0,
      "rectangle" : true,
      "centroid" : { },
      "interiorPoint" : { },
      "factory" : { },
      "valid" : true,
      "precisionModel" : { },
      "envelopeInternal" : { },
      "area" : 12345.0,
      "userData" : { },
      "numGeometries" : 12345,
      "SRID" : 12345
    },
    "geometryType" : "...",
    "dimension" : 12345,
    "envelope" : {
      "envelope" : { },
      "length" : 12345.0,
      "geometryType" : "...",
      "boundary" : { },
      "rectangle" : true,
      "centroid" : { },
      "simple" : true,
      "interiorPoint" : { },
      "factory" : { },
      "valid" : true,
      "coordinate" : { },
      "precisionModel" : { },
      "envelopeInternal" : { },
      "boundaryDimension" : 12345,
      "dimension" : 12345,
      "area" : 12345.0,
      "empty" : true,
      "userData" : { },
      "numGeometries" : 12345,
      "numPoints" : 12345,
      "SRID" : 12345,
      "coordinates" : [ { }, { } ]
    },
    "rectangle" : true,
    "centroid" : {
      "simple" : true,
      "x" : 12345.0,
      "boundaryDimension" : 12345,
      "coordinateSequence" : { },
      "coordinate" : { },
      "geometryType" : "...",
      "y" : 12345.0,
      "empty" : true,
      "dimension" : 12345,
      "coordinates" : [ { }, { } ],
      "boundary" : { },
      "numPoints" : 12345,
      "envelope" : { },
      "length" : 12345.0,
      "rectangle" : true,
      "centroid" : { },
      "interiorPoint" : { },
      "factory" : { },
      "valid" : true,
      "precisionModel" : { },
      "envelopeInternal" : { },
      "area" : 12345.0,
      "userData" : { },
      "numGeometries" : 12345,
      "SRID" : 12345
    },
    "simple" : true,
    "interiorPoint" : {
      "simple" : true,
      "x" : 12345.0,
      "boundaryDimension" : 12345,
      "coordinateSequence" : { },
      "coordinate" : { },
      "geometryType" : "...",
      "y" : 12345.0,
      "empty" : true,
      "dimension" : 12345,
      "coordinates" : [ { }, { } ],
      "boundary" : { },
      "numPoints" : 12345,
      "envelope" : { },
      "length" : 12345.0,
      "rectangle" : true,
      "centroid" : { },
      "interiorPoint" : { },
      "factory" : { },
      "valid" : true,
      "precisionModel" : { },
      "envelopeInternal" : { },
      "area" : 12345.0,
      "userData" : { },
      "numGeometries" : 12345,
      "SRID" : 12345
    },
    "factory" : {
      "precisionModel" : { },
      "SRID" : 12345,
      "coordinateSequenceFactory" : { }
    },
    "valid" : true,
    "precisionModel" : {
      "offsetX" : 12345.0,
      "scale" : 12345.0,
      "type" : { },
      "floating" : true,
      "offsetY" : 12345.0,
      "maximumSignificantDigits" : 12345
    },
    "envelopeInternal" : {
      "width" : 12345.0,
      "area" : 12345.0,
      "minX" : 12345.0,
      "diameter" : 12345.0,
      "null" : true,
      "height" : 12345.0,
      "maxX" : 12345.0,
      "minY" : 12345.0,
      "maxY" : 12345.0
    },
    "area" : 12345.0,
    "userData" : { },
    "numGeometries" : 12345,
    "SRID" : 12345
  },
  "stops" : [ {
    "id" : {
      "feedId" : "...",
      "id" : "..."
    },
    "geometry" : {
      "envelope" : { },
      "length" : 12345.0,
      "geometryType" : "...",
      "boundary" : { },
      "rectangle" : true,
      "centroid" : { },
      "simple" : true,
      "interiorPoint" : { },
      "factory" : { },
      "valid" : true,
      "coordinate" : { },
      "precisionModel" : { },
      "envelopeInternal" : { },
      "boundaryDimension" : 12345,
      "dimension" : 12345,
      "area" : 12345.0,
      "empty" : true,
      "userData" : { },
      "numGeometries" : 12345,
      "numPoints" : 12345,
      "SRID" : 12345,
      "coordinates" : [ { }, { } ]
    },
    "lon" : 12345.0,
    "parentStation" : {
      "name" : { },
      "childStops" : [ { }, { } ],
      "lat" : 12345.0,
      "lon" : 12345.0,
      "coordinate" : { },
      "code" : "...",
      "description" : { },
      "url" : { },
      "priority" : "RECOMMENDED",
      "timezone" : "...",
      "transfersNotAllowed" : true,
      "geometry" : { },
      "id" : { }
    },
    "netexVehicleSubmode" : { },
    "wheelchairAccessibility" : "NOT_POSSIBLE",
    "stationOrStopId" : {
      "feedId" : "...",
      "id" : "..."
    },
    "code" : "...",
    "timeZone" : "...",
    "lat" : 12345.0,
    "platformCode" : "...",
    "fareZones" : [ {
      "name" : "...",
      "id" : { }
    }, {
      "name" : "...",
      "id" : { }
    } ],
    "index" : 12345,
    "description" : { },
    "gtfsVehicleType" : "GONDOLA",
    "name" : { },
    "partOfStation" : true,
    "coordinate" : { },
    "url" : { },
    "priority" : "ALLOWED",
    "firstZoneAsString" : "..."
  }, {
    "id" : {
      "feedId" : "...",
      "id" : "..."
    },
    "geometry" : {
      "envelope" : { },
      "length" : 12345.0,
      "geometryType" : "...",
      "boundary" : { },
      "rectangle" : true,
      "centroid" : { },
      "simple" : true,
      "interiorPoint" : { },
      "factory" : { },
      "valid" : true,
      "coordinate" : { },
      "precisionModel" : { },
      "envelopeInternal" : { },
      "boundaryDimension" : 12345,
      "dimension" : 12345,
      "area" : 12345.0,
      "empty" : true,
      "userData" : { },
      "numGeometries" : 12345,
      "numPoints" : 12345,
      "SRID" : 12345,
      "coordinates" : [ { }, { } ]
    },
    "lon" : 12345.0,
    "parentStation" : {
      "name" : { },
      "childStops" : [ { }, { } ],
      "lat" : 12345.0,
      "lon" : 12345.0,
      "coordinate" : { },
      "code" : "...",
      "description" : { },
      "url" : { },
      "priority" : "PREFERRED",
      "timezone" : "...",
      "transfersNotAllowed" : true,
      "geometry" : { },
      "id" : { }
    },
    "netexVehicleSubmode" : { },
    "wheelchairAccessibility" : "POSSIBLE",
    "stationOrStopId" : {
      "feedId" : "...",
      "id" : "..."
    },
    "code" : "...",
    "timeZone" : "...",
    "lat" : 12345.0,
    "platformCode" : "...",
    "fareZones" : [ {
      "name" : "...",
      "id" : { }
    }, {
      "name" : "...",
      "id" : { }
    } ],
    "index" : 12345,
    "description" : { },
    "gtfsVehicleType" : "TROLLEYBUS",
    "name" : { },
    "partOfStation" : true,
    "coordinate" : { },
    "url" : { },
    "priority" : "RECOMMENDED",
    "firstZoneAsString" : "..."
  } ],
  "direction" : "INBOUND",
  "scheduledTimetable" : {
    "pattern" : {
      "name" : "...",
      "route" : { },
      "mode" : "FERRY",
      "stopPattern" : { },
      "geometry" : { },
      "stops" : [ { }, { } ],
      "direction" : "ANTICLOCKWISE",
      "scheduledTimetable" : { },
      "createdByRealtimeUpdater" : true,
      "originalTripPattern" : { },
      "tripHeadsign" : { },
      "feedId" : "...",
      "routingTripPattern" : { },
      "id" : { }
    },
    "tripTimes" : [ {
      "wheelchairAccessibility" : "NO_INFORMATION",
      "scheduled" : true,
      "canceled" : true,
      "realTimeState" : "CANCELED",
      "numStops" : 12345,
      "serviceCode" : 12345,
      "trip" : { }
    }, {
      "wheelchairAccessibility" : "NO_INFORMATION",
      "scheduled" : true,
      "canceled" : true,
      "realTimeState" : "UPDATED",
      "numStops" : 12345,
      "serviceCode" : 12345,
      "trip" : { }
    } ],
    "frequencyEntries" : [ {
      "startTime" : 12345,
      "endTime" : 12345,
      "headway" : 12345,
      "exactTimes" : true,
      "tripTimes" : { }
    }, {
      "startTime" : 12345,
      "endTime" : 12345,
      "headway" : 12345,
      "exactTimes" : true,
      "tripTimes" : { }
    } ],
    "serviceDate" : "...",
    "direction" : "CLOCKWISE",
    "representativeTripTimes" : {
      "wheelchairAccessibility" : "NO_INFORMATION",
      "scheduled" : true,
      "canceled" : true,
      "realTimeState" : "UPDATED",
      "numStops" : 12345,
      "serviceCode" : 12345,
      "trip" : { }
    }
  },
  "createdByRealtimeUpdater" : true,
  "originalTripPattern" : {
    "name" : "...",
    "route" : {
      "agency" : { },
      "operator" : { },
      "branding" : { },
      "groupsOfRoutes" : [ { }, { } ],
      "shortName" : "...",
      "longName" : { },
      "mode" : "COACH",
      "description" : "...",
      "gtfsType" : 12345,
      "gtfsSortOrder" : 12345,
      "netexSubmode" : { },
      "url" : "...",
      "color" : "...",
      "textColor" : "...",
      "bikesAllowed" : "NOT_ALLOWED",
      "flexibleLineType" : "...",
      "name" : "...",
      "id" : { }
    },
    "mode" : "FUNICULAR",
    "stopPattern" : {
      "size" : 12345
    },
    "geometry" : {
      "coordinate" : { },
      "boundary" : { },
      "empty" : true,
      "boundaryDimension" : 12345,
      "coordinateSequence" : { },
      "coordinates" : [ { }, { } ],
      "ring" : true,
      "length" : 12345.0,
      "numPoints" : 12345,
      "closed" : true,
      "startPoint" : { },
      "endPoint" : { },
      "geometryType" : "...",
      "dimension" : 12345,
      "envelope" : { },
      "rectangle" : true,
      "centroid" : { },
      "simple" : true,
      "interiorPoint" : { },
      "factory" : { },
      "valid" : true,
      "precisionModel" : { },
      "envelopeInternal" : { },
      "area" : 12345.0,
      "userData" : { },
      "numGeometries" : 12345,
      "SRID" : 12345
    },
    "stops" : [ {
      "id" : { },
      "geometry" : { },
      "lon" : 12345.0,
      "parentStation" : { },
      "netexVehicleSubmode" : { },
      "wheelchairAccessibility" : "NOT_POSSIBLE",
      "stationOrStopId" : { },
      "code" : "...",
      "timeZone" : "...",
      "lat" : 12345.0,
      "platformCode" : "...",
      "fareZones" : [ { }, { } ],
      "index" : 12345,
      "description" : { },
      "gtfsVehicleType" : "GONDOLA",
      "name" : { },
      "partOfStation" : true,
      "coordinate" : { },
      "url" : { },
      "priority" : "ALLOWED",
      "firstZoneAsString" : "..."
    }, {
      "id" : { },
      "geometry" : { },
      "lon" : 12345.0,
      "parentStation" : { },
      "netexVehicleSubmode" : { },
      "wheelchairAccessibility" : "POSSIBLE",
      "stationOrStopId" : { },
      "code" : "...",
      "timeZone" : "...",
      "lat" : 12345.0,
      "platformCode" : "...",
      "fareZones" : [ { }, { } ],
      "index" : 12345,
      "description" : { },
      "gtfsVehicleType" : "MONORAIL",
      "name" : { },
      "partOfStation" : true,
      "coordinate" : { },
      "url" : { },
      "priority" : "DISCOURAGED",
      "firstZoneAsString" : "..."
    } ],
    "direction" : "INBOUND",
    "scheduledTimetable" : {
      "pattern" : { },
      "tripTimes" : [ { }, { } ],
      "frequencyEntries" : [ { }, { } ],
      "serviceDate" : "...",
      "direction" : "OUTBOUND",
      "representativeTripTimes" : { }
    },
    "createdByRealtimeUpdater" : true,
    "originalTripPattern" : { },
    "tripHeadsign" : { },
    "feedId" : "...",
    "routingTripPattern" : {
      "pattern" : { },
      "boardingPossible" : { },
      "alightingPossible" : { },
      "wheelchairAccessible" : { }
    },
    "id" : {
      "feedId" : "...",
      "id" : "..."
    }
  },
  "tripHeadsign" : { },
  "feedId" : "...",
  "routingTripPattern" : {
    "pattern" : {
      "name" : "...",
      "route" : { },
      "mode" : "FERRY",
      "stopPattern" : { },
      "geometry" : { },
      "stops" : [ { }, { } ],
      "direction" : "UNKNOWN",
      "scheduledTimetable" : { },
      "createdByRealtimeUpdater" : true,
      "originalTripPattern" : { },
      "tripHeadsign" : { },
      "feedId" : "...",
      "routingTripPattern" : { },
      "id" : { }
    },
    "boardingPossible" : {
      "empty" : true
    },
    "alightingPossible" : {
      "empty" : true
    },
    "wheelchairAccessible" : {
      "empty" : true
    }
  },
  "id" : {
    "feedId" : "...",
    "id" : "..."
  }
}