Implements the communication with an integrated, USB or bluetooth GPS receiver for Windows Mobile.
Inheritance Hierarchy
SystemMarshalByRefObject
System.ComponentModelComponent
ZylSoft.Gps.MobileBaseGpsReceiver
ZylSoft.Gps.MobileGpsReceiver
Namespace: ZylSoft.Gps.Mobile
Assembly: ZylGpsReceiverMobile (in ZylGpsReceiverMobile.dll) Version: 3.14.6846.29005
Syntax
The GpsReceiver type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| GpsReceiver |
Constructor.
| |
| GpsReceiver(IContainer) |
Constructor.
| |
| GpsReceiver(SerialCommPort, SerialBaudRate) |
Constructor.
| |
| GpsReceiver(SerialCommPort, SerialBaudRate, SerialDataWidth, StopBits, Parity) |
Constructor.
|
Properties
| Name | Description | |
|---|---|---|
| ActiveRoute |
The active route.
(Inherited from BaseGpsReceiver.) | |
| BaudRate |
Baud rate at which the communications device operates.
| |
| CanRaiseEvents | Gets a value indicating whether the component can raise an event. (Inherited from Component.) | |
| ConnectedTo |
Returns the physical port where the GPS receiver is connected to.
| |
| Container | Gets the IContainer that contains the Component. (Inherited from Component.) | |
| CustomBaudRate |
Custom baud rate value, used when BaudRate is set to Custom.
| |
| DataWidth |
Number of bits in the bytes transmitted and received.
| |
| DesignMode | Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.) | |
| EnableDtrOnOpen |
Enable/disable DTR when the port is open.
| |
| EnableRtsOnOpen |
Enable/disable RTS when the port is open.
| |
| Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component.) | |
| FlowControl |
Flow control of the serial port.
| |
| ForceChecksum |
Enable or ignore checksum checking for NMEA sentences.
When this property is true, all the sentences which checksum is not correct will be ignored.
(Inherited from BaseGpsReceiver.) | |
| LogDateTime |
When this property is true, a date-time stamp will be added before each logged NMEA sentence.
(Inherited from BaseGpsReceiver.) | |
| LogFile |
Name and path of the NMEA log file.
(Inherited from BaseGpsReceiver.) | |
| LogNmea |
Enables or disables NMEA logging.
If you enable it, all the valid NMEA sentences will be logged to the LogFile.
(Inherited from BaseGpsReceiver.) | |
| NavigationInfo |
Returns information about the active route.
(Inherited from BaseGpsReceiver.) | |
| NmeaSentencePrefix |
NMEA sentence prefix.
Default value: "$"
(Inherited from BaseGpsReceiver.) | |
| NmeaSentences |
Accepted NMEA sentences.
(Inherited from BaseGpsReceiver.) | |
| NmeaSentenceTerminator |
NMEA sentence terminator.
Default value: ((char)13(char)10)
(Inherited from BaseGpsReceiver.) | |
| NmeaSentenceTerminator2 |
Second NMEA sentence terminator.
Default value: ((char)13)
It is used, if NmeaSentenceTerminator is not found in the sentence.
(Inherited from BaseGpsReceiver.) | |
| ParityBits |
Parity scheme to be used.
| |
| Port |
Physical name of the serial port where the GPS receiver is connected to.
| |
| Position |
Contains the current position data.
(Inherited from BaseGpsReceiver.) | |
| ReadIntervalTimeout |
Maximum time allowed to elapse between the arrival of two characters on
the communications line, in milliseconds. During a ReadFile operation, the time
period begins when the first character is received. If the interval between the
arrival of any two characters exceeds this amount, the ReadFile operation is
completed and any buffered data is returned. A value of zero indicates that
interval time-outs are not used. A value of MAXDWORD, combined with zero values
for both the ReadTotalTimeoutConstant and ReadTotalTimeoutMultiplier members,
specifies that the read operation is to return immediately with the characters
that have already been received, even if no characters have been received.
| |
| ReceiverStatus |
Returns status info of the GPS receiver unit.
(Inherited from BaseGpsReceiver.) | |
| SatelliteTypes |
Accepted satellites.
(Inherited from BaseGpsReceiver.) | |
| Site | (Inherited from Component.) | |
| StopBits |
Number of stop bits to be used.
| |
| Track |
The current track.
(Inherited from BaseGpsReceiver.) | |
| Waypoints |
List of waypoints (List of Waypoint objects).
(Inherited from BaseGpsReceiver.) | |
| WriteIntervalTimeout |
Gets or sets the number of milliseconds before a time-out occurs when a write operation does not finish.
|
Methods
| Name | Description | |
|---|---|---|
| AddChecksumToNmea |
Adds checksum to a NMEA sentence (including asterix).
(Inherited from BaseGpsReceiver.) | |
| AddSentenceTerminatorToNmea |
Adds sentence terminator (usually CR-LF) to an NMEA sentence.
(Inherited from BaseGpsReceiver.) | |
| ChecksumOk |
Checks if the checksum of the sentence is valid.
(Inherited from BaseGpsReceiver.) | |
| Close |
Closes the communication with the GPS receiver.
| |
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) | |
| DetectGps(SerialCommPort, SerialBaudRate) |
Detects the GPS receiver connected to the system and returns as output parameters the communication port and baud rate.
| |
| DetectGps(SerialBaudRate, SerialBaudRate, SerialCommPort, SerialBaudRate) |
Detects the GPS receiver connected to the system and returns as output parameters
the communication port and baud rate.
Only baud rate values between startBaudRate and endBaudRate are checked.
| |
| Dispose | Releases all resources used by the Component. (Inherited from Component.) | |
| Dispose(Boolean) |
Clean up any resources being used.
(Overrides BaseGpsReceiverDispose(Boolean).) | |
| DrawCompass |
Draws a compass.
(Inherited from BaseGpsReceiver.) | |
| DrawSatellites |
Draws the satellites in view.
Grey brush satellite - no signal
Red brush satellite - very low signal
Yellow brush satellite - low signal
Light green brush satellite - medium signal
Green brush satellite - good signal
White pen satellite - GPS
Orange red pen satellite - GLONASS
Yellow pen satellite - BeiDou
Blue pen satellite - Galileo
Green pen satellite - QZSS
Black pen satellite - Unknown
(Inherited from BaseGpsReceiver.) | |
| Equals | (Inherited from Object.) | |
| FastDetectGps |
Detects the GPS receiver connected to the system and returns as output parameters the communication port and baud rate.
Only baud rate values between 4800 and 460800 are checked.
| |
| FeedGpsReceiver |
Use this method to feed the GPS receiver with NMEA data from the source you wish for classes derived from BaseGpsReceiver.
(Inherited from BaseGpsReceiver.) | |
| Finalize | Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.) | |
| GetExistingCommPortNames |
Returns the existing serial port names of the system.
| |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) | |
| GetNmeaChecksum |
Returns the checksum of a sentence.
(Inherited from BaseGpsReceiver.) | |
| GetService | (Inherited from Component.) | |
| GetType | Gets the type of the current instance. (Inherited from Object.) | |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) | |
| IsExistingCommPort |
Checks if a serial port exists.
| |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) | |
| OnActiveRouteReceived |
Raises the ActiveRouteReceived event.
(Inherited from BaseGpsReceiver.) | |
| OnAltitudeChanged |
Raises the AltitudeChanged event.
(Inherited from BaseGpsReceiver.) | |
| OnArrival |
Raises the Arrival event.
(Inherited from BaseGpsReceiver.) | |
| OnConnected |
Raises the Connected event.
| |
| OnCourseChanged |
Raises the CourseChanged event.
(Inherited from BaseGpsReceiver.) | |
| OnDetecting |
Raises the Detecting event.
| |
| OnDisconnected |
Raises the Disconnected event.
| |
| OnHeadingChanged |
Raises the HeadingChanged event.
(Inherited from BaseGpsReceiver.) | |
| OnLatitudeChanged |
Raises the LatitudeChanged event.
(Inherited from BaseGpsReceiver.) | |
| OnLongitudeChanged |
Raises the LongitudeChanged event.
(Inherited from BaseGpsReceiver.) | |
| OnNewSentenceReceived |
Raises the NewSentenceReceived event.
(Inherited from BaseGpsReceiver.) | |
| OnPosition2DChanged |
Raises the Position2DChanged event.
(Inherited from BaseGpsReceiver.) | |
| OnPosition3DChanged |
Raises the Position3DChanged event.
(Inherited from BaseGpsReceiver.) | |
| OnReceived |
Raises the Received event.
(Inherited from BaseGpsReceiver.) | |
| OnSatelliteReceived |
Raises the SatelliteReceived event.
(Inherited from BaseGpsReceiver.) | |
| OnSatellitesReceived |
Raises the SatellitesReceived event.
(Inherited from BaseGpsReceiver.) | |
| OnSent |
Raises the Sent event.
(Inherited from BaseGpsReceiver.) | |
| OnSpeedChanged |
Raises the SpeedChanged event.
(Inherited from BaseGpsReceiver.) | |
| OnUnknownSentenceReceived |
Raises the UnknownSentenceReceived event.
(Inherited from BaseGpsReceiver.) | |
| OnWaypointReceived |
Raises the WaypointReceived event.
(Inherited from BaseGpsReceiver.) | |
| Open |
Opens the communication with the GPS receiver.
| |
| Reset |
Resets all GPS data to a default value:
Position, ReceiverStatus, NavigationInfo, WayPoints, ActiveRoute, Track.
(Inherited from BaseGpsReceiver.) | |
| RouteToNmea(String) |
Converts a route to NMEA.
(Inherited from BaseGpsReceiver.) | |
| RouteToNmea(Route) |
Converts a route to NMEA.
(Inherited from BaseGpsReceiver.) | |
| SendAsciiString |
Sends an ASCII string to the GPS receiver.
| |
| SendByteArray |
Sends a byte array to the GPS receiver.
| |
| ShowOnGoogleMaps(Int32) |
Displays the current position on Google maps in the default browser.
(Inherited from BaseGpsReceiver.) | |
| ToString | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.) | |
| UploadRoute(String) |
It uploads a route.
| |
| UploadRoute(Route) |
It uploads a route.
| |
| UploadWaypoint |
Uploads a waypoint.
| |
| WaypointToNmea |
Converts a waypoint to NMEA.
(Inherited from BaseGpsReceiver.) |
Events
| Name | Description | |
|---|---|---|
| ActiveRouteReceived |
Occurs when the active route is received.
(Inherited from BaseGpsReceiver.) | |
| AltitudeChanged |
Occurs when the altitude has changed.
(Inherited from BaseGpsReceiver.) | |
| Arrival |
Occurs at the arrival to the destination waypoint.
(Inherited from BaseGpsReceiver.) | |
| Connected |
Occurs after the GPS receiver is connected.
| |
| CourseChanged |
Occurs when the course has changed.
(Inherited from BaseGpsReceiver.) | |
| Detecting |
Occurs when the GPS receiver detection is in progress
and there are new values of port or baud rate in view.
| |
| Disconnected |
Occurs when the GPS receiver is disconnected.
| |
| Disposed | Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.) | |
| HeadingChanged |
Occurs when the heading has changed.
(Inherited from BaseGpsReceiver.) | |
| LatitudeChanged |
Occurs when the latitude has changed.
(Inherited from BaseGpsReceiver.) | |
| LongitudeChanged |
Occurs when the longitude has changed.
(Inherited from BaseGpsReceiver.) | |
| NewSentenceReceived |
Occurs when a new valid NMEA sentence is received. The sentence parameter contains the sentence.
(Inherited from BaseGpsReceiver.) | |
| Position2DChanged |
Occurs when latitude or longitude has changed.
(Inherited from BaseGpsReceiver.) | |
| Position3DChanged |
Occurs when latitude or longitude or altitude has changed.
(Inherited from BaseGpsReceiver.) | |
| Received |
Occurs when data was received.
(Inherited from BaseGpsReceiver.) | |
| SatelliteReceived |
Occurs when a satellite is received.
(Inherited from BaseGpsReceiver.) | |
| SatellitesReceived |
Occurs when a list of all satellites in view is received.
(Inherited from BaseGpsReceiver.) | |
| Sent |
Occurs when data was sent.
(Inherited from BaseGpsReceiver.) | |
| SpeedChanged |
Occurs when the speed has changed.
(Inherited from BaseGpsReceiver.) | |
| UnknownSentenceReceived |
Occurs when a valid, but unknown NMEA sentence is received. The sentence parameter contains the unknown sentence.
This event is fired only if you set NmeaSentences property to All and there is an unknown sentence received. In this case you can write your own processing code inside this event handler.
(Inherited from BaseGpsReceiver.) | |
| WaypointReceived |
Occurs when a waypoint is received.
(Inherited from BaseGpsReceiver.) |
Remarks
See Also