Skip to content

Pipeline<TBaseNode> Class

Definition

A pipeline to process nodes in a tree. A pipeline consists of multiple named stages, each of which has one or more Processor<TBaseNode>s running in serial or parallel. Stages can optionally specify whether pipeline processing should continue once the stage has completed. By default, processing will not continue if there are any errors in the tree.

public sealed class Pipeline<TBaseNode>
   where TBaseNode : Node<TBaseNode>

View source

Type Parameters

Name Description
TBaseNode The base type of nodes in the tree.

Properties

Name Description
Stages The stages in the pipeline.

Methods

Name Description
Build(Action<PipelineBuilder<TBaseNode>>) Fluent interface to build a Pipeline<TBaseNode>.
Run(TBaseNode, TBaseNode) Runs the pipeline on the specified root node, returning the potentially new root via an out parameter.
Run(TBaseNode, TBaseNode, String) Runs the pipeline on the specified root node, returning the potentially new root and last stage run via out parameters.
Run(TBaseNode) Runs the pipeline on the specified root node, returning a tuple with the result, the potentially replaced root node and the last stage run.