Click or drag to resize

BaseGpsReceiver Class

Implements an abstract GPS receiver. It must be the base class for real GPS receivers.
Inheritance Hierarchy
SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      ZylSoft.GpsBaseGpsReceiver
        More

Namespace: ZylSoft.Gps
Assembly: ZylGpsReceiver (in ZylGpsReceiver.dll) Version: 3.28.8737.22596
XMLNS for XAML: Not mapped to an xmlns.
Syntax
public class BaseGpsReceiver : Component

The BaseGpsReceiver type exposes the following members.

Constructors
 NameDescription
Public methodBaseGpsReceiver Constructor.
Public methodBaseGpsReceiver(IContainer) Constructor.
Top
Properties
 NameDescription
Public propertyActiveRoute The active route.
Protected propertyCanRaiseEventsGets a value indicating whether the component can raise an event.
(Inherited from Component)
Public propertyContainerGets the IContainer that contains the Component.
(Inherited from Component)
Protected propertyDesignModeGets a value that indicates whether the Component is currently in design mode.
(Inherited from Component)
Protected propertyEventsGets the list of event handlers that are attached to this Component.
(Inherited from Component)
Public propertyForceChecksum Enable or ignore checksum checking for NMEA sentences. When this property is true, all the sentences which checksum is not correct will be ignored.
Public propertyLogDateTime When this property is true, a date-time stamp will be added before each logged NMEA sentence.
Public propertyLogFile Name and path of the NMEA log file.
Public propertyLogNmea Enables or disables NMEA logging. If you enable it, all the valid NMEA sentences will be logged to the LogFile.
Public propertyNavigationInfo Returns information about the active route.
Public propertyNmeaSentencePrefix NMEA sentence prefix. Default value: "$"
Public propertyNmeaSentences Accepted NMEA sentences.
Public propertyNmeaSentenceTerminator NMEA sentence terminator. Default value: ((char)13(char)10)
Public propertyNmeaSentenceTerminator2 Second NMEA sentence terminator. Default value: ((char)13) It is used, if NmeaSentenceTerminator is not found in the sentence.
Public propertyPosition Contains the current position data.
Public propertyReceiverStatus Returns status info of the GPS receiver unit.
Public propertySatelliteTypes Accepted satellites.
Public propertySiteGets or sets the ISite of the Component.
(Inherited from Component)
Public propertyTrack The current track.
Public propertyStatic memberUnlockKey Unlock key.
Public propertyWaypoints List of waypoints (List of Waypoint objects).
Top
Methods
 NameDescription
Public methodAddChecksumToNmea Adds checksum to a NMEA sentence (including asterix).
Public methodAddSentenceTerminatorToNmea Adds sentence terminator (usually CR-LF) to an NMEA sentence.
Public methodStatic memberAsciiByteArrayToString Converts ASCII / ANSI byte array to string.
Public methodChecksumOk Checks if the checksum of the sentence is valid.
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject)
Public methodDisposeReleases all resources used by the Component.
(Inherited from Component)
Protected methodDispose(Boolean) Clean up any resources being used.
(Overrides ComponentDispose(Boolean))
Public methodCode exampleDrawCompass Draws a compass.
Public methodDrawCompassToBitmap Draws a compass to a bitmap.
Public methodCode exampleDrawCompassWithSkin(Graphics, Int32) Draws a compass, using an embedded skin.
Public methodCode exampleDrawCompassWithSkin(Graphics, Image, Int32) Draws a compass, using a custom skin.
Public methodCode exampleDrawCompassWithSkin(Graphics, String, Int32) Draws a compass, using a custom skin.
Public methodDrawCompassWithSkinToBitmap Draws a compass with skin to a bitmap.
Public methodCode exampleDrawSatellites Draws the satellites in view. Red brush satellite - very low signal Orange brush satellite - low signal Yellow brush satellite - medium signal Light green brush satellite - good signal Green brush satellite - very 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
Public methodDrawSatellitesSignal(Graphics, Int32, Int32, Color) Draw the signals of satellites in view. Red brush satellite - very low signal Orange brush satellite - low signal Yellow brush satellite - medium signal Light green brush satellite - good signal Green brush satellite - very good signal
Public methodDrawSatellitesSignal(Graphics, Int32, Int32, Color, Color, Color, Int32) Draw the signals of satellites in view. Red brush satellite - very low signal Orange brush satellite - low signal Yellow brush satellite - medium signal Light green brush satellite - good signal Green brush satellite - very good signal
Public methodDrawSatellitesSignalToBitmap Draw the signals of satellites in view to a bitmap. Red brush satellite - very low signal Orange brush satellite - low signal Yellow brush satellite - medium signal Light green brush satellite - good signal Green brush satellite - very good signal
Public methodDrawSatellitesToBitmap Draws the satellites in view to a bitmap. Red brush satellite - very low signal Orange brush satellite - low signal Yellow brush satellite - medium signal Light green brush satellite - good signal Green brush satellite - very 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
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFeedGpsReceiver Use this method to feed the GPS receiver with NMEA data from the source you wish for classes derived from BaseGpsReceiver.
Protected methodFinalizeReleases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
(Inherited from Component)
Public methodGetAverageSatelliteSnr Returns the average SignalToNoiseRatio of satellites using the highest 4 values.
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
Public methodGetNmeaChecksum Returns the checksum of a sentence.
Protected methodGetServiceReturns an object that represents a service provided by the Component or by its Container.
(Inherited from Component)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject)
Protected methodOnActiveRouteReceived Raises the ActiveRouteReceived event.
Protected methodOnAltitudeChanged Raises the AltitudeChanged event.
Protected methodOnArrival Raises the Arrival event.
Protected methodOnCourseChanged Raises the CourseChanged event.
Protected methodOnHeadingChanged Raises the HeadingChanged event.
Protected methodOnLatitudeChanged Raises the LatitudeChanged event.
Protected methodOnLongitudeChanged Raises the LongitudeChanged event.
Protected methodOnNewSentenceReceived Raises the NewSentenceReceived event.
Protected methodOnPosition2DChanged Raises the Position2DChanged event.
Protected methodOnPosition3DChanged Raises the Position3DChanged event.
Protected methodOnReceived Raises the Received event.
Protected methodOnSatelliteReceived Raises the SatelliteReceived event.
Protected methodOnSatellitesReceived Raises the SatellitesReceived event.
Protected methodOnSent Raises the Sent event.
Protected methodOnSpeedChanged Raises the SpeedChanged event.
Protected methodOnUnknownSentenceReceived Raises the UnknownSentenceReceived event.
Protected methodOnWaypointReceived Raises the WaypointReceived event.
Public methodReset Resets all GPS data to a default value: Position, ReceiverStatus, NavigationInfo, WayPoints, ActiveRoute, Track.
Protected methodRouteToNmea(Route) Converts a route to NMEA.
Protected methodRouteToNmea(String) Converts a route to NMEA.
Public methodShowOnGoogleMaps(Int32) Displays the current position on Google maps in the default browser.
Public methodStatic memberShowOnGoogleMaps(Double, Double, Int32) Displays the specified position on google maps in the default browser.
Public methodStatic memberStringToAsciiByteArray Converts string to ASCII / ANSI byte array.
Public methodToStringReturns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component)
Protected methodWaypointToNmea Converts a waypoint to NMEA.
Top
Events
 NameDescription
