Skip to main content

Class: TrafficInfoService

Garmin Traffic Information Service.

Hierarchy

Implements

Constructors

constructor

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

Creates a new instance of TrafficInfoService.

Parameters

NameTypeDescription
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

Defined in

src/garminsdk/traffic/TrafficInfoService.ts:116

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

Creates a new instance of TrafficInfoService.

Parameters

NameTypeDescription
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

Defined in

src/garminsdk/traffic/TrafficInfoService.ts:130

Properties

adsb

Readonly adsb: null | GarminAdsb

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

Implementation of

TrafficSystem.adsb

Defined in

src/garminsdk/traffic/TrafficInfoService.ts:93


bus

Protected Readonly bus: EventBus

The event bus.

Implementation of

TrafficSystem.bus

Inherited from

Tcas.bus

Defined in

src/sdk/traffic/Tcas.ts:504


intrudersFiltered

Protected intrudersFiltered: GarminTcasIntruder[] = []

Implementation of

TrafficSystem.intrudersFiltered

Inherited from

Tcas.intrudersFiltered

Defined in

src/sdk/traffic/Tcas.ts:463


intrudersRA

Protected Readonly intrudersRA: Set<GarminTcasIntruder>

Implementation of

TrafficSystem.intrudersRA

Inherited from

Tcas.intrudersRA

Defined in

src/sdk/traffic/Tcas.ts:465


intrudersSorted

Protected Readonly intrudersSorted: GarminTcasIntruder[] = []

Implementation of

TrafficSystem.intrudersSorted

Inherited from

Tcas.intrudersSorted

Defined in

src/sdk/traffic/Tcas.ts:462


lastUpdateRealTime

Protected lastUpdateRealTime: number = 0

Implementation of

TrafficSystem.lastUpdateRealTime

Inherited from

Tcas.lastUpdateRealTime

Defined in

src/sdk/traffic/Tcas.ts:487


lastUpdateSimTime

Protected lastUpdateSimTime: number = 0

Implementation of

TrafficSystem.lastUpdateSimTime

Inherited from

Tcas.lastUpdateSimTime

Defined in

src/sdk/traffic/Tcas.ts:486


maxIntruderCount

Protected Readonly maxIntruderCount: Subscribable<number>

Implementation of

TrafficSystem.maxIntruderCount

Inherited from

Tcas.maxIntruderCount

Defined in

src/sdk/traffic/Tcas.ts:452


operatingModeSub

Protected Readonly operatingModeSub: Subject<TcasOperatingMode>

Implementation of

TrafficSystem.operatingModeSub

Inherited from

Tcas.operatingModeSub

Defined in

src/sdk/traffic/Tcas.ts:456


ownAirplane

Protected Readonly ownAirplane: OwnAirplane

Implementation of

TrafficSystem.ownAirplane

Inherited from

Tcas.ownAirplane

Defined in

src/sdk/traffic/Tcas.ts:460


ownAirplaneSubs

Protected Readonly ownAirplaneSubs: Object

Type declaration

NameType
altitudeNumberUnitSubject<Distance, SimpleUnit<Distance>>
groundSpeedNumberUnitSubject<Speed, CompoundUnit<Speed>>
groundTrackConsumerSubject<number>
isOnGroundConsumerSubject<boolean>
positionGeoPointSubject
radarAltitudeNumberUnitSubject<Distance, SimpleUnit<Distance>>
verticalSpeedNumberUnitSubject<Speed, CompoundUnit<Speed>>

Implementation of

TrafficSystem.ownAirplaneSubs

Inherited from

Tcas.ownAirplaneSubs

Defined in

src/sdk/traffic/Tcas.ts:474


paSeparationCache

Protected Readonly paSeparationCache: Object

Type declaration

NameType
horizontalNumberUnit<Distance, SimpleUnit<Distance>>
verticalNumberUnit<Distance, SimpleUnit<Distance>>

Implementation of

TrafficSystem.paSeparationCache

Inherited from

Tcas.paSeparationCache

Defined in

src/sdk/traffic/Tcas.ts:880


realTimeUpdateFreq

Protected Readonly realTimeUpdateFreq: Subscribable<number>

Implementation of

TrafficSystem.realTimeUpdateFreq

Inherited from

Tcas.realTimeUpdateFreq

Defined in

src/sdk/traffic/Tcas.ts:453


resolutionAdvisoryHost

Protected Readonly resolutionAdvisoryHost: TcasResolutionAdvisoryHostClass

Implementation of

TrafficSystem.resolutionAdvisoryHost

Inherited from

Tcas.resolutionAdvisoryHost

Defined in

src/sdk/traffic/Tcas.ts:466


sensitivity

Protected Readonly sensitivity: TisSensitivity

Implementation of

TrafficSystem.sensitivity

Inherited from

Tcas.sensitivity

Defined in

src/sdk/traffic/Tcas.ts:458


