Skip to main content

Class: TrafficInfoService

Defined in: src/garminsdk/traffic/TrafficInfoService.ts:73

Garmin Traffic Information Service.

Extends

Implements

Constructors

Constructor

new TrafficInfoService(bus, tfcInstrument, supportRadarAltitude, maxIntruderCount?, realTimeUpdateFreq?, simTimeUpdateFreq?): TrafficInfoService

Defined in: src/garminsdk/traffic/TrafficInfoService.ts:116

Creates a new instance of TrafficInfoService.

Parameters

ParameterTypeDescription
busEventBusThe event bus.
tfcInstrumentTrafficInstrumentThe traffic instrument which provides traffic contacts for the TIS.
supportRadarAltitudebooleanWhether the TIS supports radar altitude.
maxIntruderCount?numberThe maximum number of intruders tracked at any one time by the TIS. Defaults to TrafficInfoService.DEFAULT_MAX_INTRUDER_COUNT.
realTimeUpdateFreq?numberThe maximum update frequency (Hz) in real time. Defaults to TrafficInfoService.DEFAULT_REAL_TIME_UPDATE_FREQ.
simTimeUpdateFreq?numberThe maximum update frequency (Hz) in sim time. Defaults to TrafficInfoService.DEFAULT_SIM_TIME_UPDATE_FREQ.

Returns

TrafficInfoService

Overrides

Tcas<GarminTcasIntruder, TisSensitivity>.constructor

Constructor

new TrafficInfoService(bus, tfcInstrument, options?): TrafficInfoService

Defined in: src/garminsdk/traffic/TrafficInfoService.ts:130

Creates a new instance of TrafficInfoService.

Parameters

ParameterTypeDescription
busEventBusThe event bus.
tfcInstrumentTrafficInstrumentThe traffic instrument which provides traffic contacts for the TIS.
options?Readonly<TrafficInfoServiceOptions>Options with which to configure the TIS.

Returns

TrafficInfoService

Overrides

Tcas<GarminTcasIntruder, TisSensitivity>.constructor

Properties

adsb

readonly adsb: null | GarminAdsb

Defined in: src/garminsdk/traffic/TrafficInfoService.ts:93

The ADS-B system used by this traffic system, or null if this system does not support ADS-B.

Implementation of

TrafficSystem.adsb


bus

protected readonly bus: EventBus

Defined in: src/sdk/traffic/Tcas.ts:504

The event bus.

Implementation of

TrafficSystem.bus

Inherited from

Tcas.bus


intrudersFiltered

protected intrudersFiltered: GarminTcasIntruder[] = []

Defined in: src/sdk/traffic/Tcas.ts:463

Implementation of

TrafficSystem.intrudersFiltered

Inherited from

Tcas.intrudersFiltered


intrudersRA

protected readonly intrudersRA: Set<GarminTcasIntruder>

Defined in: src/sdk/traffic/Tcas.ts:465

Implementation of

TrafficSystem.intrudersRA

Inherited from

Tcas.intrudersRA


intrudersSorted

protected readonly intrudersSorted: GarminTcasIntruder[] = []

Defined in: src/sdk/traffic/Tcas.ts:462

Implementation of

TrafficSystem.intrudersSorted

Inherited from

Tcas.intrudersSorted


lastUpdateRealTime

protected lastUpdateRealTime: number = 0

Defined in: src/sdk/traffic/Tcas.ts:487

Implementation of

TrafficSystem.lastUpdateRealTime

Inherited from

Tcas.lastUpdateRealTime


lastUpdateSimTime

protected lastUpdateSimTime: number = 0

Defined in: src/sdk/traffic/Tcas.ts:486

Implementation of

TrafficSystem.lastUpdateSimTime

Inherited from

Tcas.lastUpdateSimTime


maxIntruderCount

protected readonly maxIntruderCount: Subscribable<number>

Defined in: src/sdk/traffic/Tcas.ts:452

Implementation of

TrafficSystem.maxIntruderCount

Inherited from

Tcas.maxIntruderCount


operatingModeSub

