v1dot9

package
v0.7.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 17, 2024 License: MIT Imports: 5 Imported by: 0

Documentation

Overview

Package v1dot9 contains the type definitions for TrainAnnouncement v1.9.

All types have accessor methods to access fields which can be chained on nils. This makes it possible to easily drill down into deeply nested data.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ObjectType 

func ObjectType() trv.ObjectType

Types

type Booking 

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

func (*Booking) Code 

func (x *Booking) Code() *string

SV: Kod för bokningsinformation

func (*Booking) Description 

func (x *Booking) Description() *string

SV: Text som ger bokningsinformation, ex: "Vagn 4 obokad", "Platsbiljett krävs"

func (*Booking) UnmarshalXML 

func (x *Booking) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

type Deviation 

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

func (*Deviation) Code 

func (x *Deviation) Code() *string

SV: Kod för avvikelse

func (*Deviation) Description 

func (x *Deviation) Description() *string

SV: Text som beskriver avvikelse, ex: "Buss ersätter", "Spårändrat", "Kort tåg", "Ej servering", "Oväder"

func (*Deviation) UnmarshalXML 

func (x *Deviation) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

type FromLocation 

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

func (*FromLocation) LocationName 

func (x *FromLocation) LocationName() *string

SV: Namn på frånstation. Notera att det avser vad som ska annonseras för resenärerna, det vill säga vad som ska visas på skyltar o.dyl. FromLocation kan med andra ord ha olika innehåll för samma tåg vid olika stationer och olika innehåll vad ankomster respektive avgångar. Fältet anger hur från-stationer ska annonseras.

func (*FromLocation) Order 

func (x *FromLocation) Order() *int

SV: Vilken ordning stationer ska visas.

func (*FromLocation) Priority 

func (x *FromLocation) Priority() *int

SV: Prioritet för vilka stationer som ska visas.

func (*FromLocation) UnmarshalXML 

func (x *FromLocation) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

type OtherInformation 

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

func (*OtherInformation) Code 

func (x *OtherInformation) Code() *string

SV: Kod för övrig annonseringsinformation

func (*OtherInformation) Description 

func (x *OtherInformation) Description() *string

SV: Text som ger övrig annonseringinformation, ex. "Trevlig resa!", "Bakre vagnen låst!", "Ingen påstigning"

func (*OtherInformation) UnmarshalXML 

func (x *OtherInformation) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

type ProductInformation 

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

func (*ProductInformation) Code 

func (x *ProductInformation) Code() *string

SV: Kod för produkten

func (*ProductInformation) Description 

func (x *ProductInformation) Description() *string

SV: Text som beskriver produkten, ex. "Västtågen", "SJ Snabbtåg", "Pågatågen"

func (*ProductInformation) UnmarshalXML 

func (x *ProductInformation) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

type Response 

type Response struct {
	XMLName xml.Name `xml:"RESPONSE"`
	Results []struct {
		Info struct {
			LastModified trv.LastModified `xml:"LASTMODIFIED"`
			LastChangeID string           `xml:"LASTCHANGEID"`
			EvalResult   []any            `xml:"EVALRESULT"`
			SSEURL       string           `xml:"SSEURL"`
		} `xml:"INFO"`
		Error *trv.APIError       `xml:"ERROR"`
		Data  []TrainAnnouncement `xml:"TrainAnnouncement"`
	} `xml:"RESULT"`
}

Response can be used to decode the response from the API.

For example: 

package main

import (
	 "encoding/xml"
	 api "code.dny.dev/trafikinfo/trv/trainannouncement/v1dot9"
)

func main() {
	var res api.Response
	err := xml.Unmarshal(data, &res)
}

func (Response) ErrorMsg 

func (r Response) ErrorMsg() string

Errors returns a slice of trv.Error, if any error was included in the response.

func (Response) HasErrors 

func (r Response) HasErrors() bool

HasErrors returns whether any of the results includes an error.

type Service 

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

func (*Service) Code 

func (x *Service) Code() *string

SV: Kod för service

func (*Service) Description 

