gtfs-realtime/dev.sargunv.mobilitydata.gtfs.realtime

Package-level declarations

Types

data class Alert(val activePeriod: List<TimeRange> = emptyList(), val communicationPeriod: List<TimeRange> = emptyList(), val impactPeriod: List<TimeRange> = emptyList(), val informedEntity: List<EntitySelector> = emptyList(), val cause: Alert.Cause = Cause.UnknownCause, val effect: Alert.Effect = Effect.UnknownEffect, val url: TranslatedString? = null, val headerText: TranslatedString? = null, val descriptionText: TranslatedString? = null, val ttsHeaderText: TranslatedString? = null, val ttsDescriptionText: TranslatedString? = null, val severityLevel: Alert.SeverityLevel = SeverityLevel.UnknownSeverity, val image: TranslatedImage? = null, val imageAlternativeText: TranslatedString? = null, val causeDetail: TranslatedString? = null, val effectDetail: TranslatedString? = null)

A service alert in the realtime feed.

EntitySelector

@Serializable

data class EntitySelector(val agencyId: String? = null, val routeId: String? = null, val routeType: Int? = null, val trip: TripDescriptor? = null, val stopId: String? = null, val directionId: Int? = null)

Selects an affected GTFS entity.

FeedEntity

@Serializable

data class FeedEntity(val id: String, val isDeleted: Boolean = false, val tripUpdate: TripUpdate? = null, val vehicle: VehiclePosition? = null, val alert: Alert? = null, val shape: Shape? = null, val stop: Stop? = null, val tripModifications: TripModifications? = null)

A single realtime entity in the feed.

FeedHeader

@Serializable

data class FeedHeader(val gtfsRealtimeVersion: String, val incrementality: FeedHeader.Incrementality = Incrementality.FullDataset, val timestamp: Long? = null, val feedVersion: String? = null)

Feed-level metadata.

FeedMessage

@Serializable

data class FeedMessage(val header: FeedHeader, val entity: List<FeedEntity> = emptyList())

The root GTFS Realtime feed payload.

GtfsRealtimeClient

class GtfsRealtimeClient : AutoCloseable

HTTP client for fetching GTFS Realtime feeds.

GtfsRealtimeProto

object GtfsRealtimeProto

Binary GTFS Realtime protobuf codec.

Position

@Serializable

data class Position(val latitude: Float, val longitude: Float, val bearing: Float? = null, val odometer: Double? = null, val speed: Float? = null)

Geographic vehicle position.

ReplacementStop

@Serializable

data class ReplacementStop(val travelTimeToStop: Int? = null, val stopId: String? = null)

A replacement stop for a trip modification.

Shape

@Serializable

data class Shape(val shapeId: String? = null, val encodedPolyline: String? = null)

A realtime detour shape.

Stop

@Serializable

data class Stop(val stopId: String? = null, val stopCode: TranslatedString? = null, val stopName: TranslatedString? = null, val ttsStopName: TranslatedString? = null, val stopDesc: TranslatedString? = null, val stopLat: Float? = null, val stopLon: Float? = null, val zoneId: String? = null, val stopUrl: TranslatedString? = null, val parentStation: String? = null, val stopTimezone: TimeZoneId? = null, val wheelchairBoarding: Stop.WheelchairBoarding = WheelchairBoarding.Unknown, val levelId: String? = null, val platformCode: TranslatedString? = null)

A stop dynamically added to the feed.

StopSelector

@Serializable

data class StopSelector(val stopSequence: Int? = null, val stopId: String? = null)

Selects a stop by sequence or stop ID.

TimeRange

@Serializable

data class TimeRange(val start: Long? = null, val end: Long? = null)

A time interval for alert display.

TranslatedImage

@Serializable

data class TranslatedImage(val localizedImage: List<TranslatedImage.LocalizedImage> = emptyList())

Internationalized image metadata.

TranslatedString

@Serializable

data class TranslatedString(val translation: List<TranslatedString.Translation> = emptyList())

Internationalized text content.

TripDescriptor

@Serializable

data class TripDescriptor(val tripId: String? = null, val routeId: String? = null, val directionId: Int? = null, val startTime: String? = null, val startDate: String? = null, val scheduleRelationship: TripDescriptor.ScheduleRelationship? = null, val modifiedTrip: TripDescriptor.ModifiedTripSelector? = null)

Identifies a trip instance or set of trips.

TripModifications

@Serializable

data class TripModifications(val selectedTrips: List<TripModifications.SelectedTrips> = emptyList(), val startTimes: List<String> = emptyList(), val serviceDates: List<String> = emptyList(), val modifications: List<TripModifications.Modification> = emptyList())

Realtime trip modifications such as detours.

TripUpdate

@Serializable

data class TripUpdate(val trip: TripDescriptor, val vehicle: VehicleDescriptor? = null, val stopTimeUpdate: List<TripUpdate.StopTimeUpdate> = emptyList(), val timestamp: Long? = null, val delay: Int? = null, val tripProperties: TripUpdate.TripProperties? = null)

Realtime progress information for a trip.

VehicleDescriptor

@Serializable

data class VehicleDescriptor(val id: String? = null, val label: String? = null, val licensePlate: String? = null, val wheelchairAccessible: VehicleDescriptor.WheelchairAccessible = WheelchairAccessible.NoValue)

Identifies the vehicle serving a trip.

VehiclePosition

@Serializable

data class VehiclePosition(val trip: TripDescriptor? = null, val vehicle: VehicleDescriptor? = null, val position: Position? = null, val currentStopSequence: Int? = null, val stopId: String? = null, val currentStatus: VehiclePosition.VehicleStopStatus = VehicleStopStatus.InTransitTo, val timestamp: Long? = null, val congestionLevel: VehiclePosition.CongestionLevel? = null, val occupancyStatus: VehiclePosition.OccupancyStatus? = null, val occupancyPercentage: Int? = null, val multiCarriageDetails: List<VehiclePosition.CarriageDetails> = emptyList())

Realtime positioning information for a vehicle.