HeadingAndDeclination Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
HDG Sentence (Heading, declination, variation) Usually measured using an electronic compass. Can be used instead of HDM or HDT (the variation is also included in message RMC)
public class HeadingAndDeclination : Iot.Device.Nmea0183.Sentences.NmeaSentence
type HeadingAndDeclination = class
inherit NmeaSentence
Public Class HeadingAndDeclination
Inherits NmeaSentence
- Inheritance
Constructors
HeadingAndDeclination(Angle, Nullable<Angle>, Nullable<Angle>) |
Constructs a new HDG sentence |
HeadingAndDeclination(TalkerId, IEnumerable<String>, DateTimeOffset) |
Magnetic heading message |
HeadingAndDeclination(TalkerSentence, DateTimeOffset) |
Internal constructor |
Properties
Age |
Age of this message (Inherited from NmeaSentence) |
DateTime |
The time tag on this message (Inherited from NmeaSentence) |
Declination |
Magnetic declination (sometimes also called variation) at current location. Usually derived from the NOAA magnetic field model by one of the attached devices. |
Deviation |
Deviation at current location. Usually unknown (empty). Not sure what this field means. The deviation is a property of the actual compass and the current orientation, not the location. |
HeadingMagnetic |
Magnetic heading (derived from true heading and declination) |
HeadingTrue |
Angle of the wind |
Id |
This sentence's id |
ReplacesOlderInstance |
This is true for this message type |
SentenceId |
The sentence Id of this packet (Inherited from NmeaSentence) |
TalkerId |
The talker (sender) of this message (Inherited from NmeaSentence) |
Valid |
True if the contents of this message are valid / understood This is false if the message type could be decoded, but the contents seem invalid or there's no useful data (Inherited from NmeaSentence) |
Methods
AgeTo(DateTimeOffset) |
The relative age of this sentence against a time stamp. Useful when analyzing recorded data, where "now" should also be a time in the past. (Inherited from NmeaSentence) |
ReadChar(IEnumerator<String>) |
Decodes the next field into a char (Inherited from NmeaSentence) |
ReadInt(IEnumerator<String>) |
Decodes the next field into an int (Inherited from NmeaSentence) |
ReadString(IEnumerator<String>) |
Decodes the next field into a string (Inherited from NmeaSentence) |
ReadValue(IEnumerator<String>) |
Decodes the next field into a double (Inherited from NmeaSentence) |
ToNmeaMessage() |
Translates the properties of this instance into an NMEA message (Inherited from NmeaSentence) |
ToNmeaParameterList() |
Presents this message as output |
ToReadableContent() |
Gets an user-readable string about this message |
ToString() |
Generates a readable instance of this string. Not overridable, use ToReadableContent() to override. (this is to prevent confusion with ToNmeaMessage().) Do not use this method to create an NMEA sentence. (Inherited from NmeaSentence) |