Implements an abstract GPS receiver.
It must be the base class for real GPS receivers.
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 BaseGpsReceiver type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| BaseGpsReceiver |
Constructor.
| |
| BaseGpsReceiver(IContainer) |
Constructor.
|
Properties
| Name | Description | |
|---|---|---|
| ActiveRoute |
The active route.
| |
| CanRaiseEvents | Gets a value indicating whether the component can raise an event. (Inherited from Component.) | |
| Container | Gets the IContainer that contains the Component. (Inherited from Component.) | |
| DesignMode | Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.) | |
| Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component.) | |
| 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.
| |
| LogDateTime |
When this property is true, a date-time stamp will be added before each logged NMEA sentence.
| |
| LogFile |
Name and path of the NMEA log file.
| |
| LogNmea |
Enables or disables NMEA logging.
If you enable it, all the valid NMEA sentences will be logged to the LogFile.
| |
| NavigationInfo |
Returns information about the active route.
| |
| NmeaSentencePrefix |
NMEA sentence prefix.
Default value: "$"
| |
| NmeaSentences |
Accepted NMEA sentences.
| |
| NmeaSentenceTerminator |
NMEA sentence terminator.
Default value: ((char)13(char)10)
| |
| NmeaSentenceTerminator2 |
Second NMEA sentence terminator.
Default value: ((char)13)
It is used, if NmeaSentenceTerminator is not found in the sentence.
| |
| Position |
Contains the current position data.
| |
| ReceiverStatus |
Returns status info of the GPS receiver unit.
| |
| SatelliteTypes |
Accepted satellites.
| |
| Site | (Inherited from Component.) | |
| Track |
The current track.
| |
| UnlockKey |
Unlock key.
| |
| Waypoints |
List of waypoints (List of Waypoint objects).
|
Methods
| Name | Description | |
|---|---|---|
| AddChecksumToNmea |
Adds checksum to a NMEA sentence (including asterix).
| |
| AddSentenceTerminatorToNmea |
Adds sentence terminator (usually CR-LF) to an NMEA sentence.
| |
| AsciiByteArrayToString |
Converts ASCII / ANSI byte array to string.
| |
| ChecksumOk |
Checks if the checksum of the sentence is valid.
| |
| 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.) | |
| Dispose | Releases all resources used by the Component. (Inherited from Component.) | |
| Dispose(Boolean) |
Clean up any resources being used.
(Overrides ComponentDispose(Boolean).) | |
| DrawCompass |
Draws a compass.
| |
| 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
| |
| Equals | (Inherited from Object.) | |
| FeedGpsReceiver |
Use this method to feed the GPS receiver with NMEA data from the source you wish for classes derived from BaseGpsReceiver.
| |
| Finalize | Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.) | |
| 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.
| |
| 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.) | |
| 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.
| |
| OnAltitudeChanged |
Raises the AltitudeChanged event.
| |
| OnArrival |
Raises the Arrival event.
| |
| OnCourseChanged |
Raises the CourseChanged event.
| |
| OnHeadingChanged |
Raises the HeadingChanged event.
| |
| OnLatitudeChanged |
Raises the LatitudeChanged event.
| |
| OnLongitudeChanged |
Raises the LongitudeChanged event.
| |
| OnNewSentenceReceived |
Raises the NewSentenceReceived event.
| |
| OnPosition2DChanged |
Raises the Position2DChanged event.
| |
| OnPosition3DChanged |
Raises the Position3DChanged event.
| |
| OnReceived |
Raises the Received event.
| |
| OnSatelliteReceived |
Raises the SatelliteReceived event.
| |
| OnSatellitesReceived |
Raises the SatellitesReceived event.
| |
| OnSent |
Raises the Sent event.
| |
| OnSpeedChanged |
Raises the SpeedChanged event.
| |
| OnUnknownSentenceReceived |
Raises the UnknownSentenceReceived event.
| |
| OnWaypointReceived |
Raises the WaypointReceived event.
| |
| Reset |
Resets all GPS data to a default value:
Position, ReceiverStatus, NavigationInfo, WayPoints, ActiveRoute, Track.
| |
| RouteToNmea(String) |
Converts a route to NMEA.
| |
| RouteToNmea(Route) |
Converts a route to NMEA.
| |
| ShowOnGoogleMaps(Int32) |
Displays the current position on Google maps in the default browser.
| |
| ShowOnGoogleMaps(Double, Double, Int32) |
Displays the specified position on google maps in the default browser.
| |
| StringToAsciiByteArray |
Converts string to ASCII / ANSI byte array.
| |
| ToString | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.) | |
| WaypointToNmea |
Converts a waypoint to NMEA.
|
Events
| Name | Description | |
|---|---|---|
| ActiveRouteReceived |
Occurs when the active route is received.
| |
| AltitudeChanged |
Occurs when the altitude has changed.
| |
| Arrival |
Occurs at the arrival to the destination waypoint.
| |
| CourseChanged |
Occurs when the course has changed.
| |
| Disposed | Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.) | |
| HeadingChanged |
Occurs when the heading has changed.
| |
| LatitudeChanged |
Occurs when the latitude has changed.
| |
| LongitudeChanged |
Occurs when the longitude has changed.
| |
| NewSentenceReceived |
Occurs when a new valid NMEA sentence is received. The sentence parameter contains the sentence.
| |
| Position2DChanged |
Occurs when latitude or longitude has changed.
| |
| Position3DChanged |
Occurs when latitude or longitude or altitude has changed.
| |
| Received |
Occurs when data was received.
| |
| SatelliteReceived |
Occurs when a satellite is received.
| |
| SatellitesReceived |
Occurs when a list of all satellites in view is received.
| |
| Sent |
Occurs when data was sent.
| |
| SpeedChanged |
Occurs when the speed has changed.
| |
| 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.
| |
| WaypointReceived |
Occurs when a waypoint is received.
|
See Also