Class: DefaultInitializationDataProvider

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Initialization/DefaultInitializationDataProvider.ts:20

A default implementation of InitializationDataProvider.

Implements

• InitializationDataProvider

Constructors

Constructor

new DefaultInitializationDataProvider(bus): DefaultInitializationDataProvider

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Initialization/DefaultInitializationDataProvider.ts:57

Creates a new instance of DefaultInitializationDataProvider.

Parameters

Parameter	Type	Description
bus	EventBus	The event bus.

Returns

DefaultInitializationDataProvider

Properties

areAllTasksCompleted

readonly areAllTasksCompleted: Subscribable<boolean>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Initialization/DefaultInitializationDataProvider.ts:39

Whether all initialization tasks have been completed. If the initialization process is disabled or there are no tasks, then this value is always false.

Implementation of

InitializationDataProvider.areAllTasksCompleted

---

id

readonly id: Subscribable<null | string>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Initialization/DefaultInitializationDataProvider.ts:23

The ID string of the initialization process being used, or null if no process is being used.

Implementation of

InitializationDataProvider.id

---

isAccepted

readonly isAccepted: Subscribable<boolean>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Initialization/DefaultInitializationDataProvider.ts:43

Whether initialization has been accepted by the user.

Implementation of

InitializationDataProvider.isAccepted

---

isEnabled

readonly isEnabled: Subscribable<boolean>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Initialization/DefaultInitializationDataProvider.ts:27

Whether the initialization process is enabled.

Implementation of

InitializationDataProvider.isEnabled

---

resetMessage

readonly resetMessage: Subscribable<undefined | string>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Initialization/DefaultInitializationDataProvider.ts:35

The message to display to the user when attempting to reset the initialization process.

Implementation of

InitializationDataProvider.resetMessage

---

tasks

readonly tasks: SubscribableArray<InitializationTaskData>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Initialization/DefaultInitializationDataProvider.ts:31

An ordered array containing data describing the tasks that comprise the initialization process. The order of the task data is the same as the order of the corresponding tasks in the initialization process.

Implementation of

InitializationDataProvider.tasks

Methods

destroy()

destroy(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Initialization/DefaultInitializationDataProvider.ts:221

Destroys this data provider. Once destroyed, this data provider will no longer update its provided data, and can no longer be paused or resumed.

Returns

void

---

init()

init(paused): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Initialization/DefaultInitializationDataProvider.ts:66

Initializes this data provider. Once initialized, this data provider will continuously update its data until paused or destroyed.

Parameters

Parameter	Type	Default value	Description
paused	boolean	false	Whether to initialize this data provider as paused. Defaults to false.

Returns

void

Throws

Error if this data provider has been destroyed.

---

pause()

pause(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Initialization/DefaultInitializationDataProvider.ts:127

Pauses this data provider. Once paused, this data provider will not update its data until it is resumed.

Returns

void

Throws

Error if this data provider has been destroyed.

---

resume()

resume(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Initialization/DefaultInitializationDataProvider.ts:95

Resumes this data provider. Once resumed, this data provider will continuously update its data until paused or destroyed.

Returns

void

Throws

Error if this data provider has been destroyed.