Skip to main content

Class: CasSystem

Defined in: src/sdk/cas/CasSystem.ts:189

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

Defined in: src/sdk/cas/CasSystem.ts:244

Create a CasSystem.

Parameters​

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

Returns​

CasSystem

Properties​

casActiveMessageSubject​

readonly casActiveMessageSubject: SubscribableArray<CasActiveMessage>

Defined in: src/sdk/cas/CasSystem.ts:237

Methods​

acknowledgeMessage()​

protected acknowledgeMessage(message): void

Defined in: src/sdk/cas/CasSystem.ts:615

Acknowledge a single message by mutating it.

Parameters​

ParameterTypeDescription
messageCasActiveMessageThe message to be acknowledged from CasSystem's allMessages

Returns​

void


checkForActiveType()​

protected checkForActiveType(type): boolean

Defined in: src/sdk/cas/CasSystem.ts:753

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

Parameters​

ParameterTypeDescription
typeAnnunciationTypeThe annunciation type to check for.

Returns​

boolean

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


handleAcknowledgement()​

protected handleAcknowledgement(type): void

Defined in: src/sdk/cas/CasSystem.ts:579

Handle a master warning or caution acknowledgement.

Parameters​

ParameterTypeDescription
typeAnnunciationTypeThe type of alert to acknowledge.

Returns​

void


handleSingleAcknowledgement()​

protected handleSingleAcknowledgement(key, priority): void

Defined in: src/sdk/cas/CasSystem.ts:600

Handle acknowledgement of a single message

Parameters​

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

Returns​

void