protected readonly operatingModeSub: Subject<TcasOperatingMode>

Defined in: src/sdk/traffic/Tcas.ts:456

Implementation of

TrafficSystem.operatingModeSub

Inherited from

Tcas.operatingModeSub


ownAirplane

protected readonly ownAirplane: OwnAirplane

Defined in: src/sdk/traffic/Tcas.ts:460

Implementation of

TrafficSystem.ownAirplane

Inherited from

Tcas.ownAirplane


ownAirplaneSubs

protected readonly ownAirplaneSubs: object

Defined in: src/sdk/traffic/Tcas.ts:474

altitude

altitude: NumberUnitSubject<Distance, SimpleUnit<Distance>>

groundSpeed

groundSpeed: NumberUnitSubject<Speed, CompoundUnit<Speed>>

groundTrack

groundTrack: ConsumerSubject<number>

isOnGround

isOnGround: ConsumerSubject<boolean>

position

position: GeoPointSubject

radarAltitude

radarAltitude: NumberUnitSubject<Distance, SimpleUnit<Distance>>

verticalSpeed

verticalSpeed: NumberUnitSubject<Speed, CompoundUnit<Speed>>

Implementation of

TrafficSystem.ownAirplaneSubs

Inherited from

Tcas.ownAirplaneSubs


paSeparationCache

protected readonly paSeparationCache: object

Defined in: src/sdk/traffic/Tcas.ts:880

horizontal

horizontal: NumberUnit<Distance, SimpleUnit<Distance>>

vertical

vertical: NumberUnit<Distance, SimpleUnit<Distance>>

Implementation of

TrafficSystem.paSeparationCache

Inherited from

Tcas.paSeparationCache


realTimeUpdateFreq

protected readonly realTimeUpdateFreq: Subscribable<number>

Defined in: src/sdk/traffic/Tcas.ts:453

Implementation of

TrafficSystem.realTimeUpdateFreq

Inherited from

Tcas.realTimeUpdateFreq


resolutionAdvisoryHost

protected readonly resolutionAdvisoryHost: TcasResolutionAdvisoryHostClass

Defined in: src/sdk/traffic/Tcas.ts:466

Implementation of

TrafficSystem.resolutionAdvisoryHost

Inherited from

Tcas.resolutionAdvisoryHost


sensitivity

protected readonly sensitivity: TisSensitivity

Defined in: src/sdk/traffic/Tcas.ts:458

Implementation of

TrafficSystem.sensitivity

Inherited from

Tcas.sensitivity


simTime

protected readonly simTime: ConsumerSubject<number>

Defined in: src/sdk/traffic/Tcas.ts:484

Implementation of

TrafficSystem.simTime

Inherited from

Tcas.simTime


simTimeUpdateFreq

protected readonly simTimeUpdateFreq: Subscribable<number>

Defined in: src/sdk/traffic/Tcas.ts:454

Implementation of

TrafficSystem.simTimeUpdateFreq

Inherited from

Tcas.simTimeUpdateFreq


tfcInstrument

protected readonly tfcInstrument: TrafficInstrument

Defined in: src/sdk/traffic/Tcas.ts:505

The traffic instrument which provides traffic contacts for this TCAS.

Implementation of

TrafficSystem.tfcInstrument

Inherited from

Tcas.tfcInstrument


type

readonly type: TrafficSystemType

Defined in: src/garminsdk/traffic/TrafficInfoService.ts:90

The type of this traffic system.

Implementation of

TrafficSystem.type


DEFAULT_ADSB_MAX_INTRUDER_COUNT

readonly static DEFAULT_ADSB_MAX_INTRUDER_COUNT: 30 = 30

Defined in: src/garminsdk/traffic/TrafficInfoService.ts:78


DEFAULT_ADSB_REAL_TIME_UPDATE_FREQ

readonly static DEFAULT_ADSB_REAL_TIME_UPDATE_FREQ: 2 = 2

Defined in: src/garminsdk/traffic/TrafficInfoService.ts:79


DEFAULT_ADSB_SIM_TIME_UPDATE_FREQ

