Logo ProcessCore

LabProcess Type

Core transformation node. Connects inputs to outputs via a protocol. bioschemas.org/LabProcess

Constructors

Constructor Description

LabProcess(name, ?executesProtocol, ?additionalType, ?inputs, ?outputs, ?parameterValue)

Full Usage: LabProcess(name, ?executesProtocol, ?additionalType, ?inputs, ?outputs, ?parameterValue)

Parameters:
Returns: LabProcess
name : string
?executesProtocol : LabProtocol
?additionalType : string
?inputs : IONode seq
?outputs : IONode seq
?parameterValue : PropertyValue seq
Returns: LabProcess

Instance members

Instance member Description

this.AddInput

Full Usage: this.AddInput

Parameters:

Add input. Resolves the node against the root registry so back-edges are shared when an equal node already exists anywhere in the dataset hierarchy.

node : IONode

this.AddInputData

Full Usage: this.AddInputData

Parameters:
d : Data

this.AddInputMaterial

Full Usage: this.AddInputMaterial

Parameters:
m : Material

this.AddOutput

Full Usage: this.AddOutput

Parameters:

Add output. Resolves the node against the root registry so back-edges are shared when an equal node already exists anywhere in the dataset hierarchy.

node : IONode

this.AddOutputData

Full Usage: this.AddOutputData

Parameters:
d : Data

this.AddOutputMaterial

Full Usage: this.AddOutputMaterial

Parameters:
m : Material

this.AddParameterValue

Full Usage: this.AddParameterValue

Parameters:

this.AdditionalType

Full Usage: this.AdditionalType

Returns: string option
Returns: string option

this.CanonicalizeAllNodes

Full Usage: this.CanonicalizeAllNodes

Parameters:

Re-canonicalize all existing inputs and outputs against the given dataset's root registry. Called when the process is added to a dataset after its nodes were already populated. Migrates back-edges if the canonical instance differs.

ds : Dataset

this.ExecutesProtocol

Full Usage: this.ExecutesProtocol

Returns: LabProtocol option
Returns: LabProtocol option

this.GetInputsOfOutput

Full Usage: this.GetInputsOfOutput

Parameters:
Returns: IONode seq

Returns the positional input peer(s) of the given output node. When this process has equal numbers of inputs and outputs the Nth output maps to the Nth input (N-to-N). Falls back to all inputs when counts differ or when the node is not found in Outputs.

output : IONode
Returns: IONode seq

this.GetOutputsOfInput

Full Usage: this.GetOutputsOfInput

Parameters:
Returns: IONode seq

Returns the positional output peer(s) of the given input node. When this process has equal numbers of inputs and outputs the Nth input maps to the Nth output (N-to-N). Falls back to all outputs when counts differ or when the node is not found in Inputs.

input : IONode
Returns: IONode seq

this.GetParameterValue

Full Usage: this.GetParameterValue

Parameters:
    name : string

Returns: PropertyValue
name : string
Returns: PropertyValue

this.InputData

Full Usage: this.InputData

Returns: ResizeArray<Data>

Input nodes that are Data.

Returns: ResizeArray<Data>

this.InputMaterials

Full Usage: this.InputMaterials

Returns: ResizeArray<Material>

Input nodes that are Materials.

Returns: ResizeArray<Material>

this.Inputs

Full Usage: this.Inputs

Returns: ResizeArray<IONode>
Returns: ResizeArray<IONode>

this.Name

Full Usage: this.Name

Returns: string
Returns: string

this.OutputData

Full Usage: this.OutputData

Returns: ResizeArray<Data>

Output nodes that are Data.

Returns: ResizeArray<Data>

this.OutputMaterials

Full Usage: this.OutputMaterials

Returns: ResizeArray<Material>

Output nodes that are Materials.

Returns: ResizeArray<Material>

this.Outputs

Full Usage: this.Outputs

Returns: ResizeArray<IONode>
Returns: ResizeArray<IONode>

this.ParameterValue

Full Usage: this.ParameterValue

Returns: ResizeArray<PropertyValue>
Returns: ResizeArray<PropertyValue>

this.ProcessOf

Full Usage: this.ProcessOf

Returns: Dataset option

Back-edge: the Dataset this process belongs to

Returns: Dataset option

this.PropertyValuesByName

Full Usage: this.PropertyValuesByName

Parameters:
    name : string

Returns: ResizeArray<PropertyValue>

PropertyValues from all sources (parameters, input/output node properties, protocol components) whose name matches the given string.

name : string
Returns: ResizeArray<PropertyValue>

this.ProtocolParameters

Full Usage: this.ProtocolParameters

Returns: ResizeArray<FormalParameter>

FormalParameters defined on the protocol executed by this process.

Returns: ResizeArray<FormalParameter>

this.RemoveInput

Full Usage: this.RemoveInput

Parameters:
node : IONode

this.RemoveInputData

Full Usage: this.RemoveInputData

Parameters:
d : Data

this.RemoveInputMaterial

Full Usage: this.RemoveInputMaterial

Parameters:
m : Material

this.RemoveOutput

Full Usage: this.RemoveOutput

Parameters:
node : IONode

this.RemoveOutputData

Full Usage: this.RemoveOutputData

Parameters:
d : Data

this.RemoveOutputMaterial

Full Usage: this.RemoveOutputMaterial

Parameters:
m : Material

this.RemoveParameterValue

Full Usage: this.RemoveParameterValue

Parameters:

this.TryGetParameterValue

Full Usage: this.TryGetParameterValue

Parameters:
    name : string

Returns: PropertyValue option
name : string
Returns: PropertyValue option

Type something to start searching.