editor › Globals › PlatePipeline

Class: PlatePipeline

Hierarchy

• PlatePipeline

Index

Constructors

• constructor

Properties

• cancelled
• config
• currentStep
• done
• resultListeners
• steps
• warningEventEmitter

Methods

• _createResultObjects
• _finished
• _onWarning
• cancel
• getWarningEventEmitter
• isCancelled
• onFinished
• run
• runAsynchronously
• runStepWise
• runStepWiseAsynchronously
• create2DPipeline
• create3DPipeline

Constructors

constructor

+ new PlatePipeline(steps: PlatePipelineStep[], config: PlatePipelineConfig‹›): PlatePipeline

Defined in src/model/visualization/Plates/PlatePipeline/PlatePipeline.ts:54

Parameters:

Name	Type	Default
steps	PlatePipelineStep[]	-
config	PlatePipelineConfig‹›	new PlatePipelineConfig()

Returns: PlatePipeline

Properties

Private cancelled

• cancelled: boolean = false

Defined in src/model/visualization/Plates/PlatePipeline/PlatePipeline.ts:48

---

Private Readonly config

• config: PlatePipelineConfig

Defined in src/model/visualization/Plates/PlatePipeline/PlatePipeline.ts:46

---

Private currentStep

• currentStep: PlatePipelineStep = null

Defined in src/model/visualization/Plates/PlatePipeline/PlatePipeline.ts:47

---

Private done

• done: boolean = false

Defined in src/model/visualization/Plates/PlatePipeline/PlatePipeline.ts:49

---

Private resultListeners

• resultListeners: Array‹function› = []

Defined in src/model/visualization/Plates/PlatePipeline/PlatePipeline.ts:54

---

Private Readonly steps

• steps: PlatePipelineStep[]

Defined in src/model/visualization/Plates/PlatePipeline/PlatePipeline.ts:45

---

Private Readonly warningEventEmitter

• warningEventEmitter: EventEmitter‹object› = new EventEmitter<{ code: string; message: string; }>()

Defined in src/model/visualization/Plates/PlatePipeline/PlatePipeline.ts:50

Methods

Private _createResultObjects

▸ _createResultObjects(plates: Plate[]): IPlatePipelineResult[]

Defined in src/model/visualization/Plates/PlatePipeline/PlatePipeline.ts:168

Parameters:

Name	Type
plates	Plate[]

Returns: IPlatePipelineResult[]

---

Private _finished

▸ _finished(): void

Defined in src/model/visualization/Plates/PlatePipeline/PlatePipeline.ts:162

Returns: void

---

Private _onWarning

▸ _onWarning(warning: object): void

Defined in src/model/visualization/Plates/PlatePipeline/PlatePipeline.ts:158

Parameters:

▪ warning: object

Name	Type
code	string
message	string

Returns: void

---

cancel

▸ cancel(): void

Defined in src/model/visualization/Plates/PlatePipeline/PlatePipeline.ts:139

Returns: void

---

getWarningEventEmitter

▸ getWarningEventEmitter(): IPublicEventEmitterInterface‹object›

Defined in src/model/visualization/Plates/PlatePipeline/PlatePipeline.ts:154

Returns: IPublicEventEmitterInterface‹object›

---

isCancelled

▸ isCancelled(): boolean

Defined in src/model/visualization/Plates/PlatePipeline/PlatePipeline.ts:150

Returns: boolean

---

onFinished

▸ onFinished(): Promise‹void›

Defined in src/model/visualization/Plates/PlatePipeline/PlatePipeline.ts:129

Returns: Promise‹void›

---

run

▸ run(plate: Plate): IPlatePipelineResult

Defined in src/model/visualization/Plates/PlatePipeline/PlatePipeline.ts:95

Parameters:

Name	Type
plate	Plate

Returns: IPlatePipelineResult

---

runAsynchronously

▸ runAsynchronously(plate: Plate): Promise‹IPlatePipelineResult›

Defined in src/model/visualization/Plates/PlatePipeline/PlatePipeline.ts:110

Parameters:

Name	Type
plate	Plate

Returns: Promise‹IPlatePipelineResult›

---

runStepWise

▸ runStepWise(plates: Plate[], configs?: PlatePipelineConfig[]): IPlatePipelineResult[]

Defined in src/model/visualization/Plates/PlatePipeline/PlatePipeline.ts:66

Runs the pipeline for all plates executing a step for all plates before the next step is started.

Parameters:

Name	Type
plates	Plate[]
configs?	PlatePipelineConfig[]

Returns: IPlatePipelineResult[]

---

runStepWiseAsynchronously

▸ runStepWiseAsynchronously(plates: Plate[], configs?: PlatePipelineConfig[]): Promise‹IPlatePipelineResult[]›

Defined in src/model/visualization/Plates/PlatePipeline/PlatePipeline.ts:78

Like runStepWise, but asynchronously

Parameters:

Name	Type
plates	Plate[]
configs?	PlatePipelineConfig[]

Returns: Promise‹IPlatePipelineResult[]›

---

Static create2DPipeline

▸ create2DPipeline(config: PlatePipelineConfig‹›): PlatePipeline

Defined in src/model/visualization/Plates/PlatePipeline/PlatePipeline.ts:18

Parameters:

Name	Type	Default
config	PlatePipelineConfig‹›	new PlatePipelineConfig()

Returns: PlatePipeline

---

Static create3DPipeline

▸ create3DPipeline(config: PlatePipelineConfig): PlatePipeline

Defined in src/model/visualization/Plates/PlatePipeline/PlatePipeline.ts:30

Parameters:

Name	Type
config	PlatePipelineConfig

Returns: PlatePipeline