readonly static DEFAULT_ADSB_SIM_TIME_UPDATE_FREQ: 1 = 1

Defined in: src/garminsdk/traffic/TrafficInfoService.ts:80


DEFAULT_MAX_INTRUDER_COUNT

readonly static DEFAULT_MAX_INTRUDER_COUNT: 8 = 8

Defined in: src/garminsdk/traffic/TrafficInfoService.ts:74


DEFAULT_REAL_TIME_UPDATE_FREQ

readonly static DEFAULT_REAL_TIME_UPDATE_FREQ: 2 = 2

Defined in: src/garminsdk/traffic/TrafficInfoService.ts:75


DEFAULT_SIM_TIME_UPDATE_FREQ

readonly static DEFAULT_SIM_TIME_UPDATE_FREQ: 0.2 = 0.2

Defined in: src/garminsdk/traffic/TrafficInfoService.ts:76

Methods

canCancelProximityAdvisory()

protected canCancelProximityAdvisory(simTime, intruder): boolean

Defined in: src/sdk/traffic/Tcas.ts:1017

Checks whether a proximity advisory can be canceled for an intruder.

Parameters

ParameterTypeDescription
simTimenumberThe current sim time, as a UNIX timestamp in milliseconds.
intruderGarminTcasIntruderAn intruder.

Returns

boolean

Whether a proximity advisory can be canceled for the intruder.

Implementation of

TrafficSystem.canCancelProximityAdvisory

Inherited from

Tcas.canCancelProximityAdvisory


canCancelResolutionAdvisory()

protected canCancelResolutionAdvisory(simTime, intruder): boolean

Defined in: src/sdk/traffic/Tcas.ts:972

Checks whether a resolution advisory can be canceled for an intruder.

Parameters

ParameterTypeDescription
simTimenumberThe current sim time, as a UNIX timestamp in milliseconds.
intruderGarminTcasIntruderAn intruder.

Returns

boolean

Whether a resolution advisory can be issued for the intruder.

Implementation of

TrafficSystem.canCancelResolutionAdvisory

Inherited from

Tcas.canCancelResolutionAdvisory


canCancelTrafficAdvisory()

protected canCancelTrafficAdvisory(simTime, intruder): boolean

Defined in: src/garminsdk/traffic/TrafficInfoService.ts:300

Checks whether a traffic advisory can be canceled for an intruder.

Parameters

ParameterTypeDescription
simTimenumberThe current sim time, as a UNIX timestamp in milliseconds.
intruderGarminTcasIntruderAn intruder.

Returns

boolean

Whether a traffic advisory can be canceled for the intruder.

Implementation of

TrafficSystem.canCancelTrafficAdvisory

Overrides

Tcas.canCancelTrafficAdvisory


canIssueProximityAdvisory()

protected canIssueProximityAdvisory(simTime, intruder): boolean

Defined in: src/sdk/traffic/Tcas.ts:1006

Checks whether a proximity advisory can be issued for an intruder.

Parameters

ParameterTypeDescription
simTimenumberThe current sim time, as a UNIX timestamp in milliseconds.
intruderGarminTcasIntruderAn intruder.

Returns

boolean

Whether a proximity advisory can be issued for the intruder.

Implementation of

TrafficSystem.canIssueProximityAdvisory

Inherited from

Tcas.canIssueProximityAdvisory


canIssueResolutionAdvisory()

protected canIssueResolutionAdvisory(simTime, intruder): boolean

Defined in: src/sdk/traffic/Tcas.ts:958

Checks whether a resolution advisory can be issued for an intruder.

Parameters

ParameterTypeDescription
simTimenumberThe current sim time, as a UNIX timestamp in milliseconds.
intruderGarminTcasIntruderAn intruder.

Returns

boolean

Whether a resolution advisory can be issued for the intruder.

Implementation of

TrafficSystem.canIssueResolutionAdvisory

Inherited from

Tcas.canIssueResolutionAdvisory


canIssueTrafficAdvisory()

protected canIssueTrafficAdvisory(simTime, intruder): boolean

Defined in: src/garminsdk/traffic/TrafficInfoService.ts:286

