gtfs

type Agency struct {
	AgencyID       tt.String
	AgencyName     tt.String   `csv:",required"`
	AgencyURL      tt.Url      `csv:",required"`
	AgencyTimezone tt.Timezone `csv:",required"`
	AgencyLang     tt.Language
	AgencyPhone    tt.String
	AgencyFareURL  tt.Url
	AgencyEmail    tt.Email
	tt.BaseEntity
}

type Area struct {
	AreaID    tt.String `csv:",required"`
	AreaName  tt.String
	AgencyIDs tt.Strings `csv:"-" db:"agency_ids"` // interline ext
	Geometry  tt.Polygon `csv:"-"`                 // interline ext
	tt.BaseEntity
}

type Attribution struct {
	OrganizationName tt.String `csv:",required"`
	AgencyID         tt.Key    `target:"agency.txt"`
	RouteID          tt.Key    `target:"routes.txt"`
	TripID           tt.Key    `target:"trips.txt"`
	IsProducer       tt.Int    `enum:"0,1"`
	IsOperator       tt.Int    `enum:"0,1"`
	IsAuthority      tt.Int    `enum:"0,1"`
	AttributionID    tt.String
	AttributionURL   tt.Url
	AttributionEmail tt.Email
	AttributionPhone tt.String
	tt.BaseEntity
}

type BookingRule struct {
	BookingRuleID          tt.String `csv:",required"`
	BookingType            tt.Int    `csv:",required" enum:"0,1,2"`
	PriorNoticeDurationMin tt.Int
	PriorNoticeDurationMax tt.Int
	PriorNoticeLastDay     tt.Int
	PriorNoticeLastTime    tt.Seconds
	PriorNoticeStartDay    tt.Int
	PriorNoticeStartTime   tt.Seconds
	PriorNoticeServiceID   tt.Key `target:"calendar.txt"`
	Message                tt.String
	PickupMessage          tt.String
	DropOffMessage         tt.String
	PhoneNumber            tt.String
	InfoURL                tt.Url
	BookingURL             tt.Url
	tt.BaseEntity
}

type Calendar struct {
	ServiceID     tt.String      `csv:",required"`
	Monday        tt.Int         `csv:",required" enum:"0,1"`
	Tuesday       tt.Int         `csv:",required" enum:"0,1"`
	Wednesday     tt.Int         `csv:",required" enum:"0,1"`
	Thursday      tt.Int         `csv:",required" enum:"0,1"`
	Friday        tt.Int         `csv:",required" enum:"0,1"`
	Saturday      tt.Int         `csv:",required" enum:"0,1"`
	Sunday        tt.Int         `csv:",required" enum:"0,1"`
	StartDate     tt.Date        `csv:",required"`
	EndDate       tt.Date        `csv:",required"`
	Generated     tt.Bool        `csv:"-" db:"generated"`
	CalendarDates []CalendarDate `csv:"-" db:"-"` // for validation
	tt.BaseEntity
}

type CalendarDate struct {
	ServiceID     tt.Key  `csv:",required" target:"calendar.txt"`
	Date          tt.Date `csv:",required"`
	ExceptionType tt.Int  `csv:",required" enum:"1,2"`
	tt.BaseEntity
}

type FareAttribute struct {
	FareID           tt.String   `csv:",required"`
	Price            tt.Float    `csv:",required" range:"0,"`
	CurrencyType     tt.Currency `csv:",required"`
	PaymentMethod    tt.Int      `csv:",required" enum:"0,1"`
	Transfers        tt.Int      `enum:"0,1,2"` // note! null is distinct from 0
	AgencyID         tt.Key      `target:"agency.txt"`
	TransferDuration tt.Int      `range:"0,"`
	tt.BaseEntity
}

type FareLegRule struct {
	LegGroupID           tt.String
	FromAreaID           tt.String `target:"areas.txt"`
	ToAreaID             tt.String `target:"areas.txt"`
	NetworkID            tt.String `target:"networks.txt"`
	FareProductID        tt.String `csv:",required" target:"fare_products.txt:fare_product_id"`
	FromTimeframeGroupID tt.String `target:"timeframes.txt:timeframe_group_id"`
	ToTimeframeGroupID   tt.String `target:"timeframes.txt:timeframe_group_id"`
	RulePriority         tt.Int    `range:"0,"`
	TransferOnly         tt.Int    `enum:"0,1"` // interline ext
	tt.BaseEntity
}