func (x *Service) Description() *string

SV: Text som beskriver den service som finns, ex "Bistro", "Sov-och liggvagnar", "Kiosk"

func (*Service) UnmarshalXML 

func (x *Service) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

type ToLocation 

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

func (*ToLocation) LocationName 

func (x *ToLocation) LocationName() *string

SV: Tillstation för tåget. Notera att det avser vad som ska annonseras för resenärerna, det vill säga vad som ska visas på skyltar o.dyl. ToLocation kan med andra ord ha olika innehåll för samma tåg vid olika stationer och olika innehåll vad ankomster respektive avgångar. Fältet anger hur till-stationer ska annonseras.

func (*ToLocation) Order 

func (x *ToLocation) Order() *int

SV: Vilken ordning stationer ska visas.

func (*ToLocation) Priority 

func (x *ToLocation) Priority() *int

SV: Prioritet för vilka stationer som ska visas.

func (*ToLocation) UnmarshalXML 

func (x *ToLocation) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

type TrainAnnouncement 

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

func (*TrainAnnouncement) ActivityID 

func (x *TrainAnnouncement) ActivityID() *string

SV: Aktivitetens unika id

func (*TrainAnnouncement) ActivityType 

func (x *TrainAnnouncement) ActivityType() *string

SV: "Ankomst" eller "Avgang"

func (*TrainAnnouncement) Advertised 

func (x *TrainAnnouncement) Advertised() *bool

SV: Anger om ankomsten/avgången annonseras i tidtabell

func (*TrainAnnouncement) AdvertisedTimeAtLocation 

func (x *TrainAnnouncement) AdvertisedTimeAtLocation() *time.Time

SV: Tidtabellstid

func (*TrainAnnouncement) AdvertisedTrainIdent 

func (x *TrainAnnouncement) AdvertisedTrainIdent() *string

SV: Annonserat tågnummer (tågnumret som står på biljetten)

func (*TrainAnnouncement) Bookings 

func (x *TrainAnnouncement) Bookings() []Booking

SV: Kod för bokningsinformation och bokningsinformation, ex: "Vagn 4 obokad

func (*TrainAnnouncement) Canceled 

func (x *TrainAnnouncement) Canceled() *bool

SV: Anger om ankomsten/avgången är inställd

func (*TrainAnnouncement) Deleted 

func (x *TrainAnnouncement) Deleted() *bool

SV: Anger att dataposten raderats

func (*TrainAnnouncement) DepartureDateOTN 

func (x *TrainAnnouncement) DepartureDateOTN() *time.Time

SV: Utgångsdatum för det Operativa tågnumret.

func (*TrainAnnouncement) Deviations 

func (x *TrainAnnouncement) Deviations() []Deviation

SV: Eventuell avvikelse med full orsakskod, ex: ABC023 och beskrivning, ex: "Buss ersätter", "Spårändrat", "Kort tåg", "Ej servering" o.s.v.

func (*TrainAnnouncement) EstimatedTimeAtLocation 

func (x *TrainAnnouncement) EstimatedTimeAtLocation() *time.Time

SV: Tidpunkt för beräknad ankomst eller avgång

func (*TrainAnnouncement) EstimatedTimeIsPreliminary 

func (x *TrainAnnouncement) EstimatedTimeIsPreliminary() *bool

SV: Anger om en beräknad tid är preliminär. Notera att om den beräknade tiden är preliminär så innebär det att den kan ändras både framåt och bakåt, ett tåg kan alltså t.ex avgå tidigare än beräknad tidpunkt om den också är markerad som preliminär.

func (*TrainAnnouncement) FromLocations 

func (x *TrainAnnouncement) FromLocations() []FromLocation

SV: Från station för tåget med ordning och i vilken prioritet som ska visas. Notera att det avser vad som ska annonseras för resenärerna, det vill säga vad som ska visas på skyltar o.dyl. FromLocation kan med andra ord ha olika innehåll för samma tåg vid olika stationer och olika innehåll vad ankomster respektive avgångar. Fältet anger hur från-stationer ska annonseras.

