◆ SequenceElement()
| FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.SequenceElement.SequenceElement | ( | ILogger< FlowElementBase< IElementData, IElementPropertyMetaData >> | logger | ) |
Constructor.
- Parameters
-
- logger -
Detailed Description
Sequence element establishes session and sequence evidence in the pipeline.
See the Specification
Inheritance diagram for FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.SequenceElement:
Collaboration diagram for FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.SequenceElement:
Public Member Functions
| SequenceElement (ILogger< FlowElementBase< IElementData, IElementPropertyMetaData >> logger)
Constructor. More...
| |
Public Member Functions inherited from FiftyOne.Pipeline.Core.FlowElements.FlowElementBase< IElementData, IElementPropertyMetaData > | |
| FlowElementBase (ILogger< FlowElementBase< T, TMeta >> logger)
Constructor More...
| |
| FlowElementBase (ILogger< FlowElementBase< T, TMeta >> logger, Func< IPipeline, FlowElementBase< T, TMeta >, T > elementDataFactory)
Constructor More...
| |
| virtual void | Process (IFlowData data)
Process the given IFlowData with this FlowElement. More...
|
| virtual void | AddPipeline (IPipeline pipeline)
Called when this element is added to a pipeline. More...
|
| void | Dispose ()
Dispose More...
|
Public Attributes
| const string | DEFAULT_ELEMENT_DATA_KEY = "sequence"
The default element data key that will be used for this element. More...
|
| override string | ElementDataKey => DEFAULT_ELEMENT_DATA_KEY
The element data key. More...
|
| override IList< IElementPropertyMetaData > | Properties => _properties
The properties populated by this element. More...
|
Protected Member Functions
| override void | ManagedResourcesCleanup ()
Called when the element is disposed. More...
|
| override void | ProcessInternal (IFlowData data)
Process method checks for presence of a session id and sequence number. More...
|
| override void | UnmanagedResourcesCleanup ()
Called as part of object disposal. More...
|
Protected Member Functions inherited from FiftyOne.Pipeline.Core.FlowElements.FlowElementBase< IElementData, IElementPropertyMetaData > | |
| abstract void | ProcessInternal (IFlowData data)
Abstract method called by Process(IFlowData). More...
|
| virtual T | CreateElementData (IPipeline pipeline)
Method used to create element data instances that are populated by this flow element More...
|
| virtual void | Dispose (bool disposing)
Dispose of any resources. More...
|
Properties
| override IEvidenceKeyFilter | EvidenceKeyFilter [get]
The evidence key filter. More...
|
Properties inherited from FiftyOne.Pipeline.Core.FlowElements.FlowElementBase< IElementData, IElementPropertyMetaData > | |
| ILogger< FlowElementBase< T, TMeta > > | Logger [get]
The logger for this instance More...
|
| IReadOnlyList< IPipeline > | Pipelines [get]
Get a read only list of the pipelines that this element has been added to. More...
|
| abstract string | ElementDataKey [get]
The string name of the key used to access the data populated by this element in the IFlowData. More...
|
| abstract IEvidenceKeyFilter | EvidenceKeyFilter [get]
A list of all the evidence keys that this Flow Element can make use of. More...
|
| abstract IList< TMeta > | Properties [get]
Details of the properties that this engine can populate More...
|
| virtual bool | Asynchronous [get]
True if the element can be run totally asynchronously, false otherwise. More...
|
| virtual bool | IsConcurrent [get]
True if the element starts multiple threads. More...
|
| bool | IsDisposed [get]
True if the element has been disposed More...
|
| ITypedKey< T > | ElementDataKeyTyped [get]
Get the key used to access the data populated by this element in the IFlowData. More...
|
Constructor & Destructor Documentation
Member Function Documentation
◆ ManagedResourcesCleanup()
| override void FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.SequenceElement.ManagedResourcesCleanup | ( | ) |
protected
virtual
Called when the element is disposed.
Implements FiftyOne.Pipeline.Core.FlowElements.FlowElementBase< IElementData, IElementPropertyMetaData >.
◆ ProcessInternal()
| override void FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.SequenceElement.ProcessInternal | ( | IFlowData | data | ) |
protected
Process method checks for presence of a session id and sequence number.
If they do not exist then they are initialized in evidence. If they do exist in evidence then the sequence number is incremented and added back to the evidence.
- Parameters
-
- data - The IFlowData instance to process.
- Exceptions
-
- ArgumentNullException - Thrown if the supplied data instance is null
◆ UnmanagedResourcesCleanup()
| override void FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.SequenceElement.UnmanagedResourcesCleanup | ( | ) |
protected
virtual
Called as part of object disposal.
This element has no unmanaged resources so this method is empty.
Implements FiftyOne.Pipeline.Core.FlowElements.FlowElementBase< IElementData, IElementPropertyMetaData >.
Member Data Documentation
◆ DEFAULT_ELEMENT_DATA_KEY
| const string FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.SequenceElement.DEFAULT_ELEMENT_DATA_KEY = "sequence" |
The default element data key that will be used for this element.
◆ ElementDataKey
| override string FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.SequenceElement.ElementDataKey => DEFAULT_ELEMENT_DATA_KEY |
The element data key.
◆ Properties
| override IList<IElementPropertyMetaData> FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.SequenceElement.Properties => _properties |
The properties populated by this element.
Property Documentation
◆ EvidenceKeyFilter
| override IEvidenceKeyFilter FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.SequenceElement.EvidenceKeyFilter |
get
The evidence key filter.