models

Documentation

Overview

Package models provides the internal view of the NYC subway realtime feed.

It provides the internal data definitions and some light business logic.

Index

• type Alert
• type FeedUpdate
• type StationStatus
• type StationUpdate

Types

type Alert

type Alert struct {
	Effect string
	Header string
}

An Alert is a type of service disruption, delay, etc.

type FeedUpdate

type FeedUpdate struct {
	Alerts        []Alert
	StationStatus map[string]StationStatus
}

FeedUpdate represents the status at a given moment.

type StationStatus

type StationStatus struct {
	StopID          string
	StopIDToUpdates map[string][]StationUpdate // multiple directions will be separate keys
}

A StationStatus records all scheduled arrivals and departures for a given stop. Stops on the same line, but in different directions, will be grouped into a given StationStatus struct.

type StationUpdate

type StationUpdate struct {
	TripID    string
	Arrival   time.Time
	Departure time.Time
}

StationUpdate records a scheduled (or realtime) arrival and departure for a trip at a particular station.