func (*TrainAnnouncement) InformationOwner 

func (x *TrainAnnouncement) InformationOwner() *string

SV: Namnet på trafikinformationsägaren

func (*TrainAnnouncement) LocationDateTimeOTN 

func (x *TrainAnnouncement) LocationDateTimeOTN() *time.Time

SV: Det operativa tågets ankomst- eller avgångstid enligt tidtabell (kan skilja sig från den annonserade tiden).

func (*TrainAnnouncement) LocationSignature 

func (x *TrainAnnouncement) LocationSignature() *string

SV: Signatur för stationen 

func (x *TrainAnnouncement) MobileWebLink() *string

SV: Url till trafikägarens mobila hemsida

func (*TrainAnnouncement) ModifiedTime 

func (x *TrainAnnouncement) ModifiedTime() *time.Time

SV: Tidpunkt då dataposten ändrades

func (*TrainAnnouncement) NewEquipment 

func (x *TrainAnnouncement) NewEquipment() *int

SV: Anger i vilken ordning tåget nyutrustats. Om ingen nyutrustning skett kommer värdet vara noll

func (*TrainAnnouncement) OperationalTrainNumber 

func (x *TrainAnnouncement) OperationalTrainNumber() *string

SV: Operativt tågnummer (OTN).

func (*TrainAnnouncement) Operator 

func (x *TrainAnnouncement) Operator() *string

SV: Det järnvägsföretag som utför järnvägstrafik, alltså kör tåget, för en trafikorganisatör.

func (*TrainAnnouncement) OtherInformation 

func (x *TrainAnnouncement) OtherInformation() []OtherInformation

SV: Kod för övrig annonseringsinformation och övrig annonseringsinformation, ex. "Trevlig resa!", "Bakre fordon går låst!", "Ingen påstigning"

func (*TrainAnnouncement) PlannedEstimatedTimeAtLocation 

func (x *TrainAnnouncement) PlannedEstimatedTimeAtLocation() *time.Time

SV: Anger en planerad försening och dess giltighet anges med PlannedEstimatedTimeAtLocationIsValid-flaggan

func (*TrainAnnouncement) PlannedEstimatedTimeAtLocationIsValid 

func (x *TrainAnnouncement) PlannedEstimatedTimeAtLocationIsValid() *bool

SV: Anger om PlaneradBeraknadTid är giltig. Kommer sättas till false när en operativ beräknad tidrapport, tidrapport eller slopningsrapport skapas

func (*TrainAnnouncement) ProductInformation 

func (x *TrainAnnouncement) ProductInformation() []ProductInformation

SV: Kod för beskrivning av tåget och beskrivning av tåget, ex. "Tågkompaniet", "SJ InterCity", "TiB/Tågkomp"

func (*TrainAnnouncement) ScheduledDepartureDateTime 

func (x *TrainAnnouncement) ScheduledDepartureDateTime() *time.Time

SV: Tågets annonserade avgångsdatum

func (*TrainAnnouncement) Services 

func (x *TrainAnnouncement) Services() []Service

SV: Servicekod och lite extra utöver produktinformation, ex "Bistro", "Sov-och liggv"

func (*TrainAnnouncement) TimeAtLocation 

func (x *TrainAnnouncement) TimeAtLocation() *time.Time

SV: När tåget har ankommit eller avgått

func (*TrainAnnouncement) TimeAtLocationWithSeconds 

func (x *TrainAnnouncement) TimeAtLocationWithSeconds() *time.Time

SV: När tåget har ankommit eller avgått, med sekunder

func (*TrainAnnouncement) ToLocations 

func (x *TrainAnnouncement) ToLocations() []ToLocation

SV: Till station för tåget med ordning och i vilken prioritet som ska visas. Notera att det avser vad som ska annonseras för resenärerna, det vill säga vad som ska visas på skyltar o.dyl. ToLocation kan med andra ord ha olika innehåll för samma tåg vid olika stationer och olika innehåll vad ankomster respektive avgångar. Fältet anger hur till-stationer ska annonseras.

