Skip to main content

Class: XMLAnnunciationFactory

Create a list of annunciations from the instrument XML config.

Constructors

constructor

new XMLAnnunciationFactory(instrument): XMLAnnunciationFactory

Create an XMLAnnunciationFactory.

Parameters

NameTypeDescription
instrumentBaseInstrumentThe instrument that holds this engine display.

Returns

XMLAnnunciationFactory

Defined in

src/sdk/components/Annunciatons/XMLAnnunciationAdapter.ts:15

Methods

parseConfig

parseConfig(document): Annunciation[]

Parses a configuration document and generates an array of annunciations defined by the document. This method looks for the first element in the document with a tag name equal to Annunciations and parses annunciations from that element. If such an element does not exist, then an empty array will be returned.

Parameters

NameTypeDescription
documentDocumentThe configuration document to parse.

Returns

Annunciation[]

An array of annunciations defined by the document.

Defined in

src/sdk/components/Annunciatons/XMLAnnunciationAdapter.ts:89


parseConfigElement

parseConfigElement(element): Annunciation[]

Parses a configuration document element and generates an array of annunciations defined by the element.

Parameters

NameTypeDescription
elementElementThe element to parse.

Returns

Annunciation[]

An array of annunciations defined by the element.

Defined in

src/sdk/components/Annunciatons/XMLAnnunciationAdapter.ts:24