◆ CreateFlowData()
| IFlowData FiftyOne.Pipeline.Core.FlowElements.IPipeline.CreateFlowData | ( | ) |
Create a new IFlowData instance.
- Returns
- A new IFlowData instance.
Implemented in FiftyOne.Pipeline.Core.FlowElements.Pipeline.
Detailed Description
The public interface for a Pipeline.
See the Specification
Inheritance diagram for FiftyOne.Pipeline.Core.FlowElements.IPipeline:
Collaboration diagram for FiftyOne.Pipeline.Core.FlowElements.IPipeline:
Public Member Functions
| IFlowData | CreateFlowData ()
Create a new IFlowData instance. More...
|
| bool | HasExpectedElementAfter< TElement, TExpectedElement > ()
Check if the pipeline contains an instance of TExpectedElement that will be executed after TElement . More...
|
| TElement | GetElement< TElement > ()
Get the specified element from the pipeline. More...
|
Properties
| IEvidenceKeyFilter | EvidenceKeyFilter [get]
Get a filter that will only include the evidence keys that can be used by at least one IFlowElement within this pipeline. More...
|
| bool | IsConcurrent [get]
True if any of the IFlowElements in this pipeline will create multiple threads and execute in parallel. More...
|
| bool | IsDisposed [get]
True if the pipeline has been disposed More...
|
| bool | SuppressProcessExceptions [get]
|
| IReadOnlyList< IFlowElement > | FlowElements [get]
Get a read only list of the flow elements that are part of this pipeline. More...
|
| IReadOnlyDictionary< string, IReadOnlyDictionary< string, IElementPropertyMetaData > > | ElementAvailableProperties [get]
Get the dictionary of available properties for an IFlowElement.ElementDataKey. More...
|
Member Function Documentation
◆ GetElement< TElement >()
| TElement FiftyOne.Pipeline.Core.FlowElements.IPipeline.GetElement< TElement > | ( | ) |
Get the specified element from the pipeline.
If the pipeline contains multiple elements of the requested type, this method will return null.
- Template Parameters
-
- TElement - The type of the IFlowElement to get
- Returns
- An instance of the specified IFlowElement if the pipeline contains one. Null is returned if there is no such instance or there are multiple instances of that type.
Implemented in FiftyOne.Pipeline.Core.FlowElements.Pipeline.
- Type Constraints
-
TElement : class TElement : IFlowElement
◆ HasExpectedElementAfter< TElement, TExpectedElement >()
| bool FiftyOne.Pipeline.Core.FlowElements.IPipeline.HasExpectedElementAfter< TElement, TExpectedElement > | ( | ) |
Check if the pipeline contains an instance of TExpectedElement that will be executed after TElement .
- Template Parameters
-
- TElement - The type of the element to check.
- TExpectedElement - The type of the element that should come after TElement .
- Returns
- True if TExpectedElement is present in the pipeline and will be executed after TElement
Implemented in FiftyOne.Pipeline.Core.FlowElements.Pipeline.
- Type Constraints
-
TElement : IFlowElement TExpectedElement : IFlowElement
Property Documentation
◆ ElementAvailableProperties
| IReadOnlyDictionary<string, IReadOnlyDictionary<string, IElementPropertyMetaData> > FiftyOne.Pipeline.Core.FlowElements.IPipeline.ElementAvailableProperties |
get
Get the dictionary of available properties for an IFlowElement.ElementDataKey.
The dictionary returned contains the IElementPropertyMetaDatas keyed on the name field.
◆ EvidenceKeyFilter
| IEvidenceKeyFilter FiftyOne.Pipeline.Core.FlowElements.IPipeline.EvidenceKeyFilter |
get
Get a filter that will only include the evidence keys that can be used by at least one IFlowElement within this pipeline.
◆ FlowElements
| IReadOnlyList<IFlowElement> FiftyOne.Pipeline.Core.FlowElements.IPipeline.FlowElements |
get
Get a read only list of the flow elements that are part of this pipeline.
◆ IsConcurrent
| bool FiftyOne.Pipeline.Core.FlowElements.IPipeline.IsConcurrent |
get
True if any of the IFlowElements in this pipeline will create multiple threads and execute in parallel.
False otherwise.
◆ IsDisposed
| bool FiftyOne.Pipeline.Core.FlowElements.IPipeline.IsDisposed |
get
True if the pipeline has been disposed
◆ SuppressProcessExceptions
| bool FiftyOne.Pipeline.Core.FlowElements.IPipeline.SuppressProcessExceptions |
get
Control field that indicates if the Pipeline will throw an aggregate exception during processing or suppress it and ignore the exceptions added to IFlowData.Errors.