func (*TrainAnnouncement) TrackAtLocation 

func (x *TrainAnnouncement) TrackAtLocation() *string

SV: Spår

func (*TrainAnnouncement) TrainCompositions 

func (x *TrainAnnouncement) TrainCompositions() []TrainComposition

SV: Kod för tågsammansättning och tågsammansättning, ex: "Vagnsordning 7, 6, 5, 4, 2, 1"

func (*TrainAnnouncement) TrainOwner 

func (x *TrainAnnouncement) TrainOwner() *string

SV: Ägaren av det aktuella tågläget

func (*TrainAnnouncement) TypesOfTraffic 

func (x *TrainAnnouncement) TypesOfTraffic() []TypeOfTraffic

SV: Trafiktypen, ex. "Buss", "Pendeltåg", "Taxi", "Tåg".

func (*TrainAnnouncement) UnmarshalXML 

func (x *TrainAnnouncement) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

func (*TrainAnnouncement) ViaFromLocations 

func (x *TrainAnnouncement) ViaFromLocations() []ViaFromLocation

func (*TrainAnnouncement) ViaToLocations 

func (x *TrainAnnouncement) ViaToLocations() []ViaToLocation
func (x *TrainAnnouncement) WebLink() *string

SV: Url till trafikägarens hemsida

func (*TrainAnnouncement) WebLinkName 

func (x *TrainAnnouncement) WebLinkName() *string

SV: Namn på trafikinfoägaren att använda i länkar

type TrainComposition 

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

func (*TrainComposition) Code 

func (x *TrainComposition) Code() *string

SV: Kod för tågsammansättning

func (*TrainComposition) Description 

func (x *TrainComposition) Description() *string

SV: Text som beskriver tågsammansättning, ex: "Vagnsordning 7, 6, 5, 4, 2, 1"

func (*TrainComposition) UnmarshalXML 

func (x *TrainComposition) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

type TypeOfTraffic 

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

func (*TypeOfTraffic) Code 

func (x *TypeOfTraffic) Code() *string

SV: Kod för trafiktyp

func (*TypeOfTraffic) Description 

func (x *TypeOfTraffic) Description() *string

SV: Trafiktypen, ex. "Buss", "Pendeltåg", "Taxi", "Tåg".

func (*TypeOfTraffic) UnmarshalXML 

func (x *TypeOfTraffic) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

type ViaFromLocation 

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

func (*ViaFromLocation) LocationName 

func (x *ViaFromLocation) LocationName() *string

SV: Namn på via frånstation. Notera att det avser vad som ska annonseras för resenärerna, det vill säga vad som ska visas på skyltar o.dyl. ViaFromLocation kan med andra ord ha olika innehåll för samma tåg vid olika stationer och olika innehåll vad ankomster respektive avgångar. Fältet anger hur från-stationer ska annonseras.

func (*ViaFromLocation) Order 

func (x *ViaFromLocation) Order() *int

SV: Vilken ordning stationer ska visas.

func (*ViaFromLocation) Priority 

func (x *ViaFromLocation) Priority() *int

SV: Prioritet för vilka stationer som ska visas.

func (*ViaFromLocation) UnmarshalXML 

func (x *ViaFromLocation) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

type ViaToLocation 

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

func (*ViaToLocation) LocationName 

func (x *ViaToLocation) LocationName() *string

SV: Namn på vi. Notera att det avser vad som ska annonseras för resenärerna, det vill säga vad som ska visas på skyltar o.dyl. ViaToLocation kan med andra ord ha olika innehåll för samma tåg vid olika stationer och olika innehåll vad ankomster respektive avgångar. Fältet anger hur till-stationer ska annonseras.

func (*ViaToLocation) Order 

func (x *ViaToLocation) Order() *int

SV: Vilken ordning stationer ska visas.

func (*ViaToLocation) Priority 

func (x *ViaToLocation) Priority() *int

SV: Prioritet för vilka stationer som ska visas.

func (*ViaToLocation) UnmarshalXML 

func (x *ViaToLocation) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.