type FareMedia struct {
	FareMediaID   tt.String `csv:",required"`
	FareMediaName tt.String `csv:",required"`
	FareMediaType tt.Int    `csv:",required" enum:"0,1,2,3,4"`
	tt.BaseEntity
}

type FareProduct struct {
	FareProductID   tt.String `csv:",required" `
	FareProductName tt.String
	Amount          tt.CurrencyAmount `csv:",required"`
	Currency        tt.Currency       `csv:",required"`
	DurationStart   tt.Int            `enum:"0,1"`                                      // proposed extension
	DurationAmount  tt.Float          `range:"0,"`                                      // proposed extension
	DurationUnit    tt.Int            `enum:"0,1,2,3,4,5,6"`                            // proposed extension
	DurationType    tt.Int            `enum:"1,2"`                                      // proposed extension
	RiderCategoryID tt.Key            `target:"rider_categories.txt:rider_category_id"` // proposed extension
	FareMediaID     tt.Key            `target:"fare_media.txt"`                         // proposed extension
	tt.BaseEntity
}

type FareRule struct {
	FareID        tt.String `csv:",required" target:"fare_attributes.txt"`
	RouteID       tt.Key    `target:"routes.txt"`
	OriginID      tt.String
	DestinationID tt.String
	ContainsID    tt.String
	tt.BaseEntity
}

type FareTransferRule struct {
	FromLegGroupID      tt.String `target:"fare_leg_rules.txt:leg_group_id"`
	ToLegGroupID        tt.String `target:"fare_leg_rules.txt:leg_group_id"`
	TransferCount       tt.Int    `range:"-1,"`
	DurationLimit       tt.Int    `range:"0,"`
	DurationLimitType   tt.Int    `enum:"0,1,2,3"`
	FareTransferType    tt.Int    `csv:",required" enum:"0,1,2"`
	FareProductID       tt.String `target:"fare_products.txt:fare_product_id"`
	FilterFareProductID tt.String `target:"fare_products.txt:fare_product_id"` // proposed extension
	tt.BaseEntity
}

type FeedInfo struct {
	FeedPublisherName tt.String   `csv:",required"`
	FeedPublisherURL  tt.Url      `csv:",required"`
	FeedLang          tt.Language `csv:",required"`
	FeedVersion       tt.String   `db:"feed_version_name"`
	FeedStartDate     tt.Date
	FeedEndDate       tt.Date
	DefaultLang       tt.Language
	FeedContactEmail  tt.Email
	FeedContactURL    tt.Url
	tt.BaseEntity
}

type FlexInfo struct {
	HasFlexStopTimes     bool // Any StopTime uses Location or LocationGroup instead of StopID
	HasFlexTimeWindows   bool // Any StopTime uses pickup/dropoff time windows
	HasMixedStopTypes    bool // Mix of regular stops and flex locations
	AllStopsHaveStopID   bool // All StopTimes have a valid StopID
	FlexStopTimeCount    int  // Number of StopTimes with flex characteristics
	RegularStopTimeCount int  // Number of StopTimes with regular StopID
}

type Frequency struct {
	TripID      tt.String  `csv:",required" target:"trips.txt"`
	HeadwaySecs tt.Int     `csv:",required" range:"1,"`
	StartTime   tt.Seconds `csv:",required"`
	EndTime     tt.Seconds `csv:",required"`
	ExactTimes  tt.Int     `enum:"0,1"`
	tt.BaseEntity
}

type Level struct {
	LevelID    tt.String `csv:",required"`
	LevelIndex tt.Float  `csv:",required"`
	LevelName  tt.String
	tt.BaseEntity
}

type Location struct {
	// ID is the feature ID from the GeoJSON, shares namespace with stop_id
	LocationID tt.String `json:"id" csv:",required"`
	// Properties
	StopName tt.String   `json:"stop_name"`
	StopDesc tt.String   `json:"stop_desc"`
	ZoneID   tt.String   `json:"zone_id"`
	StopURL  tt.Url      `json:"stop_url"`
	Geometry tt.Geometry `json:"geometry"`
	tt.BaseEntity
}

type LocationGroup struct {
	LocationGroupID   tt.String `csv:",required"`
	LocationGroupName tt.String
	tt.BaseEntity
}

type LocationGroupStop struct {
	LocationGroupID tt.Key `csv:",required" target:"location_groups.txt"`
	StopID          tt.Key `csv:",required" target:"stops.txt"`
	tt.BaseEntity
}

