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
Name | Type | Default value | Description |
---|---|---|---|
bus | EventBus | undefined | The event bus. |
primary | boolean | false | Whether or not this is the system responsible for managing alerts at the sim level. |
Returns
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
Name | Type | Description |
---|---|---|
message | CasActiveMessage | The 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
Name | Type | Description |
---|---|---|
type | AnnunciationType | The 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
Name | Type | Description |
---|---|---|
type | AnnunciationType | The 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
Name | Type | Description |
---|---|---|
key | CasAlertKey | The UUID and optional suffix of the alert to handle. |
priority | AnnunciationType | The priority of the alert to handle. |
Returns
void
Defined in
src/sdk/cas/CasSystem.ts:600