Logo ProcessCore

IONode Type

An IONode is either a Sample or a Data node.

Union cases

Union case Description

DataNode Data

Full Usage: DataNode Data

Parameters:
Item : Data

SampleNode Sample

Full Usage: SampleNode Sample

Parameters:
Item : Sample

Instance members

Instance member Description

this.AllAnnotations

Full Usage: this.AllAnnotations

Parameters:
Returns: ResizeArray<Annotation>

All Annotations from all sources (parameters, input/output node properties, recipe components) connected to this node through the graph.

?scope : ResizeArray<Process>
Returns: ResizeArray<Annotation>

this.AllConnectedNodes

Full Usage: this.AllConnectedNodes

Parameters:
Returns: ResizeArray<IONode>

All IONodes connected to this node through the process graph (union of all upstream and downstream neighbours), excluding this node itself.

?scope : ResizeArray<Process>
Returns: ResizeArray<IONode>

this.AllConnectedProcesses

Full Usage: this.AllConnectedProcesses

Parameters:
Returns: ResizeArray<Process>

All processes reachable from this node by BFS through both upstream and downstream edges. Optional `scope` restricts traversal to the given process list (e.g. a single Dataset).

?scope : ResizeArray<Process>
Returns: ResizeArray<Process>

this.AsData

Full Usage: this.AsData

Returns: Data
Returns: Data

this.AsSample

Full Usage: this.AsSample

Returns: Sample
Returns: Sample

this.ConnectedData

Full Usage: this.ConnectedData

Parameters:
Returns: ResizeArray<Data>

All Data nodes connected to this node through the graph.

?scope : ResizeArray<Process>
Returns: ResizeArray<Data>

this.ConnectedSamples

Full Usage: this.ConnectedSamples

Parameters:
Returns: ResizeArray<Sample>

All Sample nodes connected to this node through the graph.

?scope : ResizeArray<Process>
Returns: ResizeArray<Sample>

this.DownstreamAnnotations

Full Usage: this.DownstreamAnnotations

Parameters:
    ?recipeName : string
    ?scope : ResizeArray<Process>

Returns: ResizeArray<Annotation>

Annotations from all sources in processes downstream of this node. Optional recipeName restricts to processes whose recipe name matches.

?recipeName : string
?scope : ResizeArray<Process>
Returns: ResizeArray<Annotation>

this.DownstreamData

Full Usage: this.DownstreamData

Parameters:
Returns: ResizeArray<Data>

All Data nodes reachable downstream from this node.

?scope : ResizeArray<Process>
Returns: ResizeArray<Data>

this.DownstreamNodes

Full Usage: this.DownstreamNodes

Parameters:
Returns: ResizeArray<IONode>

All IONodes reachable by following each consuming process's direct output.

?scope : ResizeArray<Process>
Returns: ResizeArray<IONode>

this.DownstreamProcesses

Full Usage: this.DownstreamProcesses

Parameters:
Returns: ResizeArray<Process>

All processes reachable by walking downstream (InputOf edges → Outputs).

?scope : ResizeArray<Process>
Returns: ResizeArray<Process>

this.DownstreamSamples

Full Usage: this.DownstreamSamples

Parameters:
Returns: ResizeArray<Sample>

All Sample nodes reachable downstream from this node.

?scope : ResizeArray<Process>
Returns: ResizeArray<Sample>

this.EqualTo

Full Usage: this.EqualTo

Parameters:
Returns: bool
other : IONode
Returns: bool

this.FinalNodes

Full Usage: this.FinalNodes

Parameters:
Returns: ResizeArray<IONode>

Downstream nodes that have no successors within scope (terminal sinks).

?scope : ResizeArray<Process>
Returns: ResizeArray<IONode>

this.GetInputOf

Full Usage: this.GetInputOf

Returns: HashSet<Process>

Processes for which this node is an input (forward back-edges).

Returns: HashSet<Process>

this.GetOutputOf

Full Usage: this.GetOutputOf

Returns: HashSet<Process>

Processes for which this node is an output (backward back-edges).

Returns: HashSet<Process>

this.IsDataNode

Full Usage: this.IsDataNode

Returns: bool
Returns: bool

this.IsFinalNode

Full Usage: this.IsFinalNode

Parameters:
Returns: bool

True if no in-scope process consumes this node as input (no successors in scope).

?scope : ResizeArray<Process>
Returns: bool

this.IsRootNode

Full Usage: this.IsRootNode

Parameters:
Returns: bool

True if no in-scope process produces this node as output (no predecessors in scope).

?scope : ResizeArray<Process>
Returns: bool

this.IsSampleNode

Full Usage: this.IsSampleNode

Returns: bool
Returns: bool

this.Key

Full Usage: this.Key

Returns: string

Stable string key used for identity checks and HashSet deduplication.

Returns: string

this.PathsThrough

Full Usage: this.PathsThrough

Parameters:
Returns: ResizeArray<Path>

All maximal Paths that pass through this node within the given process scope.

?scope : ResizeArray<Process>
Returns: ResizeArray<Path>

this.Processes

Full Usage: this.Processes

Parameters:
Returns: ResizeArray<Process>

All in-scope processes in which this node appears as an input or output.

?scope : ResizeArray<Process>
Returns: ResizeArray<Process>

this.RecipeParameters

Full Usage: this.RecipeParameters

Parameters:
Returns: ResizeArray<FormalParameter>

All FormalParameters from recipes executed in processes connected to this node.

?scope : ResizeArray<Process>
Returns: ResizeArray<FormalParameter>

this.RootNodes

Full Usage: this.RootNodes

Parameters:
Returns: ResizeArray<IONode>

Upstream nodes that have no predecessors within scope (terminal sources).

?scope : ResizeArray<Process>
Returns: ResizeArray<IONode>

this.TryData

Full Usage: this.TryData

Returns: Data option
Returns: Data option

this.TrySample

Full Usage: this.TrySample

Returns: Sample option
Returns: Sample option

this.UpstreamAnnotations

Full Usage: this.UpstreamAnnotations

Parameters:
    ?recipeName : string
    ?scope : ResizeArray<Process>

Returns: ResizeArray<Annotation>

Annotations from all sources in processes upstream of this node. Optional recipeName restricts to processes whose recipe name matches.

?recipeName : string
?scope : ResizeArray<Process>
Returns: ResizeArray<Annotation>

this.UpstreamData

Full Usage: this.UpstreamData

Parameters:
Returns: ResizeArray<Data>

All Data nodes reachable upstream from this node.

?scope : ResizeArray<Process>
Returns: ResizeArray<Data>

this.UpstreamNodes

Full Usage: this.UpstreamNodes

Parameters:
Returns: ResizeArray<IONode>

All IONodes reachable by following each producing process's direct input.

?scope : ResizeArray<Process>
Returns: ResizeArray<IONode>

this.UpstreamProcesses

Full Usage: this.UpstreamProcesses

Parameters:
Returns: ResizeArray<Process>

All processes reachable by walking upstream (OutputOf edges → Inputs).

?scope : ResizeArray<Process>
Returns: ResizeArray<Process>

this.UpstreamSamples

Full Usage: this.UpstreamSamples

Parameters:
Returns: ResizeArray<Sample>

All Sample nodes reachable upstream from this node.

?scope : ResizeArray<Process>
Returns: ResizeArray<Sample>

Type something to start searching.