Class: NavSourceFormatter

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Graphics/Text/NavSourceFormatter.ts:11

Utility class for creating nav source name formatters.

Constructors

Constructor

new NavSourceFormatter(): NavSourceFormatter

Returns

NavSourceFormatter

Methods

create()

static create(gpsName, showGpsIndex, showDmeIndex, showAdfIndex): (sourceName) => string

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Graphics/Text/NavSourceFormatter.ts:20

Creates a function which generates formatted nav source names.

Parameters

Parameter	Type	Description
gpsName	"GPS" | "FMS"	The name to use for GPS-type nav sources.
showGpsIndex	boolean	Whether to show the index for GPS-type nav sources.
showDmeIndex	boolean	Whether to show the index for DME-type nav sources.
showAdfIndex	boolean	Whether to show the index for ADF-type nav sources.

Returns

A function which generates formatted nav source names.

(sourceName): string

Parameters

Parameter	Type
sourceName	G3000NavSourceName

Returns

string

---

createForBearingPointerSetting()

static createForBearingPointerSetting(gpsName, showGpsIndex, showDmeIndex, showAdfIndex): (bearingPointerSource) => string

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Graphics/Text/NavSourceFormatter.ts:117

Creates a function which generates formatted nav source names for nav sources.

Parameters

Parameter	Type	Description
gpsName	"GPS" | "FMS"	The name to use for GPS-type nav sources.
showGpsIndex	boolean	Whether to show the index for GPS-type nav sources.
showDmeIndex	boolean	Whether to show the index for DME-type nav sources.
showAdfIndex	boolean	Whether to show the index for ADF-type nav sources.

Returns

A function which generates formatted nav source names for nav sources.

(bearingPointerSource): string

Parameters

Parameter	Type
bearingPointerSource	PfdBearingPointerSource

Returns

string

---

createForIndicator()

static createForIndicator(gpsName, showGpsIndex, showDmeIndex, showAdfIndex, showNavType): (indicator) => string

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Graphics/Text/NavSourceFormatter.ts:73

Creates a function which generates formatted nav source names for nav indicators.

Parameters

Parameter	Type	Description
gpsName	"GPS" | "FMS"	The name to use for GPS-type nav sources.
showGpsIndex	boolean	Whether to show the index for GPS-type nav sources.
showDmeIndex	boolean	Whether to show the index for DME-type nav sources.
showAdfIndex	boolean	Whether to show the index for ADF-type nav sources.
showNavType	boolean	Whether to show the navaid type (VOR vs LOC) for NAV-type nav sources. If false, 'NAV' will be used as the name for all NAV-type sources.

Returns

A function which generates formatted nav source names for nav indicators.

(indicator): string

Parameters

Parameter	Type
indicator	G3000NavIndicator

Returns

string

---

createForSource()

static createForSource(gpsName, showGpsIndex, showDmeIndex, showAdfIndex): (source) => string

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Graphics/Text/NavSourceFormatter.ts:50

Creates a function which generates formatted nav source names for nav sources.

Parameters

Parameter	Type	Description
gpsName	"GPS" | "FMS"	The name to use for GPS-type nav sources.
showGpsIndex	boolean	Whether to show the index for GPS-type nav sources.
showDmeIndex	boolean	Whether to show the index for DME-type nav sources.
showAdfIndex	boolean	Whether to show the index for ADF-type nav sources.

Returns

A function which generates formatted nav source names for nav sources.

(source): string

Parameters

Parameter	Type
source	NavSource<G3000NavSourceName>

Returns

string