Skip to main content

Class: EngineConfig

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/AvionicsConfig/EngineConfig.ts:30

A configuration object which defines options related to the display of engine information.

Implements

Constructors

Constructor

new EngineConfig(baseInstrument, element): EngineConfig

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/AvionicsConfig/EngineConfig.ts:51

Creates a new EngineConfig from a configuration document element.

Parameters

ParameterTypeDescription
baseInstrumentBaseInstrumentThe BaseInstrument element associated with the configuration.
elementundefined | ElementA configuration document element.

Returns

EngineConfig

Properties

eisSize

readonly eisSize: undefined | EisSizes

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/AvionicsConfig/EngineConfig.ts:41

The size of the EIS, or undefined if the EIS is not included.


includeEis

readonly includeEis: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/AvionicsConfig/EngineConfig.ts:38

Whether to include an EIS.


includeEnginePage

readonly includeEnginePage: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/AvionicsConfig/EngineConfig.ts:44

Whether to include an MFD engine page.

Methods

parseEis()

parseEis(bus): undefined | G3XEisDefinition

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/AvionicsConfig/EngineConfig.ts:99

Parses an EIS definition object from this config.

Parameters

ParameterTypeDescription
busEventBusThe event bus.

Returns

undefined | G3XEisDefinition

The EIS definition object defined by this config, or undefined if the EIS is not to be included.


parseEnginePage()

parseEnginePage(bus): undefined | G3XEnginePageDefinition

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/AvionicsConfig/EngineConfig.ts:125

Parses an engine page definition object from this config.

Parameters

ParameterTypeDescription
busEventBusThe event bus.

Returns

undefined | G3XEnginePageDefinition

The engine page definition object defined by this config, or undefined if the engine page is not to be included.