simTime

Protected Readonly simTime: ConsumerSubject<number>

Implementation of

TrafficSystem.simTime

Inherited from

Tcas.simTime

Defined in

src/sdk/traffic/Tcas.ts:484


simTimeUpdateFreq

Protected Readonly simTimeUpdateFreq: Subscribable<number>

Implementation of

TrafficSystem.simTimeUpdateFreq

Inherited from

Tcas.simTimeUpdateFreq

Defined in

src/sdk/traffic/Tcas.ts:454


tfcInstrument

Protected Readonly tfcInstrument: TrafficInstrument

The traffic instrument which provides traffic contacts for this TCAS.

Implementation of

TrafficSystem.tfcInstrument

Inherited from

Tcas.tfcInstrument

Defined in

src/sdk/traffic/Tcas.ts:505


type

Readonly type: TrafficSystemType

The type of this traffic system.

Implementation of

TrafficSystem.type

Defined in

src/garminsdk/traffic/TrafficInfoService.ts:90


DEFAULT_ADSB_MAX_INTRUDER_COUNT

Static Readonly DEFAULT_ADSB_MAX_INTRUDER_COUNT: 30

Defined in

src/garminsdk/traffic/TrafficInfoService.ts:78


DEFAULT_ADSB_REAL_TIME_UPDATE_FREQ

Static Readonly DEFAULT_ADSB_REAL_TIME_UPDATE_FREQ: 2

Defined in

src/garminsdk/traffic/TrafficInfoService.ts:79


DEFAULT_ADSB_SIM_TIME_UPDATE_FREQ

Static Readonly DEFAULT_ADSB_SIM_TIME_UPDATE_FREQ: 1

Defined in

src/garminsdk/traffic/TrafficInfoService.ts:80


DEFAULT_MAX_INTRUDER_COUNT

Static Readonly DEFAULT_MAX_INTRUDER_COUNT: 8

Defined in

src/garminsdk/traffic/TrafficInfoService.ts:74


DEFAULT_REAL_TIME_UPDATE_FREQ

Static Readonly DEFAULT_REAL_TIME_UPDATE_FREQ: 2

Defined in

src/garminsdk/traffic/TrafficInfoService.ts:75


DEFAULT_SIM_TIME_UPDATE_FREQ

Static Readonly DEFAULT_SIM_TIME_UPDATE_FREQ: 0.2

Defined in

src/garminsdk/traffic/TrafficInfoService.ts:76

Methods

canCancelProximityAdvisory

canCancelProximityAdvisory(simTime, intruder): boolean

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

Parameters

NameTypeDescription
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

Defined in

src/sdk/traffic/Tcas.ts:1017


canCancelResolutionAdvisory

canCancelResolutionAdvisory(simTime, intruder): boolean

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

Parameters

NameTypeDescription
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

Defined in

src/sdk/traffic/Tcas.ts:972


canCancelTrafficAdvisory

canCancelTrafficAdvisory(simTime, intruder): boolean

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

Parameters

NameTypeDescription
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

Defined in

src/garminsdk/traffic/TrafficInfoService.ts:300


canIssueProximityAdvisory

canIssueProximityAdvisory(simTime, intruder): boolean

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

Parameters

NameTypeDescription
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

Defined in

src/sdk/traffic/Tcas.ts:1006


canIssueResolutionAdvisory

canIssueResolutionAdvisory(simTime, intruder): boolean

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

Parameters

NameTypeDescription
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

Defined in

src/sdk/traffic/Tcas.ts:958


canIssueTrafficAdvisory

canIssueTrafficAdvisory(simTime, intruder): boolean

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

Parameters

NameTypeDescription
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

Defined in

src/garminsdk/traffic/TrafficInfoService.ts:286


createIntruderEntry

createIntruderEntry(contact): GarminTcasIntruder

Creates a TCAS intruder entry from a traffic contact.

Parameters

NameTypeDescription
contactTrafficContactA traffic contact.

Returns

GarminTcasIntruder

Implementation of

TrafficSystem.createIntruderEntry

Overrides

Tcas.createIntruderEntry

Defined in

src/garminsdk/traffic/TrafficInfoService.ts:250


createSensitivity

createSensitivity(): TisSensitivity

Creates a TCAS sensitivity object.

Returns

TisSensitivity

A TCAS sensitivity object.

Implementation of

TrafficSystem.createSensitivity

Overrides

Tcas.createSensitivity

Defined in

src/garminsdk/traffic/TrafficInfoService.ts:208


doUpdate

doUpdate(simTime): void

Executes an update.

Parameters

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

Returns

void

Implementation of

TrafficSystem.doUpdate

Inherited from

Tcas.doUpdate

Defined in

src/sdk/traffic/Tcas.ts:794


filterIntruder

filterIntruder(intruder): boolean

Filters an intruder.

Parameters

NameTypeDescription
intruderGarminTcasIntruderAn intruder.

