Skip to main content

Class: CasSystem

A system for CAS management.

Every avionics system must have exactly one instance of CasSystem configured as the primary system. This is the one that is responsible for triggering sim-level master caution/warning alerts and intercepting and handling master acknowledge events.

Each JS instrument should have at most one instance of CasSystem. Multiple instances of CasSystem on a single instrument will cause duplicated events to be published to the topics defined by CasStateEvents.

Constructors

constructor

new CasSystem(bus, primary?): CasSystem

Create a CasSystem.

Parameters

NameTypeDefault valueDescription
busEventBusundefinedThe event bus.
primarybooleanfalseWhether or not this is the system responsible for managing alerts at the sim level.

Returns

CasSystem

Defined in

src/sdk/cas/CasSystem.ts:244

Properties

casActiveMessageSubject

Readonly casActiveMessageSubject: SubscribableArray<CasActiveMessage>

Defined in

src/sdk/cas/CasSystem.ts:237

Methods

acknowledgeMessage

acknowledgeMessage(message): void

Acknowledge a single message by mutating it.

Parameters

NameTypeDescription
messageCasActiveMessageThe message to be acknowledged from CasSystem's allMessages

Returns

void

Defined in

src/sdk/cas/CasSystem.ts:615


checkForActiveType

checkForActiveType(type): boolean

See if there is still an active, unacked annunciation of the given type.

Parameters

NameTypeDescription
typeAnnunciationTypeThe annunciation type to check for.

Returns

boolean

True if there is an active, unacked annunciation of the given type, false otherwise.

Defined in

src/sdk/cas/CasSystem.ts:753


handleAcknowledgement

handleAcknowledgement(type): void

Handle a master warning or caution acknowledgement.

Parameters

NameTypeDescription
typeAnnunciationTypeThe type of alert to acknowledge.

Returns

void

Defined in

src/sdk/cas/CasSystem.ts:579


handleSingleAcknowledgement

handleSingleAcknowledgement(key, priority): void

Handle acknowledgement of a single message

Parameters

NameTypeDescription
keyCasAlertKeyThe UUID and optional suffix of the alert to handle.
priorityAnnunciationTypeThe priority of the alert to handle.

Returns

void

Defined in

src/sdk/cas/CasSystem.ts:600