ZylGMaps Delphi & C++Builder Component

Class TGPSPosition

Description

Hierarchy

Fields

Methods

Properties

Unit

ZylGMaps

Declaration

type TGPSPosition = class(TPersistent)

Description

TGPSPosition class contains all the position and current status related data.

Hierarchy

TObject
TPersistent
TGPSPosition

Overview

Methods

	`constructor Create; overload;`
	`constructor Create(const latitude: Extended; const longitude: Extended); overload;`
	`procedure Reset;`
	`destructor Destroy; override;`
	`function Clone(): TGPSPosition;`
	`function CompareTo(a: TGPSPosition): Integer;`
	`class function DMSToDecimalDegrees(Degree, Minute: Integer; Second: Extended; Direction: TCardinalPoint): Extended;`
	`function GetLatitudeAsDecimalDegrees: Extended;`
	`function GetLongitudeAsDecimalDegrees: Extended;`
	`class procedure LatitudeDecimalDegreesToDMS(DecDegree: Extended; var Degree, Minute: Integer; var Second: Extended; var Direction: TCardinalPoint);`
	`class procedure LongitudeDecimalDegreesToDMS(DecDegree: Extended; var Degree, Minute: Integer; var Second: Extended; var Direction: TCardinalPoint);`
	`procedure SetPositionInDecimalDegrees(latitude: Extended; longitude: Extended);`
	`class function LatitudeDecimalDegreesToMeters(const LatitudeAsDecimalDegrees: Extended): Extended;`
	`class function LongitudeDecimalDegreesToMeters(const LongitudeAsDecimalDegrees: Extended): Extended;`
	`class function MetersToLatitudeDecimalDegrees(const LatitudeAsMeters: Extended): Extended;`
	`class function MetersToLongitudeDecimalDegrees(const LongitudeAsMeters: Extended): Extended;`

Properties

	`property Latitude_Degree: Integer read FLatitude_Degree write SetLatDeg;`
	`property Latitude_Minute: Integer read FLatitude_Minute write SetLatMin;`
	`property Latitude_Second: Extended read FLatitude_Second write SetLatSec;`
	`property Latitude_Direction: TCardinalPoint read FLatitude_Direction write SetLatDir;`
	`property Longitude_Degree: Integer read FLongitude_Degree write SetLongDeg;`
	`property Longitude_Minute: Integer read FLongitude_Minute write SetLongMin;`
	`property Longitude_Second: Extended read FLongitude_Second write SetLongSec;`
	`property Longitude_Direction: TCardinalPoint read FLongitude_Direction write SetLongDir;`
	`property Altitude: Extended read FAltitude write FAltitude;`
	`property Heading: Extended read FHeading write SetHeading;`
	`property Course: Extended read FCourse write SetCourse;`
	`property Speed_Knots: Extended read FSpeed_Knots write FSpeed_Knots;`
	`property Speed_KMH: Extended read FSpeed_KMH write FSpeed_KMH;`
	`property Magnetic_Variation: Extended read FMagnetic_Variation write SetMagneticVariation;`
	`property Magnetic_Variation_Direction: TCardinalPoint read FMagnetic_Variation_Direction write SetMagnetic_Variation_Direction;`
	`property Magnetic_Heading: Extended read FMagnetic_Heading write SetMagneticHeading;`
	`property Magnetic_Course: Extended read FMagnetic_Course write SetMagneticCourse;`
	`property Day: Word read FDay;`
	`property Month: Word read FMonth;`
	`property Year: Word read FYear;`
	`property Hour: Word read FHour;`
	`property Minute: Word read FMinute;`
	`property Second: Word read FSecond;`
	`property Millisecond: Word read FMillisecond;`
	`property DateTime: TDateTime read GetDateTime write SetDateTime;`
	`property Satellite_Count: Word read FSatellite_Count write FSatellite_Count;`
	`property PDOP: Extended read FPDOP write SetPDOP;`
	`property HDOP: Extended read FHDOP write SetHDOP;`
	`property VDOP: Extended read FVDOP write SetVDOP;`
	`property Geo_Height: Extended read FGeo_Height write FGeo_Height;`
	`property Fix: Integer read FFix write FFix;`
	`property Mode1: Integer read FMode1 write FMode1;`
	`property Mode2: Integer read FMode2 write FMode2;`

Description

Methods

	`constructor Create; overload;`
Constructor.

constructor Create(const latitude: Extended; const longitude: Extended); overload;

Constructor.

Parameters

latitude: Latitude in decimal degrees.
longitude: Longitude in decimal degrees.

	`procedure Reset;`
Reset the position to default value (0).

	`destructor Destroy; override;`
Destructor.

function Clone(): TGPSPosition;

Clone the object.

Returns

Cloned object.

function CompareTo(a: TGPSPosition): Integer;

Compare with other position.

Parameters

a: Position to compare to.

Returns

0 if the objects are equal.

class function DMSToDecimalDegrees(Degree, Minute: Integer; Second: Extended; Direction: TCardinalPoint): Extended;

Convert DMS to decimal degrees.

Parameters

Degree: Degrees.
Minute: Minutes.
Second: Seconds.
Direction: Direction.

Returns

Decimal degrees.

function GetLatitudeAsDecimalDegrees: Extended;