Checks whether a traffic advisory can be issued for an intruder.

Parameters

ParameterTypeDescription
simTimenumberThe current sim time, as a UNIX timestamp in milliseconds.
intruderGarminTcasIntruderAn intruder.

Returns

boolean

Whether a traffic advisory can be issued for the intruder.

Implementation of

TrafficSystem.canIssueTrafficAdvisory

Overrides

Tcas.canIssueTrafficAdvisory


createIntruderEntry()

protected createIntruderEntry(contact): GarminTcasIntruder

Defined in: src/garminsdk/traffic/TrafficInfoService.ts:250

Creates a TCAS intruder entry from a traffic contact.

Parameters

ParameterTypeDescription
contactTrafficContactA traffic contact.

Returns

GarminTcasIntruder

Implementation of

TrafficSystem.createIntruderEntry

Overrides

Tcas.createIntruderEntry


createSensitivity()

protected createSensitivity(): TisSensitivity

Defined in: src/garminsdk/traffic/TrafficInfoService.ts:208

Creates a TCAS sensitivity object.

Returns

TisSensitivity

A TCAS sensitivity object.

Implementation of

TrafficSystem.createSensitivity

Overrides

Tcas.createSensitivity


doUpdate()

protected doUpdate(simTime): void

Defined in: src/sdk/traffic/Tcas.ts:794

Executes an update.

Parameters

ParameterTypeDescription
simTimenumberThe current sim time, as a UNIX timestamp in milliseconds.

Returns

void

Implementation of

TrafficSystem.doUpdate

Inherited from

Tcas.doUpdate


filterIntruder()

protected filterIntruder(intruder): boolean

Defined in: src/garminsdk/traffic/TrafficInfoService.ts:255

Filters an intruder.

Parameters

ParameterTypeDescription
intruderGarminTcasIntruderAn intruder.

Returns

boolean

Whether the intruder should be tracked by this TCAS.

Implementation of

TrafficSystem.filterIntruder

Overrides

Tcas.filterIntruder


getEventSubscriber()

getEventSubscriber(): EventSubscriber<TcasEvents>

Defined in: src/sdk/traffic/Tcas.ts:579

Gets an event bus subscriber for TCAS events.

Returns

EventSubscriber<TcasEvents>

an event bus subscriber for TCAS events..

Implementation of

TrafficSystem.getEventSubscriber

Inherited from

Tcas.getEventSubscriber


getIntruders()

getIntruders(): readonly TcasIntruder[]

Defined in: src/sdk/traffic/Tcas.ts:563

Gets an array of all currently tracked intruders. The intruders are sorted in order of decreasing threat.

Returns

readonly TcasIntruder[]

an array of all currently tracked intruders.

Implementation of

TrafficSystem.getIntruders

Inherited from

Tcas.getIntruders


getOperatingMode()

getOperatingMode(): TcasOperatingMode

Defined in: src/sdk/traffic/Tcas.ts:547

Gets this system's operating mode.

Returns

TcasOperatingMode

This system's operating mode.

Implementation of

TrafficSystem.getOperatingMode

Inherited from

Tcas.getOperatingMode


getResolutionAdvisoryHost()

getResolutionAdvisoryHost(): TcasResolutionAdvisoryHost

Defined in: src/sdk/traffic/Tcas.ts:571

Gets this system's resolution advisory host.

Returns

TcasResolutionAdvisoryHost

This system's resolution advisory host.

Implementation of

TrafficSystem.getResolutionAdvisoryHost

Inherited from

Tcas.getResolutionAdvisoryHost


init()

init(): void

Defined in: src/garminsdk/traffic/TrafficInfoService.ts:213

Initializes this system.

Returns

void

Implementation of

TrafficSystem.init

Overrides

Tcas.init


intruderComparator()

protected intruderComparator(a, b): number

Defined in: src/sdk/traffic/Tcas.ts:661

Sorts two intruders.

Parameters

ParameterTypeDescription
aGarminTcasIntruderThe first intruder.
bGarminTcasIntruderThe second intruder.

