Class: GarminObsDirector
A director that handles OBS Lateral Navigation.
Deprecated
Implements
ObsDirector
Constructors
constructor
• new GarminObsDirector(bus
, apValues
, options?
): GarminObsDirector
Creates an instance of the GPS OBS Director.
Parameters
Name | Type | Description |
---|---|---|
bus | EventBus | The event bus to use with this instance. |
apValues | APValues | Autopilot values from this director's parent autopilot. |
options? | Readonly <GarminObsDirectorOptions > | Options to configure the new director. |
Returns
Defined in
src/garminsdk/autopilot/directors/GarminObsDirector.ts:127
Properties
driveBank
• Optional
driveBank: (bank
: number
, rate?
: number
) => void
Inherit Doc
Type declaration
▸ (bank
, rate?
): void
Parameters
Name | Type |
---|---|
bank | number |
rate? | number |
Returns
void
Inherit Doc
Implementation of
ObsDirector.driveBank
Defined in
src/garminsdk/autopilot/directors/GarminObsDirector.ts:52
obsActive
• obsActive: boolean
= false
Implementation of
ObsDirector.obsActive
Defined in
src/garminsdk/autopilot/directors/GarminObsDirector.ts:55
onActivate
• Optional
onActivate: () => void
Inherit Doc
Type declaration
▸ (): void
Returns
void
Inherit Doc
Implementation of
ObsDirector.onActivate
Defined in
src/garminsdk/autopilot/directors/GarminObsDirector.ts:46
onArm
• Optional
onArm: () => void
Inherit Doc
Type declaration
▸ (): void
Returns
void
Inherit Doc
Implementation of
ObsDirector.onArm
Defined in
src/garminsdk/autopilot/directors/GarminObsDirector.ts:43
onDeactivate
• Optional
onDeactivate: () => void
Inherit Doc
Type declaration
▸ (): void
Returns
void
Inherit Doc
Implementation of
ObsDirector.onDeactivate
Defined in
src/garminsdk/autopilot/directors/GarminObsDirector.ts:49
state
• state: DirectorState
Implementation of
ObsDirector.state
Defined in
src/garminsdk/autopilot/directors/GarminObsDirector.ts:40
Methods
activate
▸ activate(): void
Returns
void
Inherit Doc
Implementation of
ObsDirector.activate
Defined in
src/garminsdk/autopilot/directors/GarminObsDirector.ts:237
arm
▸ arm(): void
Returns
void
Inherit Doc
Implementation of
ObsDirector.arm
Defined in
src/garminsdk/autopilot/directors/GarminObsDirector.ts:245
canActivate
▸ canActivate(): boolean
Tries to activate when armed.
Returns
boolean
whether OBS can activate
Implementation of
ObsDirector.canActivate
Defined in
src/garminsdk/autopilot/directors/GarminObsDirector.ts:407
deactivate
▸ deactivate(): void
Returns
void
Inherit Doc
Implementation of
ObsDirector.deactivate
Defined in
src/garminsdk/autopilot/directors/GarminObsDirector.ts:253
setLeg
▸ setLeg(index
, leg
): void
Parameters
Name | Type |
---|---|
index | number |
leg | null | LegDefinition |
Returns
void
Inherit Doc
Implementation of
ObsDirector.setLeg
Defined in
src/garminsdk/autopilot/directors/GarminObsDirector.ts:261
startTracking
▸ startTracking(): void
Returns
void
Inherit Doc
Implementation of
ObsDirector.startTracking
Defined in
src/garminsdk/autopilot/directors/GarminObsDirector.ts:267
stopTracking
▸ stopTracking(): void
Returns
void
Inherit Doc
Implementation of
ObsDirector.stopTracking
Defined in
src/garminsdk/autopilot/directors/GarminObsDirector.ts:277
update
▸ update(): void
Updates the lateral director.
Returns
void
Implementation of
ObsDirector.update
Defined in
src/garminsdk/autopilot/directors/GarminObsDirector.ts:307