( Return current latitude to decimal degrees.

Returns

Latitude in decimal degrees.

function GetLongitudeAsDecimalDegrees: Extended;

( Return current longitude to decimal degrees.

Returns

Longitude in decimal degrees.

class procedure LatitudeDecimalDegreesToDMS(DecDegree: Extended; var Degree, Minute: Integer; var Second: Extended; var Direction: TCardinalPoint);

Convert latitude decimal degrees to DMS.

Parameters

DecDegree: Latitude in decimal degrees.
Degree: Degrees.
Minute: Minutes.
Second: Seconds.
Direction: Direction.

class procedure LongitudeDecimalDegreesToDMS(DecDegree: Extended; var Degree, Minute: Integer; var Second: Extended; var Direction: TCardinalPoint);

Convert longitude decimal degrees to DMS.

Parameters

DecDegree: Longitude in decimal degrees.
Degree: Degrees.
Minute: Minutes.
Second: Seconds.
Direction: Direction.

procedure SetPositionInDecimalDegrees(latitude: Extended; longitude: Extended);

Set current position in decimal degrees.

Parameters

latitude: Latitude in decimal degrees.
longitude: Longitude in decimal degrees.

class function LatitudeDecimalDegreesToMeters(const LatitudeAsDecimalDegrees: Extended): Extended;

Convert latitude decimal degrees in meters.

Parameters

latitudeAsDecimalDegrees: Latitude in decimal degrees.

Returns

Latitude in meters.

class function LongitudeDecimalDegreesToMeters(const LongitudeAsDecimalDegrees: Extended): Extended;

Converts longitude decimal degrees in meters.

Parameters

longitudeAsDecimalDegrees: Longitude in decimal degrees.

Returns

Longitude in meters.

class function MetersToLatitudeDecimalDegrees(const LatitudeAsMeters: Extended): Extended;

Converts latitude meters to decimal degrees.

Parameters

latitudeAsMeters: Latitude in meters.

Returns

Latitude in decimal degrees.

class function MetersToLongitudeDecimalDegrees(const LongitudeAsMeters: Extended): Extended;

Converts longitude meters to decimal degrees.

Parameters

longitudeAsMeters: Longitude in decimal degrees.

Returns

Longitude in decimal degrees.

Properties

	`property Latitude_Degree: Integer read FLatitude_Degree write SetLatDeg;`
Degree component of latitude.

	`property Latitude_Minute: Integer read FLatitude_Minute write SetLatMin;`
Minute component of latitude.

	`property Latitude_Second: Extended read FLatitude_Second write SetLatSec;`
Second component of latitude.

	`property Latitude_Direction: TCardinalPoint read FLatitude_Direction write SetLatDir;`
Direction component of latitude (North (+) or South (-)).

	`property Longitude_Degree: Integer read FLongitude_Degree write SetLongDeg;`
Degree component of longitude.

	`property Longitude_Minute: Integer read FLongitude_Minute write SetLongMin;`
Minute component of longitude.

	`property Longitude_Second: Extended read FLongitude_Second write SetLongSec;`
Second component of longitude.

	`property Longitude_Direction: TCardinalPoint read FLongitude_Direction write SetLongDir;`
Direction component of longitude (East or West).

	`property Altitude: Extended read FAltitude write FAltitude;`
Altitude in meters.

	`property Heading: Extended read FHeading write SetHeading;`
True heading in decimal degrees.

	`property Course: Extended read FCourse write SetCourse;`
True course in decimal degrees.

	`property Speed_Knots: Extended read FSpeed_Knots write FSpeed_Knots;`
Speed in knots.

	`property Speed_KMH: Extended read FSpeed_KMH write FSpeed_KMH;`
Speed in km/h.

	`property Magnetic_Variation: Extended read FMagnetic_Variation write SetMagneticVariation;`
Magnetic variation (declination) in degrees.

	`property Magnetic_Variation_Direction: TCardinalPoint read FMagnetic_Variation_Direction write SetMagnetic_Variation_Direction;`
Direction of magnetic variation (East or West).

	`property Magnetic_Heading: Extended read FMagnetic_Heading write SetMagneticHeading;`
Magnetic heading.

	`property Magnetic_Course: Extended read FMagnetic_Course write SetMagneticCourse;`
Magnetic course.

	`property Day: Word read FDay;`
Current day of the month.

	`property Month: Word read FMonth;`
Current month of the year.

	`property Year: Word read FYear;`
Current year.

	`property Hour: Word read FHour;`
Current hour.

	`property Minute: Word read FMinute;`
Current minute (time).

	`property Second: Word read FSecond;`
Current second (time).

	`property Millisecond: Word read FMillisecond;`
Current millisecond.

	`property DateTime: TDateTime read GetDateTime write SetDateTime;`
Current date-time.

	`property Satellite_Count: Word read FSatellite_Count write FSatellite_Count;`
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.

	`property PDOP: Extended read FPDOP write SetPDOP;`
Position dilution of precision.

	`property HDOP: Extended read FHDOP write SetHDOP;`
Horizontal dilution of precision.

	`property VDOP: Extended read FVDOP write SetVDOP;`
Vertical dilution of precision.

	`property Geo_Height: Extended read FGeo_Height write FGeo_Height;`
Difference between WGS-84 reference ellipsoid surface and the mean-sea-level altitude in meters (geoidal separation).

	`property Fix: Integer read FFix write FFix;`
Returns fix related data: -1 - No Info 0 - Invalid 1 - Valid SPS 2 - Valid DGPS 3 - Valid PPS

	`property Mode1: Integer read FMode1 write FMode1;`
Returns the operating mode: 1 - Auto 2D/3D 2 - Forced 2D/3D

	`property Mode2: Integer read FMode2 write FMode2;`
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

Generated by PasDoc 0.16.0.