Class: TrafficInstrument
Defined in: src/sdk/instruments/Traffic.ts:83
Tracks aircraft traffic. Maintains a list of contacts, periodically updates their position, altitude, and reported heading, and uses these data to compute ground speed, ground track, and vertical speed.
Implements
Constructors
Constructor
new TrafficInstrument(
bus,options):TrafficInstrument
Defined in: src/sdk/instruments/Traffic.ts:97
Constructor.
Parameters
| Parameter | Type | Description |
|---|---|---|
bus | EventBus | The event bus. |
options | TrafficInstrumentOptions | Options with which to initialize this instrument. |
Returns
TrafficInstrument
Methods
forEachContact()
forEachContact(
visitor):void
Defined in: src/sdk/instruments/Traffic.ts:114
Iterates through all tracked traffic contacts with a visitor function.
Parameters
| Parameter | Type | Description |
|---|---|---|
visitor | (contact) => void | A visitor function. |
Returns
void
getContact()
getContact(
uid):undefined|TrafficContact
Defined in: src/sdk/instruments/Traffic.ts:106
Retrieves a traffic contact by its assigned ID number.
Parameters
| Parameter | Type | Description |
|---|---|---|
uid | number | an ID number. |
Returns
undefined | TrafficContact
the traffic contact with the assigned ID number, or undefined if no such contact exists.
init()
init():
void
Defined in: src/sdk/instruments/Traffic.ts:122
Initializes this instrument. Once initialized, this instrument will automatically track and update traffic contacts.
Returns
void
Implementation of
onUpdate()
onUpdate():
void
Defined in: src/sdk/instruments/Traffic.ts:221
This method does nothing.
Returns
void