Class: FmsPositionSystemSelector
Defined in: src/garminsdk/navigation/FmsPositionSystemSelector.ts:9
Automatically selects the best FMS geo-positioning system from a set of candidates based on the accuracy of their provided positioning data.
Constructors
Constructor
new FmsPositionSystemSelector(
bus
,enabledSystemIndexes
,preferredSystemIndex?
):FmsPositionSystemSelector
Defined in: src/garminsdk/navigation/FmsPositionSystemSelector.ts:47
Constructor.
Parameters
Parameter | Type | Description |
---|---|---|
bus | EventBus | The event bus. |
enabledSystemIndexes | Iterable <number > | SubscribableSet <number > | The indexes of the FMS geo-positioning systems from which to select. |
preferredSystemIndex? | number | Subscribable <number > | The index of this selector's preferred system, or -1 if there is no such system This selector is guaranteed to select the preferred system if its state is at least as desirable as the state of all other systems from which to select. |
Returns
FmsPositionSystemSelector
Properties
selectedFmsPosMode
readonly
selectedFmsPosMode:Subscribable
<FmsPositionMode
>
Defined in: src/garminsdk/navigation/FmsPositionSystemSelector.ts:28
The positioning mode of the selected FMS geo-positioning system.
selectedIndex
readonly
selectedIndex:Subscribable
<number
>
Defined in: src/garminsdk/navigation/FmsPositionSystemSelector.ts:24
The index of the selected FMS geo-positioning system, or -1
if no system could be selected.
Methods
destroy()
destroy():
void
Defined in: src/garminsdk/navigation/FmsPositionSystemSelector.ts:144
Destroys this manager.
Returns
void
init()
init():
void
Defined in: src/garminsdk/navigation/FmsPositionSystemSelector.ts:71
Initializes this selector. Once initialized, this selector will automatically select the FMS geo-positioning system that currently provides the most accurate position data.
Returns
void
Throws
Error if this selector has been destroyed.