Class: APTrkHoldDirector
Defined in: src/sdk/autopilot/directors/APTrkHoldDirector.ts:30
An autopilot director that generates flight director bank commands to level the wings upon activation and then hold the resultant magnetic ground track once the wings are level.
The director requires valid bank and magnetic ground track data to arm or activate.
Implements
Constructors
Constructor
new APTrkHoldDirector(
bus,apValues,options?):APTrkHoldDirector
Defined in: src/sdk/autopilot/directors/APTrkHoldDirector.ts:66
Creates an instance of the track hold director.
Parameters
| Parameter | Type | Description |
|---|---|---|
bus | EventBus | The event bus to use with this instance. |
apValues | APValues | Autopilot values from this director's parent autopilot. |
options? | Readonly<APTrkHoldDirectorOptions> | Options to configure the new director. Option values default to the following if not defined: * maxBankAngle: undefined * isToGaMode: false |
Returns
APTrkHoldDirector
Properties
driveBank()?
optionaldriveBank: (bank,rate?) =>void
Defined in: src/sdk/autopilot/directors/APTrkHoldDirector.ts:47
A function used to drive the autopilot commanded bank angle toward a desired value.
Parameters
| Parameter | Type |
|---|---|
bank | number |
rate? | number |
Returns
void
Implementation of
onActivate()?
optionalonActivate: () =>void
Defined in: src/sdk/autopilot/directors/APTrkHoldDirector.ts:38
A callback called when this director is activated.
Returns
void
Implementation of
onArm()?
optionalonArm: () =>void
Defined in: src/sdk/autopilot/directors/APTrkHoldDirector.ts:41
A callback called when this director is armed.
Returns
void
Implementation of
onDeactivate()?
optionalonDeactivate: () =>void
Defined in: src/sdk/autopilot/directors/APTrkHoldDirector.ts:44
A callback that is called when this director is deactivated.
Returns
void
Implementation of
state
state:
DirectorState
Defined in: src/sdk/autopilot/directors/APTrkHoldDirector.ts:35
The current director state.
Implementation of
Methods
activate()
activate():
void
Defined in: src/sdk/autopilot/directors/APTrkHoldDirector.ts:119
Activates this director.
Returns
void
Implementation of
arm()
arm():
void
Defined in: src/sdk/autopilot/directors/APTrkHoldDirector.ts:135
Arms this director.
Returns
void
Implementation of
deactivate()
deactivate():
void
Defined in: src/sdk/autopilot/directors/APTrkHoldDirector.ts:142
Deactivates this director.
Returns
void
Implementation of
update()
update():
void
Defined in: src/sdk/autopilot/directors/APTrkHoldDirector.ts:157
Updates this director.
Returns
void