Class: GtcUserWaypointEditController
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Navigation/GtcUserWaypointEditController.ts:21
A controller for editing user waypoints.
Constructors
Constructor
new GtcUserWaypointEditController(
facRepo
,fms
):GtcUserWaypointEditController
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Navigation/GtcUserWaypointEditController.ts:32
Constructor.
Parameters
Parameter | Type | Description |
---|---|---|
facRepo | FacilityRepository | The facility repository. |
fms | Fms | The FMS. |
Returns
GtcUserWaypointEditController
Properties
MAX_WAYPOINT_COUNT
readonly
static
MAX_WAYPOINT_COUNT:1000
=1000
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Navigation/GtcUserWaypointEditController.ts:25
The maximum number of user waypoints allowed to exist at once.
Methods
addUserFacility()
addUserFacility(
facility
):void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Navigation/GtcUserWaypointEditController.ts:112
Adds a new user waypoint facility. If a facility with the same ICAO as the new one already exists, it will be replaced by the new facility.
Parameters
Parameter | Type | Description |
---|---|---|
facility | UserFacility | The facility to add. |
Returns
void
doesUserWaypointExist()
doesUserWaypointExist(
icao
):boolean
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Navigation/GtcUserWaypointEditController.ts:56
Checks whether a user waypoint with a given ICAO exists.
Parameters
Parameter | Type | Description |
---|---|---|
icao | string | The ICAO to check. |
Returns
boolean
Whether a user waypoint with the specified ICAO exists.
editUserFacility()
editUserFacility(
icao
,facility
):boolean
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Navigation/GtcUserWaypointEditController.ts:124
Edits an existing user waypoint facility. If facility to edit does not exist, then this method does nothing. If the edit involves changing the ICAO of the facility, the old facility will be removed and a new facility will be added with the new ICAO. Otherwise, the new facility will replace the old facility.
Parameters
Parameter | Type | Description |
---|---|---|
icao | string | The ICAO of the existing facility to edit. |
facility | UserFacility | A facility to edit the existing one to. |
Returns
boolean
Whether the existing facility was successfully edited.
getUserWaypointCount()
getUserWaypointCount():
number
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Navigation/GtcUserWaypointEditController.ts:39
Gets the number of existing user waypoints.
Returns
number
The number of existing user waypoints.
getWaypointFlightPlanStatus()
getWaypointFlightPlanStatus(
icao
):UserWaypointFlightPlanStatus
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Navigation/GtcUserWaypointEditController.ts:70
Gets the flight plan inclusion status of a waypoint: whether it is not in any flight plan, in at least one flight plan, or is part of the active leg.
Parameters
Parameter | Type | Description |
---|---|---|
icao | string | The ICAO to check. |
Returns
The flight plan inclusion status of the waypoint with the specified ICAO.
isUserWaypointCountAtLimit()
isUserWaypointCountAtLimit():
boolean
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Navigation/GtcUserWaypointEditController.ts:47
Checks whether the number of existing user waypoints is at or above the allowed limit.
Returns
boolean
Whether the number of existing user waypoints is at or above the allowed limit.
removeAllUserFacilities()
removeAllUserFacilities(
includeInFlightPlan
):boolean
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Navigation/GtcUserWaypointEditController.ts:154
Removes all existing user waypoint facilities.
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
includeInFlightPlan | boolean | false | Whether to remove user waypoint facilities that are in flight plans. Defaults to false . |
Returns
boolean
Whether at least one user waypoint facility was not removed because it was in a flight plan.
removeUserFacility()
removeUserFacility(
icao
):void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Navigation/GtcUserWaypointEditController.ts:144
Removes an existing user waypoint facility.
Parameters
Parameter | Type | Description |
---|---|---|
icao | string | The ICAO of the facility to remove. |
Returns
void