◆ OnPremiseAspectEngineBase()
FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBase< T, TMeta >.OnPremiseAspectEngineBase | ( | ILogger< AspectEngineBase< T, TMeta >> | logger, |
Func< IPipeline, FlowElementBase< T, TMeta >, T > | aspectDataFactory, | ||
string | tempDataFilePath | ||
) |
Constructor
- Parameters
-
- logger - The logger to use
- aspectDataFactory - The factory function to use when the engine creates an AspectDataBase instance.
- tempDataFilePath - The directory to use when storing temporary copies of the data file(s) used by this engine.
Member Function Documentation
◆ AddDataFile()
virtual void FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBase< T, TMeta >.AddDataFile ( IAspectEngineDataFile dataFile ) virtualAdd the specified data file to the engine.
- Parameters
-
- dataFile - The data file to add.
- Exceptions
-
- ArgumentNullException - Thrown if supplied data file is null.
Implements FiftyOne.Pipeline.Engines.FlowElements.IOnPremiseAspectEngine.
◆ GetDataFileMetaData()
IAspectEngineDataFile FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBase< T, TMeta >.GetDataFileMetaData ( string dataFileIdentifier = null
) Get the details of a specific data file used by this engine.
- Parameters
-
- dataFileIdentifier - The identifier of the data file to get meta data for. This parameter is ignored if the engine only has one data file.
- Returns
- The meta data associated with the specified data file. Returns null if the engine has no associated data files.
Implements FiftyOne.Pipeline.Engines.FlowElements.IOnPremiseAspectEngine.
◆ ManagedResourcesCleanup()
override void FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBase< T, TMeta >.ManagedResourcesCleanup ( ) protected virtualCalled when this instance is being disposed
Reimplemented from FiftyOne.Pipeline.Engines.FlowElements.AspectEngineBase< T, TMeta >.
◆ RefreshData() [1/2]
abstract void FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBase< T, TMeta >.RefreshData ( string dataFileIdentifier ) pure virtualCauses the engine to reload data from the file at IAspectEngineDataFile.DataFilePath for the data file matching the given identifier.
Implementors should consider thread-safety to ensure that parallel calls to 'Process' will resolve as normal.
- Parameters
-
- dataFileIdentifier - The identifier of the data file to update. Must match the value in IAspectEngineDataFile.Identifier. If the engine only has a single data file, this parameter is ignored. If null is passed then all data files should be refreshed.
Implements FiftyOne.Pipeline.Engines.FlowElements.IOnPremiseAspectEngine.
◆ RefreshData() [2/2]
abstract void FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBase< T, TMeta >.RefreshData ( string dataFileIdentifier, Stream data ) pure virtualCauses the engine to reload data from the supplied Stream for the file matching the given identifier.
Implementors should consider thread-safety to ensure that parallel calls to 'Process' will resolve as normal.
- Parameters
-
- dataFileIdentifier - The identifier of the data file to update. Must match the value in IAspectEngineDataFile.Identifier. If the engine only has a single data file, this parameter is ignored.
- data - A Stream containing the data to use when refreshing.
Implements FiftyOne.Pipeline.Engines.FlowElements.IOnPremiseAspectEngine.
Member Data Documentation
◆ DataFiles
IReadOnlyList<FiftyOne.Pipeline.Engines.FlowElements.IOnPremiseAspectEngine. ◆ RefreshData() [2/2]
abstract void FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBase< T, TMeta >.RefreshData ( string dataFileIdentifier, Stream data ) pure virtualCauses the engine to reload data from the supplied Stream for the file matching the given identifier.
Implementors should consider thread-safety to ensure that parallel calls to 'Process' will resolve as normal.
- Parameters
-
- dataFileIdentifier - The identifier of the data file to update. Must match the value in IAspectEngineDataFile.Identifier. If the engine only has a single data file, this parameter is ignored.
- data - A Stream containing the data to use when refreshing.
Implements FiftyOne.Pipeline.Engines.FlowElements.IOnPremiseAspectEngine.
Member Data Documentation
◆ DataFiles
IReadOnlyList<IAspectEngineDataFile> FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBase< T, TMeta >.DataFiles => _dataFiles Details of the data files used by this engine.
Property Documentation
◆ TempDataDirPath
string FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBase< T, TMeta >.TempDataDirPath get protected setDirectory to use as a temporary file location when required.