◆ OnPremiseAspectEngineBuilderBase()
FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBuilderBase< TBuilder, TEngine >.OnPremiseAspectEngineBuilderBase | ( | IDataUpdateService | dataUpdateService | ) |
Constructor
- Parameters
-
- dataUpdateService - The IDataUpdateService instance to use when checking for data updates. If null is passed then data updates functionality will be unavailable.
Member Function Documentation
◆ AddDataFile()
TBuilder FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBuilderBase< TBuilder, TEngine >.AddDataFile ( IDataFileConfiguration configuration ) Add a data file for this engine to use.
- Parameters
-
- configuration - The data file configuration to add to this engine.
- Returns
- This engine builder instance.
◆ ConfigureEngine()
override void FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBuilderBase< TBuilder, TEngine >.ConfigureEngine ( TEngine engine ) protected virtualCalled by the 'BuildEngine' method to handle configuration of the engine after it is built.
Can be overridden by derived classes to add additional configuration, but the base method should always be called.
- Parameters
-
- engine - The engine to configure.
Reimplemented from FiftyOne.Pipeline.Engines.FlowElements.AspectEngineBuilderBase< TBuilder, TEngine >.
◆ NewAspectEngineDataFile()
virtual AspectEngineDataFile FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBuilderBase< TBuilder, TEngine >.NewAspectEngineDataFile ( ) protected virtualCreate a new instance of the AspectEngineDataFile instances used by the engine associated with this builder.
If the engine uses a derived type then this method should be overridden to return a new instance on that type.
- Returns
- A new AspectEngineDataFile instance.
Reimplemented in FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.FiftyOneOnPremiseAspectEngineBuilderBase< TBuilder, TEngine >.
◆ PreCreateEngine()
override void FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBuilderBase< TBuilder, TEngine >.PreCreateEngine ( ) protected virtualCalled by the 'BuildEngine' method to handle anything that needs doing before the engine is built.
Reimplemented from FiftyOne.Pipeline.Engines.FlowElements.AspectEngineBuilderBase< TBuilder, TEngine >.
◆ SetPerformanceProfile()
abstract TBuilder FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBuilderBase< TBuilder, TEngine >.SetPerformanceProfile ( PerformanceProfiles profile ) pure virtualSet the performance profile that the engine should use.
- Parameters
-
- profile -
- Returns
◆ SetTempDirPath()
TBuilder FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBuilderBase< TBuilder, TEngine >.SetTempDirPath ( string dirPath ) Set the temporary path to use when the engine needs to create temporary files.
(e.g. when downloading data updates) Default = Path.GetTempPath();
- Parameters
-
- dirPath - The full path to the temporary directory
- Returns
- This engine builder instance.
Property Documentation
◆ DataFileConfigs
List<IDataFileConfiguration> FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBuilderBase< TBuilder, TEngine >.DataFileConfigs = new List<IDataFileConfiguration>() get set protectedA list of the IDataFileConfiguration instances for all data files being supplied to the engine.
◆ DataFiles
List<AspectEngineDataFile> FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBuilderBase< TBuilder, TEngine >.DataFiles = new List<AspectEngineDataFile>() get set protectedUsed to store a temporary list of the data file meta data between their creation and the creation of the engine.
◆ TempDir
string FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBuilderBase< TBuilder, TEngine >.TempDir = Path.GetTempPath() get set protectedThe directory to use for temporary files when needed