Click or drag to resize

Position Class

Position class contains all the position and current status related data.
Inheritance Hierarchy
SystemObject
  ZylSoft.GpsPosition

Namespace: ZylSoft.Gps
Assembly: ZylGpsReceiver (in ZylGpsReceiver.dll) Version: 3.28.8737.22596
XMLNS for XAML: Not mapped to an xmlns.
Syntax
public class Position : ICloneable, IComparable

The Position type exposes the following members.

Constructors
 NameDescription
Public methodPosition Constructor.
Public methodPosition(Double, Double) Constructor.
Top
Properties
 NameDescription
Public propertyAltitude Altitude in meters.
Public propertyCourse True course in decimal degrees.
Public propertyDay Current day of the month.
Public propertyFix Returns fix related data: -1 - No Info 0 - Invalid 1 - Valid SPS 2 - Valid DGPS 3 - Valid PPS
Public propertyGeoHeight Difference between WGS-84 reference ellipsoid surface and the mean-sea-level altitude in meters (geoidal separation).
Public propertyHdop Horizontal dilution of precision.
Public propertyHeading True heading in decimal degrees.
Public propertyHour Current hour.
Public propertyLatitudeAsDecimalDegrees Latitude in decimal degrees.
Public propertyLatitudeDegree Degree component of latitude.
Public propertyLatitudeDirection Direction component of latitude. (North (+) or South (-))
Public propertyLatitudeMinute Minute component of latitude.
Public propertyLatitudeSecond Second component of latitude.
Public propertyLongitudeAsDecimalDegrees Longitude in decimal degrees.
Public propertyLongitudeDegree Degree component of longitude.
Public propertyLongitudeDirection Direction component of longitude (East or West).
Public propertyLongitudeMinute Minute component of longitude.
Public propertyLongitudeSecond Second component of longitude.
Public propertyMagneticCourse Magnetic course.
Public propertyMagneticDeviation Magnetic deviation in degrees.
Public propertyMagneticDeviationDirection Direction of magnetic deviation (East or West).
Public propertyMagneticHeading Magnetic heading.
Public propertyMagneticVariation Magnetic variation (declination) in degrees.
Public propertyMagneticVariationDirection Direction of magnetic variation (East or West).
Public propertyMillisecond Current millisecond.
Public propertyMinute Current minute (time).
Public propertyMode1 Returns the operating mode: 1 - Auto 2D/3D 2 - Forced 2D/3D
Public propertyMode2 Returns the operating mode: 1 - If no fix 2 - If the position is a 2D GPS fix 3 - If the position is a 3D GPS fix
Public propertyMonth Current month of the year.
Public propertyPdop Position dilution of precision.
Public propertySatelliteCount Count of the satellites used to determine the fix position. If you need the count of all satellites in view, use Satellites.Count instead of Satellite_Count.
Public propertySatellites List of satellites in view (List of Satellite objects).
Public propertySecond Current second (time).
Public propertySpeedAsKmh Speed in km/h.
Public propertySpeedAsKnots Speed in knots.
Public propertyVdop Vertical dilution of precision.
Public propertyYear Current year.
Top
Methods
 NameDescription
