Class: GpsReceiverSelector
Defined in: src/garminsdk/navigation/GpsReceiverSelector.ts:60
Automatically selects the best GPS receiver from a set of candidates based on the current states of all receivers. Receivers that have computed a 3D position solution with differential corrections are favored over those that have computed a 3D solution without corrections, and either of these are favored over those that have not computed any position solution.
Constructors
Constructor
new GpsReceiverSelector(
bus,candidateReceiverIndexes,options?):GpsReceiverSelector
Defined in: src/garminsdk/navigation/GpsReceiverSelector.ts:93
Creates a new instance of GpsReceiverSelector.
Parameters
| Parameter | Type | Description |
|---|---|---|
bus | EventBus | The event bus. |
candidateReceiverIndexes | Iterable<number, any, any> | SubscribableSet<number> | The indexes of the GPS receivers from which to select. |
options? | Readonly<GpsReceiverSelectorOptions> | Options with which to configure the selector. |
Returns
GpsReceiverSelector
Properties
selectedIndex
readonlyselectedIndex:Subscribable<number>
Defined in: src/garminsdk/navigation/GpsReceiverSelector.ts:66
Methods
destroy()
destroy():
void
Defined in: src/garminsdk/navigation/GpsReceiverSelector.ts:223
Destroys this selector.
Returns
void
init()
init():
void
Defined in: src/garminsdk/navigation/GpsReceiverSelector.ts:120
Initializes this selector. Once initialized, this selector will automatically select the best GPS receiver among its candidates.
Returns
void
Throws
Error if this selector has been destroyed.