Class Pipeline<TIn, TOut>

Defines a multi-threaded pipeline that runs in-process.

Inheritance

object

FlowModelObject

WorkItem

ExecutableWorkBase

ExecutableWorkBase<TIn, TOut>

Pipeline<TIn, TOut>

Implements

IFlowModelItem

IExecutableWork<TIn, TOut>

IComputationalWork

IPipeline

ICanBuildComputationalWork

Inherited Members

ExecutableWorkBase<TIn, TOut>.Execute(TIn, IExecutionContext)

ExecutableWorkBase<TIn, TOut>.Process(TIn, IExecutionContext)

ExecutableWorkBase<TIn, TOut>.Process(object, IExecutionContext)

ExecutableWorkBase.Source

ExecutableWorkBase.CanExecute()

ExecutableWorkBase.Execute(object, IExecutionContext)

ExecutableWorkBase.Complete(IExecutionContext, object, string)

ExecutableWorkBase.Fail(IExecutionContext, string, Exception)

ExecutableWorkBase.Process(object, IExecutionContext)

ExecutableWorkBase.CreateRootExecutionContext()

WorkItem.Tag

WorkItem.JobId

WorkItem.ParentId

WorkItem.Id

WorkItem.GetParent()

WorkItem.Select<T>(Func<WorkItem, T>)

WorkItem.Traverse(Action<WorkItem, WorkItem>, WorkItem)

WorkItem.FindItems(Func<WorkItem, bool>, bool)

WorkItem.OnInitialize(Job)

WorkItem.ToString()

FlowModelObject.BatchNumber

FlowModelObject.Properties

FlowModelObject.PropertiesContent

FlowModelObject.this[string]

FlowModelObject.UpdateProperties(string)

FlowModelObject.UpdateProperties(FlowModelObject)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: DNVGL.One.Compute.WorkExecution.ExecutionModel

Assembly: DNVGL.One.Compute.WorkExecution.dll

Syntax

public class Pipeline<TIn, TOut> : ExecutableWorkBase<TIn, TOut>, IFlowModelItem, IExecutableWork<TIn, TOut>, IComputationalWork, IPipeline, ICanBuildComputationalWork

Type Parameters

Name	Description
TIn	The type of the input.
TOut	The type of the output.

Constructors

Pipeline(IPipelineSource<TIn>, SequentialWork, IPipelineSink<TOut>)

Initializes a new instance of the Pipeline<TIn, TOut> class.

Declaration

public Pipeline(IPipelineSource<TIn> source, SequentialWork work, IPipelineSink<TOut> sink)

Parameters

Type	Name	Description
IPipelineSource<TIn>	source	The source.
SequentialWork	work	The sequential work of processing each item provided by the source.
IPipelineSink<TOut>	sink	The sink that receives the output of the pipeline.

See Also

ExecutableWorkBase<TIn, TOut>

IPipeline

ICanBuildComputationalWork

Properties

NumberOfChannels

Gets or sets the number of parallel processing channels.

Declaration

public int NumberOfChannels { get; set; }

Property Value

Type	Description
int	The number of processing channels.

See Also

ExecutableWorkBase<TIn, TOut>

IPipeline

ICanBuildComputationalWork

PipelineSource

Gets the pipeline source.

Declaration

public IPipelineSource<TIn> PipelineSource { get; }

Property Value

Type	Description
IPipelineSource<TIn>	The pipeline source.

See Also

ExecutableWorkBase<TIn, TOut>

IPipeline

ICanBuildComputationalWork

Sink

Gets the pipeline sink.

Declaration

public IPipelineSink<TOut> Sink { get; }

Property Value

Type	Description
IPipelineSink<TOut>	The pipeline sink.

See Also

ExecutableWorkBase<TIn, TOut>

IPipeline

ICanBuildComputationalWork

Work

Gets the work performed by the processing pipeline.

Declaration

public SequentialWork Work { get; }

Property Value

Type	Description
SequentialWork	The work performed by the processing pipeline.

See Also

ExecutableWorkBase<TIn, TOut>

IPipeline

ICanBuildComputationalWork

Methods

Build(IExecutableWorkBuilder)

Builds computational work using the given IExecutableWorkBuilder.

Declaration

public IComputationalWork Build(IExecutableWorkBuilder workBuilder)

Parameters

Type	Name	Description
IExecutableWorkBuilder	workBuilder	The work builder.

Returns

Type	Description
IComputationalWork	An IComputationalWork representation of the WorkItem.

See Also

ExecutableWorkBase<TIn, TOut>

IPipeline

ICanBuildComputationalWork

GetDescendants()

Gets the descendants.

Declaration

public override IEnumerable<WorkItem> GetDescendants()

Returns

Type	Description
IEnumerable<WorkItem>	Descendant items.

Overrides

ExecutableWorkBase.GetDescendants()

See Also

ExecutableWorkBase<TIn, TOut>

IPipeline

ICanBuildComputationalWork

Process(TIn, IExecutionContext)

Processes the specified input.

Declaration

protected override TOut Process(TIn input, IExecutionContext executionContext)

Parameters

Type	Name	Description
TIn	input	The input.
IExecutionContext	executionContext	The execution context.

Returns

Type	Description
TOut	Processing result. May be null.

Overrides

ExecutableWorkBase<TIn, TOut>.Process(TIn, IExecutionContext)

See Also

ExecutableWorkBase<TIn, TOut>

IPipeline

ICanBuildComputationalWork

Implements

IFlowModelItem

IExecutableWork<TIn, TOut>

IComputationalWork

IPipeline

ICanBuildComputationalWork

Extension Methods

WorkItemExtensions.GetAncestors(WorkItem, WorkItem)

WorkItemExtensions.GetRelativeWeight(WorkItem, WorkItem)

WorkItemExtensions.BuildExecutableWork(WorkItem)

See Also

ExecutableWorkBase<TIn, TOut>

IPipeline

ICanBuildComputationalWork