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, Serializable
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.
netexSubmode string  
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.
services BitSet   bitset of service codes
tripHeadsign string  
feedId string   Get the feed id this trip pattern belongs to.
Properties inherited from TransitEntity
id FeedScopedId  

Example

{
  "name" : "...",
  "route" : {
    "branding" : {
      "shortName" : "...",
      "name" : "...",
      "url" : "...",
      "image" : "...",
      "description" : "...",
      "id" : { }
    },
    "agency" : {
      "name" : "...",
      "url" : "...",
      "timezone" : "...",
      "lang" : "...",
      "phone" : "...",
      "fareUrl" : "...",
      "brandingUrl" : "...",
      "id" : { }
    },
    "operator" : {
      "name" : "...",
      "url" : "...",
      "phone" : "...",
      "id" : { }
    },
    "shortName" : "...",
    "longName" : "...",
    "desc" : "...",
    "gtfsType" : 12345,
    "mode" : "COACH",
    "url" : "...",
    "color" : "...",
    "textColor" : "...",
    "bikesAllowed" : "NOT_ALLOWED",
    "sortOrderSet" : true,
    "sortOrder" : 12345,
    "flexibleLineType" : "...",
    "name" : "...",
    "netexSubmode" : "...",
    "id" : {
      "feedId" : "...",
      "id" : "..."
    }
  },
  "mode" : "GONDOLA",
  "netexSubmode" : "...",
  "geometry" : {
    "closed" : true,
    "endPoint" : {
      "boundaryDimension" : 12345,
      "x" : 12345.0,
      "coordinates" : [ { }, { } ],
      "coordinate" : { },
      "simple" : true,
      "numPoints" : 12345,
      "dimension" : 12345,
      "boundary" : { },
      "geometryType" : "...",
      "coordinateSequence" : { },
      "empty" : true,
      "y" : 12345.0,
      "length" : 12345.0,
      "numGeometries" : 12345,
      "precisionModel" : { },
      "interiorPoint" : { },
      "rectangle" : true,
      "area" : 12345.0,
      "envelopeInternal" : { },
      "centroid" : { },
      "factory" : { },
      "SRID" : 12345,
      "userData" : { },
      "envelope" : { },
      "valid" : true
    },
    "dimension" : 12345,
    "empty" : true,
    "numPoints" : 12345,
    "geometryType" : "...",
    "coordinateSequence" : {
      "measures" : 12345,
      "dimension" : 12345
    },
    "length" : 12345.0,
    "boundaryDimension" : 12345,
    "startPoint" : {
      "boundaryDimension" : 12345,
      "x" : 12345.0,
      "coordinates" : [ { }, { } ],
      "coordinate" : { },
      "simple" : true,
      "numPoints" : 12345,
      "dimension" : 12345,
      "boundary" : { },
      "geometryType" : "...",
      "coordinateSequence" : { },
      "empty" : true,
      "y" : 12345.0,
      "length" : 12345.0,
      "numGeometries" : 12345,
      "precisionModel" : { },
      "interiorPoint" : { },
      "rectangle" : true,
      "area" : 12345.0,
      "envelopeInternal" : { },
      "centroid" : { },
      "factory" : { },
      "SRID" : 12345,
      "userData" : { },
      "envelope" : { },
      "valid" : true
    },
    "coordinates" : [ {
      "x" : 12345.0,
      "y" : 12345.0,
      "z" : 12345.0,
      "m" : 12345.0,
      "valid" : true
    }, {
      "x" : 12345.0,
      "y" : 12345.0,
      "z" : 12345.0,
      "m" : 12345.0,
      "valid" : true
    } ],
    "coordinate" : {
      "x" : 12345.0,
      "y" : 12345.0,
      "z" : 12345.0,
      "m" : 12345.0,
      "valid" : true
    },
    "boundary" : {
      "length" : 12345.0,
      "numGeometries" : 12345,
      "precisionModel" : { },
      "interiorPoint" : { },
      "rectangle" : true,
      "area" : 12345.0,
      "boundary" : { },
      "boundaryDimension" : 12345,
      "numPoints" : 12345,
      "coordinates" : [ { }, { } ],
      "dimension" : 12345,
      "envelopeInternal" : { },
      "empty" : true,
      "coordinate" : { },
      "centroid" : { },
      "factory" : { },
      "SRID" : 12345,
      "simple" : true,
      "userData" : { },
      "geometryType" : "...",
      "envelope" : { },
      "valid" : true
    },
    "ring" : true,
    "numGeometries" : 12345,
    "precisionModel" : {
      "scale" : 12345.0,
      "floating" : true,
      "maximumSignificantDigits" : 12345,
      "type" : { },
      "offsetX" : 12345.0,
      "offsetY" : 12345.0
    },
    "interiorPoint" : {
      "boundaryDimension" : 12345,
      "x" : 12345.0,
      "coordinates" : [ { }, { } ],
      "coordinate" : { },
      "simple" : true,
      "numPoints" : 12345,
      "dimension" : 12345,
      "boundary" : { },
      "geometryType" : "...",
      "coordinateSequence" : { },
      "empty" : true,
      "y" : 12345.0,
      "length" : 12345.0,
      "numGeometries" : 12345,
      "precisionModel" : { },
      "interiorPoint" : { },
      "rectangle" : true,
      "area" : 12345.0,
      "envelopeInternal" : { },
      "centroid" : { },
      "factory" : { },
      "SRID" : 12345,
      "userData" : { },
      "envelope" : { },
      "valid" : true
    },
    "rectangle" : true,
    "area" : 12345.0,
    "envelopeInternal" : {
      "width" : 12345.0,
      "null" : true,
      "diameter" : 12345.0,
      "area" : 12345.0,
      "minY" : 12345.0,
      "height" : 12345.0,
      "maxX" : 12345.0,
      "maxY" : 12345.0,
      "minX" : 12345.0
    },
    "centroid" : {
      "boundaryDimension" : 12345,
      "x" : 12345.0,
      "coordinates" : [ { }, { } ],
      "coordinate" : { },
      "simple" : true,
      "numPoints" : 12345,
      "dimension" : 12345,
      "boundary" : { },
      "geometryType" : "...",
      "coordinateSequence" : { },
      "empty" : true,
      "y" : 12345.0,
      "length" : 12345.0,
      "numGeometries" : 12345,
      "precisionModel" : { },
      "interiorPoint" : { },
      "rectangle" : true,
      "area" : 12345.0,
      "envelopeInternal" : { },
      "centroid" : { },
      "factory" : { },
      "SRID" : 12345,
      "userData" : { },
      "envelope" : { },
      "valid" : true
    },
    "factory" : {
      "precisionModel" : { },
      "SRID" : 12345,
      "coordinateSequenceFactory" : { }
    },
    "SRID" : 12345,
    "simple" : true,
    "userData" : { },
    "envelope" : {
      "length" : 12345.0,
      "numGeometries" : 12345,
      "precisionModel" : { },
      "interiorPoint" : { },
      "rectangle" : true,
      "area" : 12345.0,
      "boundary" : { },
      "boundaryDimension" : 12345,
      "numPoints" : 12345,
      "coordinates" : [ { }, { } ],
      "dimension" : 12345,
      "envelopeInternal" : { },
      "empty" : true,
      "coordinate" : { },
      "centroid" : { },
      "factory" : { },
      "SRID" : 12345,
      "simple" : true,
      "userData" : { },
      "geometryType" : "...",
      "envelope" : { },
      "valid" : true
    },
    "valid" : true
  },
  "stops" : [ {
    "geometry" : {
      "length" : 12345.0,
      "numGeometries" : 12345,
      "precisionModel" : { },
      "interiorPoint" : { },
      "rectangle" : true,
      "area" : 12345.0,
      "boundary" : { },
      "boundaryDimension" : 12345,
      "numPoints" : 12345,
      "coordinates" : [ { }, { } ],
      "dimension" : 12345,
      "envelopeInternal" : { },
      "empty" : true,
      "coordinate" : { },
      "centroid" : { },
      "factory" : { },
      "SRID" : 12345,
      "simple" : true,
      "userData" : { },
      "geometryType" : "...",
      "envelope" : { },
      "valid" : true
    },
    "parentStation" : {
      "name" : "...",
      "coordinate" : { },
      "code" : "...",
      "description" : "...",
      "url" : "...",
      "priority" : "RECOMMENDED",
      "timezone" : { },
      "childStops" : [ { }, { } ],
      "lat" : 12345.0,
      "lon" : 12345.0,
      "geometry" : { },
      "id" : { }
    },
    "platformCode" : "...",
    "name" : "...",
    "partOfStation" : true,
    "lon" : 12345.0,
    "firstZoneAsString" : "...",
    "description" : "...",
    "vehicleSubmode" : "...",
    "fareZones" : [ {
      "name" : "...",
      "id" : { }
    }, {
      "name" : "...",
      "id" : { }
    } ],
    "priority" : "DISCOURAGED",
    "timeZone" : {
      "rawOffset" : 12345,
      "DSTSavings" : 12345,
      "availableIDs" : [ "...", "..." ],
      "default" : { },
      "displayName" : "...",
      "ID" : "..."
    },
    "url" : "...",
    "code" : "...",
    "wheelchairBoarding" : "NO_INFORMATION",
    "lat" : 12345.0,
    "id" : {
      "feedId" : "...",
      "id" : "..."
    },
    "coordinate" : { },
    "vehicleType" : "MONORAIL"
  }, {
    "geometry" : {
      "length" : 12345.0,
      "numGeometries" : 12345,
      "precisionModel" : { },
      "interiorPoint" : { },
      "rectangle" : true,
      "area" : 12345.0,
      "boundary" : { },
      "boundaryDimension" : 12345,
      "numPoints" : 12345,
      "coordinates" : [ { }, { } ],
      "dimension" : 12345,
      "envelopeInternal" : { },
      "empty" : true,
      "coordinate" : { },
      "centroid" : { },
      "factory" : { },
      "SRID" : 12345,
      "simple" : true,
      "userData" : { },
      "geometryType" : "...",
      "envelope" : { },
      "valid" : true
    },
    "parentStation" : {
      "name" : "...",
      "coordinate" : { },
      "code" : "...",
      "description" : "...",
      "url" : "...",
      "priority" : "RECOMMENDED",
      "timezone" : { },
      "childStops" : [ { }, { } ],
      "lat" : 12345.0,
      "lon" : 12345.0,
      "geometry" : { },
      "id" : { }
    },
    "platformCode" : "...",
    "name" : "...",
    "partOfStation" : true,
    "lon" : 12345.0,
    "firstZoneAsString" : "...",
    "description" : "...",
    "vehicleSubmode" : "...",
    "fareZones" : [ {
      "name" : "...",
      "id" : { }
    }, {
      "name" : "...",
      "id" : { }
    } ],
    "priority" : "ALLOWED",
    "timeZone" : {
      "rawOffset" : 12345,
      "DSTSavings" : 12345,
      "availableIDs" : [ "...", "..." ],
      "default" : { },
      "displayName" : "...",
      "ID" : "..."
    },
    "url" : "...",
    "code" : "...",
    "wheelchairBoarding" : "NO_INFORMATION",
    "lat" : 12345.0,
    "id" : {
      "feedId" : "...",
      "id" : "..."
    },
    "coordinate" : { },
    "vehicleType" : "CABLE_CAR"
  } ],
  "direction" : "CLOCKWISE",
  "scheduledTimetable" : {
    "pattern" : {
      "name" : "...",
      "route" : { },
      "mode" : "AIRPLANE",
      "netexSubmode" : "...",
      "geometry" : { },
      "stops" : [ { }, { } ],
      "direction" : "CLOCKWISE",
      "scheduledTimetable" : { },
      "createdByRealtimeUpdater" : true,
      "services" : { },
      "tripHeadsign" : "...",
      "feedId" : "...",
      "id" : { }
    },
    "tripTimes" : [ {
      "scheduled" : true,
      "canceled" : true,
      "realTimeState" : "SCHEDULED",
      "numStops" : 12345,
      "serviceCode" : 12345,
      "trip" : { }
    }, {
      "scheduled" : true,
      "canceled" : true,
      "realTimeState" : "MODIFIED",
      "numStops" : 12345,
      "serviceCode" : 12345,
      "trip" : { }
    } ],
    "frequencyEntries" : [ {
      "startTime" : 12345,
      "endTime" : 12345,
      "headway" : 12345,
      "exactTimes" : true,
      "tripTimes" : { },
      "minDeparture" : 12345,
      "maxArrival" : 12345
    }, {
      "startTime" : 12345,
      "endTime" : 12345,
      "headway" : 12345,
      "exactTimes" : true,
      "tripTimes" : { },
      "minDeparture" : 12345,
      "maxArrival" : 12345
    } ],
    "serviceDate" : {
      "year" : 12345,
      "month" : 12345,
      "day" : 12345,
      "minMax" : true
    },
    "direction" : "UNKNOWN"
  },
  "createdByRealtimeUpdater" : true,
  "services" : {
    "empty" : true
  },
  "tripHeadsign" : "...",
  "feedId" : "...",
  "id" : {
    "feedId" : "...",
    "id" : "..."
  }
}