Click or drag to resize

Navigator Class

Verizon Connect Logo
Print this page
Learn more about Verizon Connect GeoBase.
Get information about the latest release
Guides the user along a route using GPS updates.
Inheritance Hierarchy
SystemObject
  Telogis.GeoBase.NavigationNavigator

Namespace:  Telogis.GeoBase.Navigation
Assembly:  geobase.net (in geobase.net.dll) Version: 4.84.0.0
Syntax
public class Navigator : IMapRenderer, IDisposable

The Navigator type exposes the following members.

Constructors
  NameDescription
Public methodNavigator(IGps) Obsolete.
Create a new Navigator with the specified GPS unit. The Navigator will print strings in US English.
Public methodNavigator(IGps, MessagesBundle)
Create a new Navigator with the specified GPS unit, and MessagesBundle for displaying strings.
Public methodNavigator(IGps, String, CultureInfo)
Create a new Navigator with the specified GPS unit that will display strings in the given culture using a MessagesBundle from the given path.
Public methodNavigator(IGps, String, CultureInfo, Boolean)
Create a new Navigator with the specified GPS unit that will display strings in the given culture using a MessagesBundle from the given path, with the option to perform all language-based operations in debug mode.
Top
Properties
  NameDescription
Public propertyAddress
Gets the GeoCodeFull of the navigator's last recorded location.
Public propertyAllowUTurns
When true the routing engine is permitted to instruct u-turns. When false the routing engine will instruct only the minimum number of u-turns possible. False by default.
Public propertyAutoRaiseEvents
Determines whether Events (e.g. RouteChanged) and Notifications triggered by an update to the Navigator's position should be raised automatically.
Public propertyCurrentNavigationEvent
Gets the pending NavigationEvent that the navigator will need to execute.
Public propertyDestination
Gets or sets the navigator's destination, as a RouteStop.
Public propertyDeviationGraceTime
Gets or sets the grace time (as a TimeSpan) for which to allow the navigator to deviate from the planned route.
Public propertyDirections
Gets the Directions for this navigator to the defined Destination.
Public propertyDisplayNameMode
Controls whether NavigationEvents include all the names for a TargetStreet or just the primary name.
Public propertyGps
Gets or sets the IGps interface.
Public propertyHeading
Gets the navigator's last recording heading, in degrees, snapped to the heading of the closest point on the street.
Public propertyIsOffCourse
Will return true if this navigator is off course.
Public propertyLocation
Gets the navigator's last recorded location, as a LatLon, snapped to the closest point on the route.
Public propertyMessagesBundle
The MessagesBundle used by this Navigator to generate strings.
Public propertyNextNavigationEvent
Gets the next NavigationEvent that the navigator will need to execute.
Public propertyPosition
Gets the navigator's last recorded position, as a Position, as it came from the Gps.
Public propertyRequiredRendermodes
Gets the RenderMode required by this Navigator
Public propertyRouteCalculator
Gets or sets the implementation of IRouteCalculator - the method this Navigator uses for calculating the route.
Public propertyRouteProgress
The progress of this Navigator's routing operation (when a routing operation is underway)
Public propertyStrategy
Gets or sets the navigator's routing strategy.
Public propertyTotalTimeRemaining
Gets the calculated total time remaining for the route currently being navigated.
Public propertyUnalignedDeviationGraceTime
Gets or sets the unaligned deviation grace time.
Public propertyVehicleSpec
Gets or sets the vehicle specifications for the navigator.
Top
Methods
  NameDescription
Public methodAddNotification
Add a Notification to the navigator.
Public methodAddPoint
Add the current position (retrieved from the GPS that the Navigator was constructed with) to our route. This method should be called regularly to ensure that the Navigator is aware of its current location.
Public methodClearNotifications
Remove all Notifications from the navigator. These notifications will no longer be triggered during navigation.
Public methodDispose
Disposes of this Navigator.
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetTotalDistanceRemaining
Gets the total remaining distance along the route (from the last recorded position to the destination) in the specified DistanceUnits.
Public methodGetType (Inherited from Object.)
Public methodRaiseEvents
Raises all Events or Notifications that are pending on the Navigator.
Public methodRecalculateRoute
Recalculate the navigator's route using the defined routing strategy.
Public methodRemoveNotification
Remove a Notification from the navigator.
Public methodRender
Render the navigator's directions.
Public methodSetDeviationThreshold
Sets the distance threshold from which the navigator may deviate (for a maximum of DeviationGraceTime or UnalignedDeviationGraceTime) from the route before the navigator is rerouted.
Public methodSetOffRouteSnapDistance Obsolete.
Sets the distance threshold used to snap the navigator onto the nearest road.
Public methodSetRepository
Set the repository that this navigator should use.
Public methodSnapPoint
Snap a given LatLon to the nearest point on the route.
Public methodToString (Inherited from Object.)
Top
Events
  NameDescription
Public eventArrived
Fired when the navigator arrives at the destination.
Public eventGpsQuality
Fired whenever the GPS quality changes.
Public eventMovementListChanged
Fired whenever the movement list changes.
Public eventNewRoute
Fired after a new route has been set and the first direction is ready to be given.
Public eventOffCourse
Fired when the navigator is off-course after being on-course.
Public eventOnCourse
Fired when the navigator is on-course again after being off-course.
Public eventRouteCalculating
Fired when a new route is being calculated.
Public eventRouteChanged
Fired when the route has changed, with or without intervention by the user.
Public eventRouteFailed
Fired when the navigator fails to find a route.
Public eventUpdate
An event handler fired when the position of this Navigator is updated. The object passed to the delegate is of type Telogis.GeoBase.Navigation.Navigator.
Top
Remarks

Generally the Navigator is constructed, any desired notifications added and then a timer (or separate thread) instated to call the AddPoint method at regular intervals. The AddPoint method updates the current location of the Navigator.

Instance members of the Navigator class are not guaranteed to be thread safe.

Related articles: Navigation Tutorial, Using a Navigator, Using an XmlWaveAnnouncer, Using a LabelBox, Using a TurnBox, Implementing an IGps Member, Using Languages and Cultures.

See Also