Public methodStatic memberBearing(Double, Double, Double, Double) Returns bearing in decimal degrees between two points.
Public methodStatic memberBearing(Int32, Int32, Double, CardinalPoint, Int32, Int32, Double, CardinalPoint, Int32, Int32, Double, CardinalPoint, Int32, Int32, Double, CardinalPoint) Returns bearing in decimal degrees between two points.
Public methodBearingTo(Double, Double) Returns bearing in decimal degrees between one point and the current position.
Public methodBearingTo(Int32, Int32, Double, CardinalPoint, Int32, Int32, Double, CardinalPoint) Returns bearing in decimal degrees between one point and the current position.
Public methodClone Creates a shallow copy of the current object.
Public methodCompareTo Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
Public methodStatic memberDecimalDegreesToRadians Converts decimal degrees to radians.
Public methodStatic memberDistanceAsKm(Double, Double, Double, Double) Returns the distance between two points in kilometers using Haversine formula (Great-circle).
Public methodStatic memberDistanceAsKm(Int32, Int32, Double, CardinalPoint, Int32, Int32, Double, CardinalPoint, Int32, Int32, Double, CardinalPoint, Int32, Int32, Double, CardinalPoint) Returns the distance between two points in kilometers using Haversine formula (Great-circle).
Public methodStatic memberDistanceAsMiles(Double, Double, Double, Double) Returns the distance between two points in miles using Haversine formula (Great-circle).
Public methodStatic memberDistanceAsMiles(Int32, Int32, Double, CardinalPoint, Int32, Int32, Double, CardinalPoint, Int32, Int32, Double, CardinalPoint, Int32, Int32, Double, CardinalPoint) Returns the distance between two points in miles using Haversine formula (Great-circle).
Public methodDistanceToAsKm(Double, Double) Returns the distance between one point and the current position in kilometers using Haversine formula (Great-circle).
Public methodDistanceToAsKm(Int32, Int32, Double, CardinalPoint, Int32, Int32, Double, CardinalPoint) Returns the distance between one point and the current position in kilometers using Haversine formula (Great-circle).
Public methodDistanceToAsMiles(Double, Double) Returns the distance between one point and the current position in miles using Haversine formula (Great-circle).
Public methodDistanceToAsMiles(Int32, Int32, Double, CardinalPoint, Int32, Int32, Double, CardinalPoint) Returns the distance between one point and the current position in miles using Haversine formula (Great-circle).
Public methodStatic memberDmsToDecimalDegrees Converts DMS (degree/minute/Second) to decimal degrees.
Public methodStatic memberDmsToDm(Int32, Int32, Double, CardinalPoint) Converts DMS (DegreeMinuteSecond) to DM (DegreeMinute, concatenated: DDMM.mmmm).
Public methodStatic memberDmsToDm(Int32, Int32, Double, Int32, Double) Converts DMS (DegreeMinuteSecond) to DM (DegreeMinute).
Public methodStatic memberDmsToRadians Converts DMS (degree/minute/Second) to radians.
Public methodStatic memberDmToDms(Double, Int32, Int32, Double) Converts DM (DegreeMinute) to DMS (DegreeMinuteSecond).
Public methodStatic memberDmToDms(Int32, Double, Int32, Int32, Double) Converts DM (DegreeMinute) to DMS (DegreeMinuteSecond).
Public methodEquals Returns a value indicating whether this instance and a specified Position object represent the same value.
(Overrides ObjectEquals(Object))
Public methodStatic memberFeetToMeters Converts feet to meters.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCode Serves as the default hash function.
(Overrides ObjectGetHashCode)
Public methodGetLatitudeAsDecimalDegrees Returns current latitude in decimal degrees.
Public methodGetLatitudeAsDm Returns latitude in DM (DecimalMinute, concatenated: DDMM.mmmm) format.
Public methodGetLatitudeAsRadians Returns current latitude in radians.
Public methodGetLocalDateTime Returns current local datetime.
Public methodGetLongitudeAsDecimalDegrees Returns current longitude in decimal degrees.
Public methodGetLongitudeAsDm Returns longitude in DM (DecimalMinute, concatenated: DDMM.mmmm) format.
Public methodGetLongitudeAsRadians Returns current longitude in radians.
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodGetUtcDateTime Returns current UTC datetime.
Public methodIsFix Returns true, if position is a fix.
Public methodStatic memberKmhToKnots Converts km/h to knots.
Public methodStatic memberKmToMiles Converts kilometers to miles.
Public methodStatic memberKmToNauticalMiles Converts kilometers to nautical miles.
Public methodStatic memberKnotsToKmh Converts knots to km/h.
Public methodStatic memberLatitudeDecimalDegreesToDms Converts decimal degrees to DMS for latitude values.
Public methodStatic memberLatitudeRadiansToDms Converts radians to DMS for latitude values.
Public methodStatic memberLongitudeDecimalDegreesToDms Converts decimal degrees to DMS for longitude values.
Public methodStatic memberLongitudeRadiansToDms Converts radians to DMS for longitude values.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodStatic memberMetersToFeet Converts meters to feet.
Public methodStatic memberMilesToKm Converts miles to kilometers.
Public methodStatic memberNauticalMilesToKm Converts nautical miles to kilometers.
Public methodStatic memberRadiansToDecimalDegrees Converts radians to decimal degrees.
Public methodReset Resets the position.
Public methodSetDate Sets the date of the position.
Public methodSetDateTime Sets the date-time of the position.
Public methodSetPositionInDecimalDegrees Sets the position from decimal degrees.
Public methodSetPositionInDm Sets the position from DM format (DegreeMinute DDMM.mmmm).
Public methodSetTime Sets the time of the position.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Operators
 NameDescription
Public operatorStatic memberEquality(Position, Position) == operator
Public operatorStatic memberInequality(Position, Position) != operator
Top
Fields
 NameDescription
Public fieldStatic memberEquatorialEarthRadius Size of the Earth's radius at the equator in kilometers.
Top
See Also