GPS ToolKit Class

Root class for all communications with a GPS device.

Syntax

[Visual Basic]
Dim instance As GPSToolKit

[C#]
GPSToolKit instance

[C++]
GPSToolKit* instance

Remarks

GPSToolKit is the root class for all the functionality provided with GPS ToolKit. Each GPSToolKit instance can communicate with one GPS. If you wish to communicate with multiple GPS devices simultaneously, you should create one instance of GPSToolKit per device.

Instance Hierarchy

SciCom
   SciCom.GPSToolKit
     SciCom.GPSToolKit.GPSToolKit

Thread Safety

GPSToolKit is thread safe for use by multiple reader threads, or a single writing thread. It is not thread safe for multi-thread use, when any of the threads perform write (update) operations.

Properties

Property	Description
BaudRate property	Sets and returns the baud rate communications parameter
ExtendedFixData property	Returns extended data about the current fix status and estimated precision
IsGPSConnected property	Returns true if a connection is present with a recognized GPS device
IsPortOpen property	Returns the state of the COM port underlying the GPS connection
LastPositionUpdateTime property	Returns the date and time that the position was last updated
NavigationData property	Gets current GPS navigation information including active route data (only available when using the NMEA 0183 protocol)
PortName property	Returns the name of the underlying COM port ("COM1", "COM2", etc.)
Protocol property	Returns the current communications protocol between GPS ToolKit and the GPS
Position property	Returns the current GPS position
Satellites property	Returns information about the satellites currently in view
Speed property	Gets the current speed from the GPS
TrueCourse property	Returns the current GPS true course in degrees

Methods

Method	Description
AddRoute method	Adds a route to the GPS (only available when using the Garmin protocol)
AddTrack method	Adds a track to the GPS (only available when using the Garmin protocol)
AddWaypoint method	Adds a waypoint to the GPS (only available when using the Garmin protocol)
AutoDetectGPS method	Automatically opens a connection with a connected GPS using the NMEA 0183 or Garmin protocol
Close method	Stops the reading of GPS data and closes the communications port if open
GetAvailableSystemPorts method	Returns a collection of port names available to be opened
GetGPSInfo method	Returns information about the GPS and its software version
GetRoutes method	Gets all routes stored in the GPS (only available when using the Garmin protocol)
GetSystemPorts method	Returns a collection of port names on the system
GetTracks method	Gets all tracks stored in the GPS (only available when using the Garmin protocol)
GetWaypoints method	Gets all waypoints stored in the GPS (only available when using the Garmin protocol)
Open method	Opens the communications port and begins reading GPS data
ShutOffGPS method	Turns the GPS off (only available when using the Garmin protocol)
WriteRawBinaryToGPS method	Writes binary data and commands to the GPS
WriteRawToGPS method	Writes string data and commands to the GPS

Events

Event	Description
FileComplete event	Triggered when file read is complete or cancelled.
GPSConnected event	Triggered when a GPS connection has been made.
GPSDisconnected event	Triggered when communication with the GPS has stopped or been interrupted
NavigationUpdate event	Triggered when the new navigational information has been received from the GPS (only triggered when using the NMEA 0183 protocol).
PositionUpdate event	Triggered when the new position data has been received from the GPS.
RawDataReceived event	Triggered when a complete NMEA 0183 sentence has been received from the GPS (only triggered when using the NMEA 0183 protocol).
SatelliteUpdate event	Triggered when new satellite information has been received from the GPS (only triggered when using the NMEA 0183 protocol).

See Also