gtfs-schedule/dev.sargunv.mobilitydata.gtfs.schedule

Package-level declarations

Types

data class Agency(val agencyId: String? = null, val agencyName: String, val agencyUrl: Url, val agencyTimezone: TimeZone, val agencyLang: LanguageCode? = null, val agencyPhone: String? = null, val agencyFareUrl: Url? = null, val agencyEmail: String? = null, val cemvSupport: TriState? = null)

Transit agencies with service represented in this dataset.

data class Area(val areaId: String, val areaName: String? = null)

Defines area IDs.

data class Attribution(val attributionId: String? = null, val agencyId: String? = null, val routeId: String? = null, val tripId: String? = null, val organizationName: String, val isProducer: IntBoolean? = null, val isOperator: IntBoolean? = null, val isAuthority: IntBoolean? = null, val attributionUrl: Url? = null, val attributionEmail: String? = null, val attributionPhone: String? = null)

Dataset attributions.

typealias Block = Nothing

Placeholder type for GTFS trip blocks.

data class BookingRule(val bookingRuleId: String, val bookingType: BookingType, val priorNoticeDurationMin: WholeMinutes? = null, val priorNoticeDurationMax: WholeMinutes? = null, val priorNoticeLastDay: Int? = null, val priorNoticeLastTime: ServiceTime? = null, val priorNoticeStartDay: Int? = null, val priorNoticeStartTime: ServiceTime? = null, val priorNoticeServiceId: String? = null, val message: String? = null, val pickupMessage: String? = null, val dropOffMessage: String? = null, val phoneNumber: String? = null, val infoUrl: Url? = null, val bookingUrl: Url? = null)

Booking rules for rider-requested services.

value class BookingType

Indicates when booking can be made.

ContinuousPickupDropOff

value class ContinuousPickupDropOff

Indicates continuous pickup or drop off behavior.

value class DirectionId

Indicates the direction of travel for a trip.

DurationLimitType

value class DurationLimitType

Defines the relative start and end of a transfer duration limit.

data class FareAttribute(val fareId: String, val price: Double, val currencyType: CurrencyCode, val paymentMethod: PaymentMethod, val transfers: Int?, val agencyId: String? = null, val transferDuration: WholeSeconds? = null)

Fare information for a transit agency's routes.

FareLegJoinRule

data class FareLegJoinRule(val fromNetworkId: String, val toNetworkId: String, val fromStopId: String? = null, val toStopId: String? = null)

Defines when two consecutive legs with a transfer should be considered as a single effective fare leg.

data class FareLegRule(val legGroupId: String? = null, val networkId: String? = null, val fromAreaId: String? = null, val toAreaId: String? = null, val fromTimeframeGroupId: String? = null, val toTimeframeGroupId: String? = null, val fareProductId: String, val rulePriority: Int? = null)

Fare rules for individual legs of travel.

data class FareMedia(val fareMediaId: String, val fareMediaName: String? = null, val fareMediaType: FareMediaType)

Describes the different fare media that can be employed to use fare products.

value class FareMediaType

Type of fare media.

data class FareProduct(val fareProductId: String, val fareProductName: String? = null, val riderCategoryId: String? = null, val fareMediaId: String? = null, val amount: Double, val currency: CurrencyCode)

Describes the range of fares available for purchase by riders.

data class FareRule(val fareId: String, val routeId: String? = null, val originId: String? = null, val destinationId: String? = null, val containsId: String? = null)

Rules to apply fares for itineraries.

FareTransferRule

data class FareTransferRule(val fromLegGroupId: String? = null, val toLegGroupId: String? = null, val transferCount: Int? = null, val durationLimit: WholeSeconds? = null, val durationLimitType: DurationLimitType? = null, val fareTransferType: FareTransferType, val fareProductId: String? = null)

Fare rules for transfers between legs of travel.

FareTransferType

value class FareTransferType

Indicates the cost processing method of transferring between legs.

data class FeedInfo(val feedPublisherName: String, val feedPublisherUrl: Url, val feedLang: LanguageCode, val defaultLang: LanguageCode? = null, val feedStartDate: BasicLocalDate? = null, val feedEndDate: BasicLocalDate? = null, val feedVersion: String? = null, val feedContactEmail: String? = null, val feedContactUrl: Url? = null)

Dataset metadata.

data class Frequency(val tripId: String, val startTime: ServiceTime, val endTime: ServiceTime, val headwaySecs: WholeSeconds, val exactTimes: IntBoolean? = null)

Headway (time between trips) for routes with variable frequency of service.

data class Level(val levelId: String, val levelIndex: Double, val levelName: String? = null)

Levels in a station.

typealias Location = Feature<PolygonGeometry, LocationProperties>

Defines a zone where riders can request either pickup or drop off by on-demand services.

data class LocationGroup(val locationGroupId: String, val locationGroupName: String? = null)

Defines location groups, which are groups of stops where a rider may request pickup or drop off.

LocationGroupStop

data class LocationGroupStop(val locationGroupId: String, val stopId: String)

Assigns stops to location groups.

LocationProperties

data class LocationProperties(val stopName: String? = null, val stopDesc: String? = null)

Properties of a Location.

typealias Locations = FeatureCollection<PolygonGeometry, LocationProperties>

Defines zones where riders can request either pickup or drop off by on-demand services.

value class LocationType

Type of the location.

data class Network(val networkId: String, val networkName: String? = null)

Describes network IDs.

value class OverrideType

Indicates whether service is available on the date specified.

