Class: BaroTransitionAlertManager
Defined in: src/garminsdk/alerts/barotransition/BaroTransitionAlertManager.ts:44
A manager that controls the state of a set of barometric transition alerts. Each manager controls a transition altitude alert, which is triggered when climbing through a transition altitude without changing an altimeter's barometric setting to standard, and a transition level alert, which is triggered when descending through a transition level without changing an altimeter's barometric setting out of standard. The states of the alerts are published to the topics defined in BaroTransitionAlertEvents.
The manager requires that the topics defined in AdcSystemEvents are published to the event bus.
Constructors
Constructor
new BaroTransitionAlertManager(
bus,settingManager,options):BaroTransitionAlertManager
Defined in: src/garminsdk/alerts/barotransition/BaroTransitionAlertManager.ts:109
Creates a new instance of BaroTransitionAlertManager. The manager is created in an uninitialized and paused state.
Parameters
| Parameter | Type | Description |
|---|---|---|
bus | EventBus | The event bus. |
settingManager | UserSettingManager<BaroTransitionAlertUserSettingTypes> | A manager for barometric transition alert user settings. |
options | Readonly<BaroTransitionAlertManagerOptions> | Options with which to configure the manager. |
Returns
BaroTransitionAlertManager
Throws
Error if options.id is the empty string.
Methods
destroy()
destroy():
void
Defined in: src/garminsdk/alerts/barotransition/BaroTransitionAlertManager.ts:331
Destroys this manager. Destroying the manager stops it from automatically controlling the states of its barometric transition alerts and allows resources used by the manager to be freed.
Returns
void
init()
init():
void
Defined in: src/garminsdk/alerts/barotransition/BaroTransitionAlertManager.ts:128
Initializes this manager. Once initialized, the manager will be ready to automatically control the states of its barometric transition alerts.
Returns
void
Throws
Error if this manager has been destroyed.
pause()
pause():
void
Defined in: src/garminsdk/alerts/barotransition/BaroTransitionAlertManager.ts:209
Pauses this manager. When the manager is paused, it will not change the states of its barometric transition alerts, and the alerts will remain in the state they were in when the manager was paused. This method has no effect if the manager is not initialized.
Returns
void
Throws
Error if this manager has been destroyed.
reset()
reset():
void
Defined in: src/garminsdk/alerts/barotransition/BaroTransitionAlertManager.ts:157
Resets this manager such that its managed alerts are deactivated. This method has no effect if the manager is not initialized.
Returns
void
Throws
Error if this manager has been destroyed.
resume()
resume():
void
Defined in: src/garminsdk/alerts/barotransition/BaroTransitionAlertManager.ts:180
Resumes this manager. When the manager is resumed, it will automatically control the states of its barometric transition alerts. This method has no effect if the manager is not initialized.
Returns
void
Throws
Error if this manager has been destroyed.