GPS base class

The GPS class is a base class for nonvisual objects that can read and process global positioning system information. The SerialGPS object implements all the methods and properties of this base class.

Properties

GPS property

Datatype

Description

ClassDefinition

PowerObject

An object of type PowerObject containing information about the class definition of the object or control.

ConfigParams

String

Customization property that is currently undefined.

DeviceHandle

UnsignedLong

Read-only value containing a device-specific handle.

RawData

String

Read-only, raw, NMEA-formatted data without any parsing for validity.

Vendor

String

Customization property that is currently undefined.

Events

GPS event

Occurs

Constructor

When the object is created

Destructor

When the object is destroyed

Functions

GPS function

Datatype returned

Description

Close

Integer

Closes a GPS communications channel if one is open and deactivates the data handlers.

GetFix

GPSFix

Populates the GPSFix structure with values from the current fix.

GetHeading

GPSHeading

Populates the GPSHeading structure with values from the current heading.

GetSatellitesInView

GPSSatellitesInView

Populates the GPSSatellitePosition and GPSSatellitesInView structures with position information from the current satellites in view.

Open

Integer

Initializes GPS data handlers and opens a communications channel. You can use an optional string argument to force-feed a single set of GPS data without opening a communications channel. If this argument is used, the data acquisition behavior of derived classes (SerialGPS) remains undefined.