journal

Documentation

Overview

Package journal contains a tool for building trip journals.

Index

• type CsvExport
• type DirectoryGtfsrtSource
  • func NewDirectoryGtfsrtSource(baseDir string) (*DirectoryGtfsrtSource, error)
  • func (s *DirectoryGtfsrtSource) Next() *gtfs.Realtime
• type GtfsrtSource
• type Journal
  • func BuildJournal(source GtfsrtSource, startTime, endTime time.Time) *Journal
  • func (journal *Journal) ExportToCsv() (*CsvExport, error)
• type StopTime
• type Trip

Types

type CsvExport

type CsvExport struct {
	TripsCsv     []byte
	StopTimesCsv []byte
}

CsvExport contains CSV exports of a journal

type DirectoryGtfsrtSource

type DirectoryGtfsrtSource struct {
	// contains filtered or unexported fields
}

func NewDirectoryGtfsrtSource

func NewDirectoryGtfsrtSource(baseDir string) (*DirectoryGtfsrtSource, error)

func (*DirectoryGtfsrtSource) Next

func (s *DirectoryGtfsrtSource) Next() *gtfs.Realtime

type GtfsrtSource

type GtfsrtSource interface {
	// TODO: change this to return (*gtfs.RealTime, error) and add logic in BuildJournal to be resilient to this
	Next() *gtfs.Realtime
}

TODO: rename Source

type Journal

type Journal struct {
	Trips []Trip
}

func BuildJournal

func BuildJournal(source GtfsrtSource, startTime, endTime time.Time) *Journal

func (*Journal) ExportToCsv

func (journal *Journal) ExportToCsv() (*CsvExport, error)

type StopTime

type StopTime struct {
	StopID        string
	ArrivalTime   *time.Time
	DepartureTime *time.Time
	Track         *string

	LastObserved time.Time
	MarkedPast   *time.Time
}

type Trip

type Trip struct {
	TripUID     string
	TripID      string
	RouteID     string
	DirectionID gtfs.DirectionID
	StartTime   time.Time
	VehicleID   string
	IsAssigned  bool

	StopTimes []StopTime

	// Metadata follows
	LastObserved        time.Time
	MarkedPast          *time.Time
	NumUpdates          int
	NumScheduleChanges  int
	NumScheduleRewrites int
}