Returns

boolean

Whether the intruder should be tracked by this TCAS.

Implementation of

TrafficSystem.filterIntruder

Overrides

Tcas.filterIntruder

Defined in

src/garminsdk/traffic/TrafficInfoService.ts:255


getEventSubscriber

getEventSubscriber(): EventSubscriber<TcasEvents>

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

Defined in

src/sdk/traffic/Tcas.ts:579


getIntruders

getIntruders(): readonly TcasIntruder[]

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

Defined in

src/sdk/traffic/Tcas.ts:563


getOperatingMode

getOperatingMode(): TcasOperatingMode

Gets this system's operating mode.

Returns

TcasOperatingMode

This system's operating mode.

Implementation of

TrafficSystem.getOperatingMode

Inherited from

Tcas.getOperatingMode

Defined in

src/sdk/traffic/Tcas.ts:547


getResolutionAdvisoryHost

getResolutionAdvisoryHost(): TcasResolutionAdvisoryHost

Gets this system's resolution advisory host.

Returns

TcasResolutionAdvisoryHost

This system's resolution advisory host.

Implementation of

TrafficSystem.getResolutionAdvisoryHost

Inherited from

Tcas.getResolutionAdvisoryHost

Defined in

src/sdk/traffic/Tcas.ts:571


init

init(): void

Initializes this system.

Returns

void

Implementation of

TrafficSystem.init

Overrides

Tcas.init

Defined in

src/garminsdk/traffic/TrafficInfoService.ts:213


intruderComparator

intruderComparator(a, b): number

Sorts two intruders.

Parameters

NameTypeDescription
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

Defined in

src/sdk/traffic/Tcas.ts:661


isPowered

isPowered(): boolean

Checks whether this traffic system is powered.

Returns

boolean

Whether this traffic system is powered.

Implementation of

TrafficSystem.isPowered

Defined in

src/garminsdk/traffic/TrafficInfoService.ts:240


onOperatingModeChanged

onOperatingModeChanged(mode): void

Responds to changes in this TCAS's operating mode.

Parameters

NameTypeDescription
modeTcasOperatingModeThe current operating mode.

Returns

void

Implementation of

TrafficSystem.onOperatingModeChanged

Inherited from

Tcas.onOperatingModeChanged

Defined in

src/sdk/traffic/Tcas.ts:637


setOperatingMode

setOperatingMode(mode): void

Sets this system's operating mode.

Parameters

NameTypeDescription
modeTcasOperatingModeThe new operating mode.

Returns

void

Implementation of

TrafficSystem.setOperatingMode

Inherited from

Tcas.setOperatingMode

Defined in

src/sdk/traffic/Tcas.ts:555


setPowered

setPowered(isPowered): void

Sets whether this traffic system is powered.

Parameters

NameTypeDescription
isPoweredbooleanWhether the system is powered.

Returns

void

Implementation of

TrafficSystem.setPowered

Defined in

src/garminsdk/traffic/TrafficInfoService.ts:245


updateFilteredIntruderAlertLevels

updateFilteredIntruderAlertLevels(simTime): void

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

Parameters

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

Returns

void

Implementation of

TrafficSystem.updateFilteredIntruderAlertLevels

Inherited from

Tcas.updateFilteredIntruderAlertLevels

Defined in

src/sdk/traffic/Tcas.ts:858


updateIntruderAlertLevel

updateIntruderAlertLevel(simTime, intruder): void

Updates an intruder's alert level.

Parameters

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

Returns

void

Implementation of

TrafficSystem.updateIntruderAlertLevel

Inherited from

Tcas.updateIntruderAlertLevel

Defined in

src/sdk/traffic/Tcas.ts:890


updateIntruderArrays

updateIntruderArrays(): void

Updates the arrays of intruders tracked by this system.

Returns

void

Implementation of

TrafficSystem.updateIntruderArrays

Inherited from

Tcas.updateIntruderArrays

Defined in

src/sdk/traffic/Tcas.ts:823


updateIntruderPredictions

updateIntruderPredictions(simTime): void

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

Parameters

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

Returns

void

Implementation of

TrafficSystem.updateIntruderPredictions

Inherited from

Tcas.updateIntruderPredictions

Defined in

src/sdk/traffic/Tcas.ts:808


updateResolutionAdvisory

updateResolutionAdvisory(simTime): void

Updates this TCAS's resolution advisory.

Parameters

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

Returns

void

Implementation of

TrafficSystem.updateResolutionAdvisory

Inherited from

Tcas.updateResolutionAdvisory

Defined in

src/sdk/traffic/Tcas.ts:1025


updateSensitivity

updateSensitivity(): void

Returns

void

Inherit Doc

Implementation of

TrafficSystem.updateSensitivity

Overrides

Tcas.updateSensitivity

Defined in

src/garminsdk/traffic/TrafficInfoService.ts:268