Class: ActiveFlightPlanStore
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/FlightPlan/ActiveFlightPlanStore.ts:17
A flight plan store containing information about the G3X's active primary flight plan. The active primary flight plan is the primary flight plan of the selected flight plan source (either internal or external).
Implements
Constructors
Constructor
new ActiveFlightPlanStore(
fms,fplSource):ActiveFlightPlanStore
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/FlightPlan/ActiveFlightPlanStore.ts:54
Creates a new instance of ActiveFlightPlanStore.
Parameters
| Parameter | Type | Description |
|---|---|---|
fms | G3XFms | The FMS. |
fplSource | Subscribable<G3XFplSource> | The selected flight plan source. |
Returns
ActiveFlightPlanStore
Properties
destinationAirport
readonlydestinationAirport:Subscribable<null|AirportFacility>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/FlightPlan/ActiveFlightPlanStore.ts:31
The flight plan's destination airport, or null if the flight plan does not have a destination.
Implementation of
FlightPlanStore.destinationAirport
loadedVfrApproachData
readonlyloadedVfrApproachData:Subscribable<null|Readonly<G3XFmsFplLoadedApproachData>>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/FlightPlan/ActiveFlightPlanStore.ts:35
Data describing the flight plan's loaded VFR approach, or null if the flight plan does not have a loaded VFR
approach or does not support VFR approaches.
Implementation of
FlightPlanStore.loadedVfrApproachData
name
readonlyname:Subscribable<null|string>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/FlightPlan/ActiveFlightPlanStore.ts:23
The name of the flight plan, or null if the plan does not have a name.
Implementation of
originAirport
readonlyoriginAirport:Subscribable<null|AirportFacility>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/FlightPlan/ActiveFlightPlanStore.ts:27
The flight plan's origin airport, or null if the flight plan does not have an origin.
Implementation of
vfrApproachActiveStatus
readonlyvfrApproachActiveStatus:Subscribable<"none"|"active"|"vtf">
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/FlightPlan/ActiveFlightPlanStore.ts:39
The activation status of the flight plan's loaded VFR approach.
none: the approach is not active.active: the approach is active.vtf: the approach is active in vectors-to-final (VTF) form.
If the flight plan has no loaded VFR approach, then the status will be none.
Implementation of
FlightPlanStore.vfrApproachActiveStatus
Methods
destroy()
destroy():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/FlightPlan/ActiveFlightPlanStore.ts:318
Destroys this store. Once destroyed, this store will no longer update its provided data, and can no longer be paused or resumed.
Returns
void
init()
init(
paused):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/FlightPlan/ActiveFlightPlanStore.ts:66
Initializes this store. Once initialized, this store will continuously update its data until paused or destroyed.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
paused | boolean | false | Whether to initialize this store as paused. If true, then this store's data will not be initialized until the first time it is resumed. Defaults to false. |
Returns
void
Throws
Error if this store has been destroyed.
pause()
pause():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/FlightPlan/ActiveFlightPlanStore.ts:112
Pauses this store. Once paused, this store will not update its data until it is resumed.
Returns
void
Throws
Error if this store has been destroyed.
resume()
resume():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/FlightPlan/ActiveFlightPlanStore.ts:90
Resumes this store. Once resumed, this store will continuously update its data until paused or destroyed.
Returns
void
Throws
Error if this store has been destroyed.