Skip to main content

Class: XMLAnnunciationFactory

Defined in: src/sdk/components/Annunciatons/XMLAnnunciationAdapter.ts:8

Create a list of annunciations from the instrument XML config.

Constructors

Constructor

new XMLAnnunciationFactory(instrument): XMLAnnunciationFactory

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

Create an XMLAnnunciationFactory.

Parameters

ParameterTypeDescription
instrumentBaseInstrumentThe instrument that holds this engine display.

Returns

XMLAnnunciationFactory

Methods

parseConfig()

parseConfig(document): Annunciation[]

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

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

ParameterTypeDescription
documentDocumentThe configuration document to parse.

Returns

Annunciation[]

An array of annunciations defined by the document.


parseConfigElement()

parseConfigElement(element): Annunciation[]

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

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

Parameters

ParameterTypeDescription
elementElementThe element to parse.

Returns

Annunciation[]

An array of annunciations defined by the element.