v1dot7

Documentation

Overview

Package v1dot7 contains the type definitions for TrainMessage v1.7.

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

• func ObjectType() trv.ObjectType
• type AffectedLocation
  • func (x *AffectedLocation) LocationSignature() *string
  • func (x *AffectedLocation) ShouldBeTrafficInformed() *bool
  • func (x *AffectedLocation) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error
• type Geometry
  • func (x *Geometry) SWEREF99TM() *string
  • func (x *Geometry) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error
  • func (x *Geometry) WGS84() *string
• type ReasonCode
  • func (x *ReasonCode) Code() *string
  • func (x *ReasonCode) Description() *string
  • func (x *ReasonCode) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error
• type Response
  • func (r Response) ErrorMsg() string
  • func (r Response) HasErrors() bool
• type TrafficImpact
  • func (x *TrafficImpact) AffectedLocations() []AffectedLocation
  • func (x *TrafficImpact) FromLocations() []string
  • func (x *TrafficImpact) IsConfirmed() *bool
  • func (x *TrafficImpact) ToLocations() []string
  • func (x *TrafficImpact) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error
• type TrainMessage
  • func (x *TrainMessage) Counties() []int
  • func (x *TrainMessage) Deleted() *bool
  • func (x *TrainMessage) EndDateTime() *time.Time
  • func (x *TrainMessage) EventID() *string
  • func (x *TrainMessage) ExternalDescription() *string
  • func (x *TrainMessage) Geometry() *Geometry
  • func (x *TrainMessage) Header() *string
  • func (x *TrainMessage) LastUpdateDateTime() *time.Time
  • func (x *TrainMessage) ModifiedTime() *time.Time
  • func (x *TrainMessage) PrognosticatedEndDateTimeTrafficImpact() *time.Time
  • func (x *TrainMessage) ReasonCodes() []ReasonCode
  • func (x *TrainMessage) StartDateTime() *time.Time
  • func (x *TrainMessage) TrafficImpact() []TrafficImpact
  • func (x *TrainMessage) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

Functions

func ObjectType

func ObjectType() trv.ObjectType

Types

type AffectedLocation

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

func (*AffectedLocation) LocationSignature

func (x *AffectedLocation) LocationSignature() *string

SV: Signatur för den påverkade platsen

func (*AffectedLocation) ShouldBeTrafficInformed

func (x *AffectedLocation) ShouldBeTrafficInformed() *bool

SV: Visar huruvida platsen ska ingå i trafikinformationen eller inte EN: Indicates if the location should be included in traffic information

func (*AffectedLocation) UnmarshalXML

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

type Geometry

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

func (*Geometry) SWEREF99TM

func (x *Geometry) SWEREF99TM() *string

SV: Geometrisk punkt i koordinatsystem SWEREF99TM

func (*Geometry) UnmarshalXML

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

func (*Geometry) WGS84

func (x *Geometry) WGS84() *string

SV: Geometrisk punkt i koordinatsystem WGS84

type ReasonCode

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

func (*ReasonCode) Code

func (x *ReasonCode) Code() *string

SV: Orsakskod

func (*ReasonCode) Description

func (x *ReasonCode) Description() *string

SV: Beskrivande text för orsakskod

func (*ReasonCode) UnmarshalXML

