◆ PipelineBuilderBase()
| FiftyOne.Pipeline.Core.FlowElements.PipelineBuilderBase< T >.PipelineBuilderBase | ( | ILoggerFactory | loggerFactory | ) |
Create a new PipelineBuilderBase<T> instance.
- Parameters
-
- loggerFactory - The ILoggerFactory to use when creating logger instances.
Member Function Documentation
◆ AddFlowElement()
T FiftyOne.Pipeline.Core.FlowElements.PipelineBuilderBase< T >.AddFlowElement ( IFlowElement element ) Add the specified IFlowElement to the pipeline.
Elements are typically executed sequentially in the order they are added.
- Parameters
-
- element - The IFlowElement to add
- Returns
- This builder instance.
- Exceptions
-
- ObjectDisposedException - Thrown if the element has already been disposed.
- ArgumentNullException - Thrown if the supplied element is null.
◆ AddFlowElementsParallel()
T FiftyOne.Pipeline.Core.FlowElements.PipelineBuilderBase< T >.AddFlowElementsParallel ( params IFlowElement [] elements ) Add the specified IFlowElement array to the pipeline.
These elements will all be started at the same time and executed in parallel using one thread for each element.
- Parameters
-
- elements - The IFlowElement array to add
- Returns
- This builder instance.
- Exceptions
-
- ObjectDisposedException - Thrown if any of the elements have already been disposed.
◆ Build()
virtual IPipeline FiftyOne.Pipeline.Core.FlowElements.PipelineBuilderBase< T >.Build ( ) virtualBuild the pipeline
- Returns
- A new IPipeline instance containing the configured IFlowElement instances.
◆ OnPreBuild()
virtual void FiftyOne.Pipeline.Core.FlowElements.PipelineBuilderBase< T >.OnPreBuild ( ) protected virtualCalled just before a pipeline is built.
Reimplemented in FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.FiftyOnePipelineBuilder.
◆ SetAutoDisposeElements()
T FiftyOne.Pipeline.Core.FlowElements.PipelineBuilderBase< T >.SetAutoDisposeElements ( bool autoDispose ) Configure the Pipeline to either call dispose on it's child FlowElements when it is disposed or not.
- Parameters
-
- autoDispose - If true then Pipeline will call dispose on it's child elements when it is disposed.
- Returns
- This builder instance.
◆ SetSuppressProcessException()
T FiftyOne.Pipeline.Core.FlowElements.PipelineBuilderBase< T >.SetSuppressProcessException ( bool suppressExceptions ) Configure the Pipeline to either suppress exceptions added to IFlowData.Errors during processing or to throw them as an aggregate exception once processing is complete.
- Parameters
-
- suppressExceptions - If true then Pipeline will suppress exceptions added to IFlowData.Errors.
- Returns
- This builder instance.
Property Documentation
◆ FlowElements
List<IFlowElement> FiftyOne.Pipeline.Core.FlowElements.PipelineBuilderBase< T >.FlowElements get protectedThe elements to be added to the pipeline
◆ Logger
ILogger<T> FiftyOne.Pipeline.Core.FlowElements.PipelineBuilderBase< T >.Logger = new List<IFlowElement>() get protectedLogger
◆ LoggerFactory
ILoggerFactory FiftyOne.Pipeline.Core.FlowElements.PipelineBuilderBase< T >.LoggerFactory get protectedA factory used to create logger instances.