Class: APTogaPitchDirector
Defined in: src/sdk/autopilot/directors/APTogaPitchDirector.ts:30
An autopilot TOGA Pitch Director to be used for either a vertical TO or GA mode.
Implements
Constructors
Constructor
new APTogaPitchDirector(
apValues
,options?
):APTogaPitchDirector
Defined in: src/sdk/autopilot/directors/APTogaPitchDirector.ts:53
Creates a new instance of APTogaPitchDirector.
Parameters
Parameter | Type | Description |
---|---|---|
apValues | APValues | Autopilot values from this director's parent autopilot. |
options? | Readonly <APTogaPitchDirectorOptions > | Options with which to configure this director. |
Returns
APTogaPitchDirector
Constructor
new APTogaPitchDirector(
targetPitchAngle?
):APTogaPitchDirector
Defined in: src/sdk/autopilot/directors/APTogaPitchDirector.ts:61
Creates a new instance of APTogaPitchDirector.
Parameters
Parameter | Type | Description |
---|---|---|
targetPitchAngle? | number | The target pitch angle set by this director when activated, in degrees. Positive values indicate upward pitch. Defaults to 10 . |
Returns
APTogaPitchDirector
Deprecated
Please use the constructor overload that takes an APValues
object and options object as arguments
instead.
Properties
drivePitch()?
optional
drivePitch: (pitch
,adjustForAoa?
,adjustForVerticalWind?
,rate?
) =>void
Defined in: src/sdk/autopilot/directors/APTogaPitchDirector.ts:39
A function used to drive the autopilot commanded pitch angle toward a desired value while optionally correcting for angle of attack and vertical wind.
Parameters
Parameter | Type |
---|---|
pitch | number |
adjustForAoa? | boolean |
adjustForVerticalWind? | boolean |
rate? | number |
Returns
void
Implementation of
onActivate()?
optional
onActivate: () =>void
Defined in: src/sdk/autopilot/directors/APTogaPitchDirector.ts:35
A callback called when a mode signals it should be activated.
Returns
void
Implementation of
onArm()?
optional
onArm: () =>void
Defined in: src/sdk/autopilot/directors/APTogaPitchDirector.ts:37
A callback called when a mode signals it should be armed.
Returns
void
Implementation of
setPitch()?
optional
setPitch: (pitch
) =>void
Defined in: src/sdk/autopilot/directors/APTogaPitchDirector.ts:41
A callback called to set an exact AP pitch target.
Parameters
Parameter | Type |
---|---|
pitch | number |
Returns
void
Implementation of
state
state:
DirectorState
Defined in: src/sdk/autopilot/directors/APTogaPitchDirector.ts:32
The current director state.
Implementation of
Methods
activate()
activate():
void
Defined in: src/sdk/autopilot/directors/APTogaPitchDirector.ts:113
Activates the guidance mode.
Returns
void
Implementation of
arm()
arm():
void
Defined in: src/sdk/autopilot/directors/APTogaPitchDirector.ts:129
Arms the guidance mode.
Returns
void
Implementation of
deactivate()
deactivate():
void
Defined in: src/sdk/autopilot/directors/APTogaPitchDirector.ts:136
Deactivates the guidance mode.
Returns
void
Implementation of
update()
update():
void
Defined in: src/sdk/autopilot/directors/APTogaPitchDirector.ts:145
Updates the guidance mode control loops.
Returns
void