rte.go

package nmea

const (
	// TypeRTE type for RTE sentences
	TypeRTE = "RTE"

	// ActiveRoute active route
	ActiveRoute = "c"

	// WaypointList list containing waypoints
	WaypointList = "w"
)

// RTE is a route of waypoints
// http://aprs.gids.nl/nmea/#rte
// https://gpsd.gitlab.io/gpsd/NMEA.html#_rte_routes
//
// Format: $--RTE,x.x,x.x,a,c--c,c--c, ..... c--c*hh<CR><LF>
// Example: $GPRTE,2,1,c,0,PBRCPK,PBRTO,PTELGR,PPLAND,PYAMBU,PPFAIR,PWARRN,PMORTL,PLISMR*73
type RTE struct {
	BaseSentence
	NumberOfSentences         int64    // Number of sentences in sequence
	SentenceNumber            int64    // Sentence number
	ActiveRouteOrWaypointList string   // Current active route or waypoint list
	Name                      string   // Name or number of active route
	Idents                    []string // List of ident of waypoints
}

// newRTE constructor
func newRTE(s BaseSentence) (RTE, error) {
	p := NewParser(s)
	p.AssertType(TypeRTE)
	return RTE{
		BaseSentence:              s,
		NumberOfSentences:         p.Int64(0, "number of sentences"),
		SentenceNumber:            p.Int64(1, "sentence number"),
		ActiveRouteOrWaypointList: p.EnumString(2, "active route or waypoint list", ActiveRoute, WaypointList),
		Name:                      p.String(3, "name or number"),
		Idents:                    p.ListString(4, "ident of waypoints"),
	}, p.Err()
}