Returns

number

A negative number if a is to be sorted before b, a positive number if b is to be sorted before a, and zero if the two are equal.

Implementation of

TrafficSystem.intruderComparator

Inherited from

Tcas.intruderComparator


isPowered()

isPowered(): boolean

Defined in: src/garminsdk/traffic/TrafficInfoService.ts:240

Checks whether this traffic system is powered.

Returns

boolean

Whether this traffic system is powered.

Implementation of

TrafficSystem.isPowered


onOperatingModeChanged()

protected onOperatingModeChanged(mode): void

Defined in: src/sdk/traffic/Tcas.ts:637

Responds to changes in this TCAS's operating mode.

Parameters

ParameterTypeDescription
modeTcasOperatingModeThe current operating mode.

Returns

void

Implementation of

TrafficSystem.onOperatingModeChanged

Inherited from

Tcas.onOperatingModeChanged


setOperatingMode()

setOperatingMode(mode): void

Defined in: src/sdk/traffic/Tcas.ts:555

Sets this system's operating mode.

Parameters

ParameterTypeDescription
modeTcasOperatingModeThe new operating mode.

Returns

void

Implementation of

TrafficSystem.setOperatingMode

Inherited from

Tcas.setOperatingMode


setPowered()

setPowered(isPowered): void

Defined in: src/garminsdk/traffic/TrafficInfoService.ts:245

Sets whether this traffic system is powered.

Parameters

ParameterTypeDescription
isPoweredbooleanWhether the system is powered.

Returns

void

Implementation of

TrafficSystem.setPowered


updateFilteredIntruderAlertLevels()

protected updateFilteredIntruderAlertLevels(simTime): void

Defined in: src/sdk/traffic/Tcas.ts:858

Updates the alert levels for all intruders tracked by this system that have not been filtered out.

Parameters

ParameterTypeDescription
simTimenumberThe current sim time, as a UNIX timestamp in milliseconds.

Returns

void

Implementation of

TrafficSystem.updateFilteredIntruderAlertLevels

Inherited from

Tcas.updateFilteredIntruderAlertLevels


updateIntruderAlertLevel()

protected updateIntruderAlertLevel(simTime, intruder): void

Defined in: src/sdk/traffic/Tcas.ts:890

Updates an intruder's alert level.

Parameters

ParameterTypeDescription
simTimenumberThe current sim time, as a UNIX timestamp in milliseconds.
intruderGarminTcasIntruderAn intruder.

Returns

void

Implementation of

TrafficSystem.updateIntruderAlertLevel

Inherited from

Tcas.updateIntruderAlertLevel


updateIntruderArrays()

protected updateIntruderArrays(): void

Defined in: src/sdk/traffic/Tcas.ts:823

Updates the arrays of intruders tracked by this system.

Returns

void

Implementation of

TrafficSystem.updateIntruderArrays

Inherited from

Tcas.updateIntruderArrays


updateIntruderPredictions()

protected updateIntruderPredictions(simTime): void

Defined in: src/sdk/traffic/Tcas.ts:808

Updates the TCA predictions for all intruders tracked by this system.

Parameters

ParameterTypeDescription
simTimenumberThe current sim time, as a UNIX timestamp in milliseconds.

Returns

void

Implementation of

TrafficSystem.updateIntruderPredictions

Inherited from

Tcas.updateIntruderPredictions


updateResolutionAdvisory()

protected updateResolutionAdvisory(simTime): void

Defined in: src/sdk/traffic/Tcas.ts:1025

Updates this TCAS's resolution advisory.

Parameters

ParameterTypeDescription
simTimenumberThe current sim time, as a UNIX timestamp in milliseconds.

Returns

void

Implementation of

TrafficSystem.updateResolutionAdvisory

Inherited from

Tcas.updateResolutionAdvisory


updateSensitivity()

protected updateSensitivity(): void

Defined in: src/garminsdk/traffic/TrafficInfoService.ts:268

Returns

void

Inherit Doc

Implementation of

TrafficSystem.updateSensitivity

Overrides

Tcas.updateSensitivity