func (x *ReasonCode) 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  []TrainMessage `xml:"TrainMessage"`
	} `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/trainmessage/v1dot7"
)

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 TrafficImpact

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

func (*TrafficImpact) AffectedLocations

func (x *TrafficImpact) AffectedLocations() []AffectedLocation

SV: Påverkade stationer

func (*TrafficImpact) FromLocations

func (x *TrafficImpact) FromLocations() []string

SV: Påverkad sträckas frånstation, för att avgöra om stationen är påverkad, se fältet AffectedLocation

func (*TrafficImpact) IsConfirmed

func (x *TrafficImpact) IsConfirmed() *bool

SV: Anger om trafikpåverkan är bekräftad. När påverkan inte är bekräftad anges alla platser på den aktuella sträckan som påverkade

func (*TrafficImpact) ToLocations

func (x *TrafficImpact) ToLocations() []string

SV: Påverkad sträckas tillstation, för att avgöra om stationen är påverkad, se fältet AffectedLocation

func (*TrafficImpact) UnmarshalXML

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

type TrainMessage

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

func (*TrainMessage) Counties

func (x *TrainMessage) Counties() []int

SV: <div class="toggleTitle">Länsnummer</div> <div class="toggle arrowR"> </div> <div class="toggleContent"> <table class="table table-condensed"> <tr> <td>1</td> <td>Stockholms län</td> </tr> <tr> <td>2</td> <td> DEPRECATED<br /> Användes tidigare för Stockholms län </td> </tr> <tr> <td>3</td> <td>Uppsala län</td> </tr> <tr> <td>4</td> <td>Södermanlands län</td> </tr> <tr> <td>5</td> <td>Östergötlands län</td> </tr> <tr> <td>6</td> <td>Jönköpings län</td> </tr> <tr> <td>7</td> <td>Kronobergs län</td> </tr> <tr> <td>8</td> <td>Kalmar län</td> </tr> <tr> <td>9</td> <td>Gotlands län</td> </tr> <tr> <td>10</td> <td>Blekinge län</td> </tr> <tr> <td>12</td> <td>Skåne län</td> </tr> <tr> <td>13</td> <td>Hallands län</td> </tr> <tr> <td>14</td> <td>Västra Götalands län</td> </tr> <tr> <td>17</td> <td>Värmlands län</td> </tr> <tr> <td>18</td> <td>Örebro län</td> </tr> <tr> <td>19</td> <td>Västmanlands län</td> </tr> <tr> <td>20</td> <td>Dalarnas län</td> </tr> <tr> <td>21</td> <td>Gävleborgs län</td> </tr> <tr> <td>22</td> <td>Västernorrlands län</td> </tr> <tr> <td>23</td> <td>Jämtlands län</td> </tr> <tr> <td>24</td> <td>Västerbottens län</td> </tr> <tr> <td>25</td> <td>Norrbottens län</td> </tr> </table> </div>

func (*TrainMessage) Deleted

func (x *TrainMessage) Deleted() *bool

SV: Anger att dataposten raderats

func (*TrainMessage) EndDateTime

func (x *TrainMessage) EndDateTime() *time.Time

SV: Händelsens sluttid

func (*TrainMessage) EventID

func (x *TrainMessage) EventID() *string

SV: Unikt id för händelsen

func (*TrainMessage) ExternalDescription

func (x *TrainMessage) ExternalDescription() *string

SV: Informationstext

func (*TrainMessage) Geometry

func (x *TrainMessage) Geometry() *Geometry

func (*TrainMessage) Header

func (x *TrainMessage) Header() *string

SV: Redaktörssatt rubrik för händelsen, kan i vissa fall vara samma som ReasonCodeText

func (*TrainMessage) LastUpdateDateTime

func (x *TrainMessage) LastUpdateDateTime() *time.Time

SV: Tidpunkt då händelsen uppdaterades

func (*TrainMessage) ModifiedTime

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

SV: Tidpunkt då dataposten ändrades

func (*TrainMessage) PrognosticatedEndDateTimeTrafficImpact

func (x *TrainMessage) PrognosticatedEndDateTimeTrafficImpact() *time.Time

SV: Prognos för då händelsen inte längre väntas påverka trafiken

func (*TrainMessage) ReasonCodes

func (x *TrainMessage) ReasonCodes() []ReasonCode

func (*TrainMessage) StartDateTime

func (x *TrainMessage) StartDateTime() *time.Time

SV: Händelsens starttid

func (*TrainMessage) TrafficImpact

func (x *TrainMessage) TrafficImpact() []TrafficImpact

SV: Meddelandets trafikpåverkan

func (*TrainMessage) UnmarshalXML

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