Public eventActiveRouteReceived Occurs when the active route is received.
Public eventAltitudeChanged Occurs when the altitude has changed.
Public eventArrival Occurs at the arrival to the destination waypoint.
Public eventCourseChanged Occurs when the course has changed.
Public eventDisposedOccurs when the component is disposed by a call to the Dispose method.
(Inherited from Component)
Public eventHeadingChanged Occurs when the heading has changed.
Public eventLatitudeChanged Occurs when the latitude has changed.
Public eventLongitudeChanged Occurs when the longitude has changed.
Public eventNewSentenceReceived Occurs when a new valid NMEA sentence is received. The sentence parameter contains the sentence.
Public eventPosition2DChanged Occurs when latitude or longitude has changed.
Public eventPosition3DChanged Occurs when latitude or longitude or altitude has changed.
Public eventReceived Occurs when data was received.
Public eventSatelliteReceived Occurs when a satellite is received.
Public eventSatellitesReceived Occurs when a list of all satellites in view is received.
Public eventSent Occurs when data was sent.
Public eventSpeedChanged Occurs when the speed has changed.
Public eventUnknownSentenceReceived 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.
Public eventWaypointReceived Occurs when a waypoint is received.
Top
Extension Methods
 NameDescription
Public Extension MethodCode exampleDrawCompassToWpfCanvas Draws a compass to WPF canvas.
(Defined by BaseGpsReceiverWpfExtensions)
Public Extension MethodCode exampleDrawCompassWithSkinToWpfCanvas Draws a compass, using an embedded skin to WPF canvas.
(Defined by BaseGpsReceiverWpfExtensions)
Public Extension MethodCode exampleDrawCompassWithSkinToWpfCanvas Draws a compass, using a custom skin to WPF canvas.
(Defined by BaseGpsReceiverWpfExtensions)
Public Extension MethodDrawSatellitesSignalToWpfCanvas Draw the signals of satellites in view to WPF canvas. Red brush satellite - very low signal Orange brush satellite - low signal Yellow brush satellite - medium signal Light green brush satellite - good signal Green brush satellite - very good signal
(Defined by BaseGpsReceiverWpfExtensions)
Public Extension MethodDrawSatellitesSignalToWpfCanvas Draw the signals of satellites in view to WPF canvas. Red brush satellite - very low signal Orange brush satellite - low signal Yellow brush satellite - medium signal Light green brush satellite - good signal Green brush satellite - very good signal
(Defined by BaseGpsReceiverWpfExtensions)
Public Extension MethodCode exampleDrawSatellitesToWpfCanvas Draws the satellites in view to WPF canvas. Red brush satellite - very low signal Orange brush satellite - low signal Yellow brush satellite - medium signal Light green brush satellite - good signal Green brush satellite - very 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
(Defined by BaseGpsReceiverWpfExtensions)
Top
See Also
Inheritance Hierarchy
SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      ZylSoft.GpsBaseGpsReceiver
        ZylSoft.GpsFileGpsReceiver
        ZylSoft.GpsGpsReceiver
        ZylSoft.GpsGpxGpsReceiver
        ZylSoft.GpsManagedGpsReceiver
        ZylSoft.GpsNmeaDecoder
        ZylSoft.GpsTcpGpsReceiver
        ZylSoft.GpsUdpGpsReceiver