data class Pathway(val pathwayId: String, val fromStopId: String, val toStopId: String, val pathwayMode: PathwayMode, val isBidirectional: IntBoolean, val length: Double? = null, val traversalTime: WholeSeconds? = null, val stairCount: Int? = null, val maxSlope: Double? = null, val minWidth: Double? = null, val signpostedAs: String? = null, val reversedSignpostedAs: String? = null)

Pathways linking together locations within stations.

value class PathwayMode

Type of pathway.

value class PaymentMethod

Indicates when the fare must be paid.

value class PickupDropoff

Indicates pickup or drop off method.

data class RiderCategory(val riderCategoryId: String, val riderCategoryName: String, val isDefaultFareCategory: IntBoolean, val eligibilityUrl: Url? = null)

Describes various rider categories that can be used for fare eligibility.

data class Route(val routeId: String, val agencyId: String? = null, val routeShortName: String? = null, val routeLongName: String? = null, val routeDesc: String? = null, val routeType: RouteType, val routeUrl: Url? = null, val routeColor: RgbColorTriplet? = null, val routeTextColor: RgbColorTriplet? = null, val routeSortOrder: Int? = null, val continuousPickup: ContinuousPickupDropOff? = null, val continuousDropOff: ContinuousPickupDropOff? = null, val networkId: String? = null, val cemvSupport: TriState? = null)

Transit routes. A route is a group of trips that are displayed to riders as a single service.

data class RouteNetwork(val networkId: String, val routeId: String)

Assigns routes to networks.

value class RouteType

Type of transportation used on a route.

ServiceCalendar

data class ServiceCalendar(val serviceId: String, val monday: IntBoolean, val tuesday: IntBoolean, val wednesday: IntBoolean, val thursday: IntBoolean, val friday: IntBoolean, val saturday: IntBoolean, val sunday: IntBoolean, val startDate: BasicLocalDate, val endDate: BasicLocalDate)

Service dates specified using a weekly schedule with start and end dates.

ServiceCalendarOverride

data class ServiceCalendarOverride(val serviceId: String, val date: BasicLocalDate, val overrideType: OverrideType)

Exceptions for the services defined in the calendar.txt.

data class Shape(val shapeId: String, val shapePointLatitude: Double, val shapePointLongitude: Double, val shapePointSequence: Int, val shapeDistTraveled: Double? = null)

Rules for mapping vehicle travel paths, sometimes referred to as route alignments.

data class Stop(val stopId: String, val stopCode: String? = null, val stopName: String? = null, val ttsStopName: String? = null, val stopDescription: String? = null, val stopLatitude: Double? = null, val stopLongitude: Double? = null, val zoneId: String? = null, val stopUrl: Url? = null, val locationType: LocationType? = null, val parentStation: String? = null, val stopTimezone: TimeZone? = null, val wheelchairBoarding: TriState? = null, val levelId: String? = null, val platformCode: String? = null, val stopAccess: StopAccess? = null)

Stops where vehicles pick up or drop off riders.

value class StopAccess

Indicates how the stop is accessed for a particular station.

data class StopArea(val areaId: String, val stopId: String)

Assigns stops to areas.

data class StopTime(val tripId: String, val arrivalTime: ServiceTime? = null, val departureTime: ServiceTime? = null, val stopId: String, val locationGroupId: String? = null, val locationId: String? = null, val stopSequence: Int, val stopHeadsign: String? = null, val startPickupDropOffWindow: ServiceTime? = null, val endPickupDropOffWindow: ServiceTime? = null, val pickupType: PickupDropoff? = null, val dropOffType: PickupDropoff? = null, val continuousPickup: ContinuousPickupDropOff? = null, val continuousDropOff: ContinuousPickupDropOff? = null, val shapeDistTraveled: Double? = null, val timepoint: Timepoint? = null, val pickupBookingRuleId: String? = null, val dropOffBookingRuleId: String? = null)

Times that a vehicle arrives at and departs from stops for each trip.

data class Timeframe(val timeframeGroupId: String, val startTime: ServiceTime? = null, val endTime: ServiceTime? = null, val serviceId: String)

Describes fares that can vary based on the time of day, the day of the week, or a particular day in the year.

value class Timepoint

Indicates whether a rider can board the transit vehicle at this stop.

data class Transfer(val fromStopId: String? = null, val toStopId: String? = null, val fromRouteId: String? = null, val toRouteId: String? = null, val fromTripId: String? = null, val toTripId: String? = null, val transferType: TransferType? = null, val minTransferTime: WholeSeconds? = null)

Rules and overrides for selected transfers between stops and routes.

value class TransferType

Indicates the type of connection for a transfer.

data class Translation(val tableName: String, val fieldName: String, val language: LanguageCode, val translation: String, val recordId: String? = null, val recordSubId: String? = null, val fieldValue: String? = null)

Provides translations for customer-facing dataset values in languages other than the one used in the dataset.

data class Trip(val tripId: String, val routeId: String, val serviceId: String, val tripHeadsign: String? = null, val tripShortName: String? = null, val directionId: DirectionId? = null, val blockId: String? = null, val shapeId: String? = null, val wheelchairAccessible: TriState? = null, val bikesAllowed: TriState? = null, val carsAllowed: TriState? = null)

Trips for each route. A trip is a sequence of two or more stops that occur during a specific time period.

value class TriState(val value: Int)

Represents a three-state boolean value used for accessibility and other trinary fields in GTFS.

typealias Zone = Stop

Placeholder type for GTFS fare zones.

Properties

val GtfsCsv: DsvFormat

Preconfigured CSV format for GTFS .txt files.