type Network struct {
	NetworkID   tt.String `csv:",required"`
	NetworkName tt.String
	tt.BaseEntity
}

type Pathway struct {
	PathwayID           tt.String `csv:",required"`
	FromStopID          tt.String `csv:",required" target:"stops.txt"`
	ToStopID            tt.String `csv:",required" target:"stops.txt"`
	PathwayMode         tt.Int    `csv:",required" enum:"1,2,3,4,5,6,7"`
	IsBidirectional     tt.Int    `csv:",required" enum:"0,1"`
	Length              tt.Float  `gte:"0"`
	TraversalTime       tt.Int    `gt:"0"`
	MinWidth            tt.Float  `gt:"0"`
	MaxSlope            tt.Float
	StairCount          tt.Int
	SignpostedAs        tt.String
	ReverseSignpostedAs tt.String
	tt.BaseEntity
}

type Reader interface {
	Stops() chan Stop
	StopTimes() chan StopTime
	Agencies() chan Agency
	Calendars() chan Calendar
	CalendarDates() chan CalendarDate
	FareAttributes() chan FareAttribute
	FareRules() chan FareRule
	FeedInfos() chan FeedInfo
	Frequencies() chan Frequency
	Routes() chan Route
	Shapes() chan Shape
	Transfers() chan Transfer
	Pathways() chan Pathway
	Levels() chan Level
	Trips() chan Trip
	Translations() chan Translation
	Attributions() chan Attribution
	Areas() chan Area
	StopAreas() chan StopArea
	FareLegRules() chan FareLegRule
	FareTransferRules() chan FareTransferRule
	FareProducts() chan FareProduct
	RiderCategories() chan RiderCategory
	FareMedia() chan FareMedia
	Timeframes() chan Timeframe
	Networks() chan Network
	RouteNetworks() chan RouteNetwork
	LocationGroups() chan LocationGroup
	LocationGroupStops() chan LocationGroupStop
	BookingRules() chan BookingRule
	Locations() chan Location
}

type RiderCategory struct {
	RiderCategoryID       tt.String `csv:",required"`
	RiderCategoryName     tt.String `csv:",required"`
	MinAge                tt.Int    `range:"0,"`
	MaxAge                tt.Int    `range:"0,"`
	IsDefaultFareCategory tt.Int    `range:"0,1"`
	EligibilityURL        tt.Url
	tt.BaseEntity
}

type Route struct {
	RouteID           tt.String `csv:",required"`
	AgencyID          tt.Key    `target:"agency.txt"`
	RouteShortName    tt.String
	RouteLongName     tt.String
	RouteDesc         tt.String
	RouteType         tt.Int `csv:",required"`
	RouteURL          tt.Url
	RouteColor        tt.Color
	RouteTextColor    tt.Color
	RouteSortOrder    tt.Int `range:"0,"`
	ContinuousPickup  tt.Int `enum:"0,1,2,3"`
	ContinuousDropOff tt.Int `enum:"0,1,2,3"`
	NetworkID         tt.String
	AsRoute           tt.Int
	Geometry          tt.Geometry `csv:"-" db:"-"`
	tt.BaseEntity
}

type RouteNetwork struct {
	NetworkID tt.Key `csv:",required" target:"networks.txt"`
	RouteID   tt.Key `csv:",required" target:"routes.txt"`
	tt.BaseEntity
}

type Shape struct {
	ShapeID           tt.String `csv:",required"`
	ShapePtLat        tt.Float  `db:"-" csv:",required" range:"-90,90"`
	ShapePtLon        tt.Float  `db:"-" csv:",required" range:"-180,180"`
	ShapePtSequence   tt.Int    `db:"-" csv:",required" range:"0,"`
	ShapeDistTraveled tt.Float  `db:"-" range:"0,"`
	tt.BaseEntity
}

type Stop struct {
	StopID             tt.String `csv:",required" required:"true"`
	StopName           tt.String
	StopCode           tt.String
	StopDesc           tt.String
	StopLat            tt.Float `db:"-" range:"-90,90"` // csv load to Geometry
	StopLon            tt.Float `db:"-" range:"-180,180"`
	ZoneID             tt.String
	StopURL            tt.Url
	TtsStopName        tt.String
	PlatformCode       tt.String
	LocationType       tt.Int `enum:"0,1,2,3,4"`
	ParentStation      tt.Key `target:"stops.txt"`
	StopTimezone       tt.Timezone
	WheelchairBoarding tt.Int   `enum:"0,1,2"`
	LevelID            tt.Key   `target:"levels.txt"`
	Geometry           tt.Point `csv:"-" db:"geometry"`
	tt.BaseEntity
}

