Navigator Class

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.99.0.0

Syntax

Copy

public class Navigator : IMapRenderer, IDisposable

Public Class Navigator
	Implements IMapRenderer, IDisposable

The Navigator type exposes the following members.

Constructors

	Name	Description
	Navigator(IGps)	Obsolete. Create a new Navigator with the specified GPS unit. The Navigator will print strings in US English.
	Navigator(IGps, MessagesBundle)	Create a new Navigator with the specified GPS unit, and MessagesBundle for displaying strings.
	Navigator(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.
	Navigator(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

	Name	Description
	Address	Gets the GeoCodeFull of the navigator's last recorded location.
	AllowUTurns	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.
	AutoRaiseEvents	Determines whether Events (e.g. RouteChanged) and Notifications triggered by an update to the Navigator's position should be raised automatically.
	CurrentNavigationEvent	Gets the pending NavigationEvent that the navigator will need to execute.
	Destination	Gets or sets the navigator's destination, as a RouteStop.
	DeviationGraceTime	Gets or sets the grace time (as a TimeSpan) for which to allow the navigator to deviate from the planned route.
	Directions	Gets the Directions for this navigator to the defined Destination.
	DisplayNameMode	Controls whether NavigationEvents include all the names for a TargetStreet or just the primary name.
	Gps	Gets or sets the IGps interface.
	Heading	Gets the navigator's last recording heading, in degrees, snapped to the heading of the closest point on the street.
	IsOffCourse	Will return true if this navigator is off course.
	Location	Gets the navigator's last recorded location, as a LatLon, snapped to the closest point on the route.
	MessagesBundle	The MessagesBundle used by this Navigator to generate strings.
	NextNavigationEvent	Gets the next NavigationEvent that the navigator will need to execute.
	Position	Gets the navigator's last recorded position, as a Position, as it came from the Gps.
	RequiredRendermodes	Gets the RenderMode required by this Navigator
	RouteCalculator	Gets or sets the implementation of IRouteCalculator - the method this Navigator uses for calculating the route.
	RouteProgress	The progress of this Navigator's routing operation (when a routing operation is underway)
	Strategy	Gets or sets the navigator's routing strategy.
	TotalTimeRemaining	Gets the calculated total time remaining for the route currently being navigated.
	UnalignedDeviationGraceTime	Gets or sets the unaligned deviation grace time.
	VehicleSpec	Gets or sets the vehicle specifications for the navigator.

Top

Methods

	Name	Description
	AddNotification	Add a Notification to the navigator.
	AddPoint	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.
	ClearNotifications	Remove all Notifications from the navigator. These notifications will no longer be triggered during navigation.
	Dispose	Disposes of this Navigator.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetTotalDistanceRemaining	Gets the total remaining distance along the route (from the last recorded position to the destination) in the specified DistanceUnits.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	RaiseEvents	Raises all Events or Notifications that are pending on the Navigator.
	RecalculateRoute	Recalculate the navigator's route using the defined routing strategy.
	RemoveNotification	Remove a Notification from the navigator.
	Render	Render the navigator's directions.
	SetDeviationThreshold	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.
	SetOffRouteSnapDistance	Obsolete. Sets the distance threshold used to snap the navigator onto the nearest road.
	SetRepository	Set the repository that this navigator should use.
	SnapPoint	Snap a given LatLon to the nearest point on the route.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	Arrived	Fired when the navigator arrives at the destination.
	GpsQuality	Fired whenever the GPS quality changes.
	MovementListChanged	Fired whenever the movement list changes.
	NewRoute	Fired after a new route has been set and the first direction is ready to be given.
	OffCourse	Fired when the navigator is off-course after being on-course.
	OnCourse	Fired when the navigator is on-course again after being off-course.
	RouteCalculating	Fired when a new route is being calculated.
	RouteChanged	Fired when the route has changed, with or without intervention by the user.
	RouteFailed	Fired when the navigator fails to find a route.
	Update	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.

Reference

Telogis.GeoBase.Navigation Namespace