Abstract Class: Tcas<I, S>
Defined in: src/sdk/traffic/Tcas.ts:507
A TCAS-II-like system.
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
I extends AbstractTcasIntruder | AbstractTcasIntruder |
S extends TcasSensitivity | TcasSensitivity |
Constructors
Constructor
new Tcas<
I,S>(bus,tfcInstrument,options):Tcas<I,S>
Defined in: src/sdk/traffic/Tcas.ts:573
Creates a new instance of Tcas.
Parameters
| Parameter | Type | Description |
|---|---|---|
bus | EventBus | The event bus. |
tfcInstrument | TrafficInstrument | The traffic instrument which provides traffic contacts for the TCAS. |
options | Readonly<TcasOptions> | Options with which to configure the TCAS. |
Returns
Tcas<I, S>
Constructor
new Tcas<
I,S>(bus,tfcInstrument,maxIntruderCount,realTimeUpdateFreq,simTimeUpdateFreq,raOptions?):Tcas<I,S>
Defined in: src/sdk/traffic/Tcas.ts:588
Creates a new instance of Tcas.
Parameters
| Parameter | Type | Description |
|---|---|---|
bus | EventBus | The event bus. |
tfcInstrument | TrafficInstrument | The traffic instrument which provides traffic contacts for the TCAS. |
maxIntruderCount | number | Subscribable<number> | The maximum number of intruders tracked at any one time by the TCAS. |
realTimeUpdateFreq | number | Subscribable<number> | The maximum update frequency (Hz) in real time. |
simTimeUpdateFreq | number | Subscribable<number> | The maximum update frequency (Hz) in sim time. |
raOptions? | Partial<TcasResolutionAdvisoryOptions> | Options to adjust how resolution advisories are calculated. |
Returns
Tcas<I, S>
Deprecated
Please use the overload that takes a TcasOptions object instead.
Properties
bus
protectedreadonlybus:EventBus
Defined in: src/sdk/traffic/Tcas.ts:598
hasActiveSurveillance
protectedreadonlyhasActiveSurveillance:Subscribable<boolean>
Defined in: src/sdk/traffic/Tcas.ts:520
Whether active surveillance is available for this TCAS.
intrudersFiltered
protectedintrudersFiltered:I[] =[]
Defined in: src/sdk/traffic/Tcas.ts:532
intrudersRA
protectedreadonlyintrudersRA:Set<I>
Defined in: src/sdk/traffic/Tcas.ts:534
intrudersSorted
protectedreadonlyintrudersSorted:I[] =[]
Defined in: src/sdk/traffic/Tcas.ts:531
lastUpdateRealTime
protectedlastUpdateRealTime:number=0
Defined in: src/sdk/traffic/Tcas.ts:560
lastUpdateSimTime
protectedlastUpdateSimTime:number=0
Defined in: src/sdk/traffic/Tcas.ts:559
maxIntruderCount
protectedreadonlymaxIntruderCount:Subscribable<number>
Defined in: src/sdk/traffic/Tcas.ts:515
operatingModeSub
protectedreadonlyoperatingModeSub:Subject<TcasOperatingMode>
Defined in: src/sdk/traffic/Tcas.ts:525
ownAirplane
protectedreadonlyownAirplane:TcasOwnAirplane
Defined in: src/sdk/traffic/Tcas.ts:529
ownAirplaneDataProvider
protectedreadonlyownAirplaneDataProvider:TcasOwnAirplaneDataProvider
Defined in: src/sdk/traffic/Tcas.ts:523
A provider of data for this TCAS's own airplane.
ownAirplaneSubs
protectedreadonlyownAirplaneSubs:object
Defined in: src/sdk/traffic/Tcas.ts:546
altitude
altitude:
NumberUnitSubject<Distance,SimpleUnit<Distance>>
groundSpeed
groundSpeed:
NumberUnitSubject<Speed,CompoundUnit<Speed>>
groundTrack
groundTrack:
ConsumerSubject<number>
isOnGround
isOnGround:
ConsumerSubject<boolean>
position
position:
GeoPointSubject
pressureAltitude
pressureAltitude:
NumberUnitSubject<Distance,SimpleUnit<Distance>>
radarAltitude
radarAltitude:
NumberUnitSubject<Distance,SimpleUnit<Distance>>
verticalSpeed
verticalSpeed:
NumberUnitSubject<Speed,CompoundUnit<Speed>>
Deprecated
Please use ownAirplaneDataProvider instead.
paSeparationCache
protectedreadonlypaSeparationCache:object
Defined in: src/sdk/traffic/Tcas.ts:996
horizontal
horizontal:
NumberUnit<Distance,SimpleUnit<Distance>>
vertical
vertical:
NumberUnit<Distance,SimpleUnit<Distance>>
realTimeUpdateFreq
protectedreadonlyrealTimeUpdateFreq:Subscribable<number>
Defined in: src/sdk/traffic/Tcas.ts:516
resolutionAdvisoryHost
protectedreadonlyresolutionAdvisoryHost:TcasResolutionAdvisoryHostClass
Defined in: src/sdk/traffic/Tcas.ts:535
sensitivity
protectedreadonlysensitivity:S
Defined in: src/sdk/traffic/Tcas.ts:527
simTime
protectedreadonlysimTime:ConsumerSubject<number>
Defined in: src/sdk/traffic/Tcas.ts:557
simTimeUpdateFreq
protectedreadonlysimTimeUpdateFreq:Subscribable<number>
Defined in: src/sdk/traffic/Tcas.ts:517
tfcInstrument
protectedreadonlytfcInstrument:TrafficInstrument
Defined in: src/sdk/traffic/Tcas.ts:599
Methods
canCancelProximityAdvisory()
protectedcanCancelProximityAdvisory(simTime,intruder):boolean
Defined in: src/sdk/traffic/Tcas.ts:1133
Checks whether a proximity advisory can be canceled for an intruder.
Parameters
| Parameter | Type | Description |
|---|---|---|
simTime | number | The current sim time, as a UNIX timestamp in milliseconds. |
intruder | I | An intruder. |
Returns
boolean
Whether a proximity advisory can be canceled for the intruder.
canCancelResolutionAdvisory()
protectedcanCancelResolutionAdvisory(simTime,intruder):boolean
Defined in: src/sdk/traffic/Tcas.ts:1088
Checks whether a resolution advisory can be canceled for an intruder.
Parameters
| Parameter | Type | Description |
|---|---|---|
simTime | number | The current sim time, as a UNIX timestamp in milliseconds. |
intruder | I | An intruder. |
Returns
boolean
Whether a resolution advisory can be issued for the intruder.
canCancelTrafficAdvisory()
protectedcanCancelTrafficAdvisory(simTime,intruder):boolean
Defined in: src/sdk/traffic/Tcas.ts:1111
Checks whether a traffic advisory can be canceled for an intruder.
Parameters
| Parameter | Type | Description |
|---|---|---|
simTime | number | The current sim time, as a UNIX timestamp in milliseconds. |
intruder | I | An intruder. |
Returns
boolean
Whether a traffic advisory can be canceled for the intruder.
canIssueProximityAdvisory()
protectedcanIssueProximityAdvisory(simTime,intruder):boolean
Defined in: src/sdk/traffic/Tcas.ts:1122
Checks whether a proximity advisory can be issued for an intruder.
Parameters
| Parameter | Type | Description |
|---|---|---|
simTime | number | The current sim time, as a UNIX timestamp in milliseconds. |
intruder | I | An intruder. |
Returns
boolean
Whether a proximity advisory can be issued for the intruder.
canIssueResolutionAdvisory()
protectedcanIssueResolutionAdvisory(simTime,intruder):boolean
Defined in: src/sdk/traffic/Tcas.ts:1074
Checks whether a resolution advisory can be issued for an intruder.
Parameters
| Parameter | Type | Description |
|---|---|---|
simTime | number | The current sim time, as a UNIX timestamp in milliseconds. |
intruder | I | An intruder. |
Returns
boolean
Whether a resolution advisory can be issued for the intruder.
canIssueTrafficAdvisory()
protectedcanIssueTrafficAdvisory(simTime,intruder):boolean
Defined in: src/sdk/traffic/Tcas.ts:1100
Checks whether a traffic advisory can be issued for an intruder.
Parameters
| Parameter | Type | Description |
|---|---|---|
simTime | number | The current sim time, as a UNIX timestamp in milliseconds. |
intruder | I | An intruder. |
Returns
boolean
Whether a traffic advisory can be issued for the intruder.
createIntruderEntry()
abstractprotectedcreateIntruderEntry(contact):I
Defined in: src/sdk/traffic/Tcas.ts:847
Creates a TCAS intruder entry from a traffic contact.
Parameters
| Parameter | Type | Description |
|---|---|---|
contact | TrafficContact | A traffic contact. |
Returns
I
createSensitivity()
abstractprotectedcreateSensitivity():S
Defined in: src/sdk/traffic/Tcas.ts:651
Creates a TCAS sensitivity object.
Returns
S
A TCAS sensitivity object.
doUpdate()
protecteddoUpdate(simTime):void
Defined in: src/sdk/traffic/Tcas.ts:905
Executes an update.
Parameters
| Parameter | Type | Description |
|---|---|---|
simTime | number | The current sim time, as a UNIX timestamp in milliseconds. |
Returns
void
filterIntruder()
protectedfilterIntruder(intruder):boolean
Defined in: src/sdk/traffic/Tcas.ts:966
Filters an intruder.
Parameters
| Parameter | Type | Description |
|---|---|---|
intruder | I | An intruder. |
Returns
boolean
Whether the intruder should be tracked by this TCAS.
getEventSubscriber()
getEventSubscriber():
EventSubscriber<TcasEvents>
Defined in: src/sdk/traffic/Tcas.ts:689
Gets an event bus subscriber for TCAS events.
Returns
an event bus subscriber for TCAS events..
getIntruders()
getIntruders(): readonly
TcasIntruder[]
Defined in: src/sdk/traffic/Tcas.ts:673
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.
getOperatingMode()
getOperatingMode():
TcasOperatingMode
Defined in: src/sdk/traffic/Tcas.ts:657
Gets this system's operating mode.
Returns
This system's operating mode.
getResolutionAdvisoryHost()
getResolutionAdvisoryHost():
TcasResolutionAdvisoryHost
Defined in: src/sdk/traffic/Tcas.ts:681
Gets this system's resolution advisory host.
Returns
This system's resolution advisory host.
init()
init():
void
Defined in: src/sdk/traffic/Tcas.ts:696
Initializes this system.
Returns
void
intruderComparator()
protectedintruderComparator(a,b):number
Defined in: src/sdk/traffic/Tcas.ts:772
Sorts two intruders.
Parameters
| Parameter | Type | Description |
|---|---|---|
a | I | The first intruder. |
b | I | The 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.
onOperatingModeChanged()
protectedonOperatingModeChanged(mode):void
Defined in: src/sdk/traffic/Tcas.ts:748
Responds to changes in this TCAS's operating mode.
Parameters
| Parameter | Type | Description |
|---|---|---|
mode | TcasOperatingMode | The current operating mode. |
Returns
void
setOperatingMode()
setOperatingMode(
mode):void
Defined in: src/sdk/traffic/Tcas.ts:665
Sets this system's operating mode.
Parameters
| Parameter | Type | Description |
|---|---|---|
mode | TcasOperatingMode | The new operating mode. |
Returns
void
updateFilteredIntruderAlertLevels()
protectedupdateFilteredIntruderAlertLevels(simTime):void
Defined in: src/sdk/traffic/Tcas.ts:974
Updates the alert levels for all intruders tracked by this system that have not been filtered out.
Parameters
| Parameter | Type | Description |
|---|---|---|
simTime | number | The current sim time, as a UNIX timestamp in milliseconds. |
Returns
void
updateIntruderAlertLevel()
protectedupdateIntruderAlertLevel(simTime,intruder):void
Defined in: src/sdk/traffic/Tcas.ts:1006
Updates an intruder's alert level.
Parameters
| Parameter | Type | Description |
|---|---|---|
simTime | number | The current sim time, as a UNIX timestamp in milliseconds. |
intruder | I | An intruder. |
Returns
void
updateIntruderArrays()
protectedupdateIntruderArrays():void
Defined in: src/sdk/traffic/Tcas.ts:934
Updates the arrays of intruders tracked by this system.
Returns
void
updateIntruderPredictions()
protectedupdateIntruderPredictions(simTime):void
Defined in: src/sdk/traffic/Tcas.ts:919
Updates the TCA predictions for all intruders tracked by this system.
Parameters
| Parameter | Type | Description |
|---|---|---|
simTime | number | The current sim time, as a UNIX timestamp in milliseconds. |
Returns
void
updateResolutionAdvisory()
protectedupdateResolutionAdvisory(simTime):void
Defined in: src/sdk/traffic/Tcas.ts:1141
Updates this TCAS's resolution advisory.
Parameters
| Parameter | Type | Description |
|---|---|---|
simTime | number | The current sim time, as a UNIX timestamp in milliseconds. |
Returns
void
updateSensitivity()
abstractprotectedupdateSensitivity():void
Defined in: src/sdk/traffic/Tcas.ts:913
Returns
void