type StopArea struct {
	AreaID tt.Key `csv:",required" target:"areas.txt"`
	StopID tt.Key `csv:",required" target:"stops.txt"`
	tt.BaseEntity
}

type StopTime struct {
	TripID            tt.String `csv:",required" target:"trips.txt"`
	StopID            tt.Key    `target:"stops.txt"`
	LocationGroupID   tt.Key    `target:"location_groups.txt"`
	LocationID        tt.Key    `target:"locations.txt"`
	StopSequence      tt.Int    `csv:",required"`
	StopHeadsign      tt.String
	ArrivalTime       tt.Seconds
	DepartureTime     tt.Seconds
	PickupType        tt.Int
	DropOffType       tt.Int
	ContinuousPickup  tt.Int
	ContinuousDropOff tt.Int
	ShapeDistTraveled tt.Float
	Timepoint         tt.Int
	Interpolated      tt.Int `csv:"-"` // interpolated times: 0 for provided, 1 interpolated // TODO: 1 for shape, 2 for straight-line
	// GTFS-Flex fields (officially adopted)
	StartPickupDropOffWindow tt.Seconds
	EndPickupDropOffWindow   tt.Seconds
	PickupBookingRuleID      tt.Key `target:"booking_rules.txt"`
	DropOffBookingRuleID     tt.Key `target:"booking_rules.txt"`
	// GTFS-Flex proposed fields (not yet formally adopted, may change)
	// See: https://github.com/MobilityData/gtfs-flex/blob/master/spec/reference.md
	MeanDurationFactor tt.Float // proposed gtfs-flex
	MeanDurationOffset tt.Float // proposed gtfs-flex
	SafeDurationFactor tt.Float // proposed gtfs-flex
	SafeDurationOffset tt.Float // proposed gtfs-flex
	tt.MinEntity
	tt.ErrorEntity
	tt.ExtraEntity
	tt.FeedVersionEntity
}

type Timeframe struct {
	TimeframeGroupID tt.String `csv:",required"`
	StartTime        tt.Seconds
	EndTime          tt.Seconds
	ServiceID        tt.Key `csv:",required" target:"calendar.txt"`
	tt.BaseEntity
}

type Transfer struct {
	FromStopID      tt.Key `target:"stops.txt"`
	ToStopID        tt.Key `target:"stops.txt"`
	FromRouteID     tt.Key `target:"routes.txt"`
	ToRouteID       tt.Key `target:"routes.txt"`
	FromTripID      tt.Key `target:"trips.txt"`
	ToTripID        tt.Key `target:"trips.txt"`
	TransferType    tt.Int `enum:"0,1,2,3,4,5"`
	MinTransferTime tt.Int `range:"0,"`
	tt.BaseEntity
}

type Translation struct {
	// "TableNameValue" because TableName is a required interface method
	TableNameValue tt.String   `db:"table_name" csv:"table_name,required"`
	FieldName      tt.String   `csv:",required"`
	Language       tt.Language `csv:",required"`
	Translation    tt.String   `csv:",required"`
	RecordID       tt.String
	RecordSubID    tt.String
	FieldValue     tt.String
	tt.BaseEntity
}

type Trip struct {
	RouteID              tt.Key    `csv:",required" target:"routes.txt"`
	ServiceID            tt.Key    `csv:",required" target:"calendar.txt"`
	TripID               tt.String `csv:",required"`
	TripHeadsign         tt.String
	TripShortName        tt.String
	DirectionID          tt.Int `enum:"0,1"`
	BlockID              tt.String
	ShapeID              tt.Key     `target:"shapes.txt"`
	WheelchairAccessible tt.Int     `enum:"0,1,2"`
	BikesAllowed         tt.Int     `enum:"0,1,2"`
	JourneyPatternID     tt.String  `csv:"-"`
	JourneyPatternOffset tt.Int     `csv:"-"`
	StopPatternID        tt.Int     `csv:"-"`
	StopTimes            []StopTime `csv:"-" db:"-"` // for validation
	tt.BaseEntity
}