◆ AspectEngineDataFile()
| FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile.AspectEngineDataFile | ( | Type | engineType = null
| ) |
Constructor
- Parameters
-
- engineType - The type of the engine that this data file is used by.
Member Function Documentation
◆ Dispose() [1/2]
virtual void FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile.Dispose ( bool disposing ) protected virtualDispose of this instance
- Parameters
-
- disposing - True if this is called from the Dispose method. False if this is called from the finalizer.
◆ Dispose() [2/2]
void FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile.Dispose ( ) Dispose of this instance's resources.
◆ SetDataUpdateService()
void FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile.SetDataUpdateService ( IDataUpdateService dataUpdateService ) Set the data update service that this data file is registered with.
- Parameters
-
- dataUpdateService - The data update service.
Implements FiftyOne.Pipeline.Engines.Data.IAspectEngineDataFile.
Member Data Documentation
◆ FormattedUrl
virtual string FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile.FormattedUrl => FormattedUri.AbsoluteUri Get the data update URL complete with any query string parameters that are needed to retrieve the data.
By default, no query string parameters are added to the URL.
Property Documentation
◆ AutomaticUpdatesEnabled
virtual bool FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile.AutomaticUpdatesEnabled getTrue if automatic updates are enabled, false otherwise.
◆ Configuration
IDataFileConfiguration FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile.Configuration get setThe configuration parameters used when creating this data file instance.
◆ DataFilePath
virtual string FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile.DataFilePath getThe complete file path to the location of the data file.
This value will be null if the file has been supplied from a byte[] in memory.
◆ DataPublishedDateTime
DateTime FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile.DataPublishedDateTime get setThe data/time that this data was published.
◆ Engine
IOnPremiseAspectEngine FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile.Engine get setGet or set the IOnPremiseAspectEngine associated with this data file.
◆ EngineType
Type FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile.EngineType getGet or set the type of the engine that this data file is for.
This exists in addition to the Engine property because Engine can be null. This then allows the user to identify which engine this file relates to.
◆ FormattedUri
virtual Uri FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile.FormattedUri getGet the data update URL complete with any query string parameters that are needed to retrieve the data.
By default, no query string parameters are added to the URL.
◆ Identifier
string FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile.Identifier get setThe name or identifier for this data file object.
Note that this is not the same as the filename. It is used by engines that require multiple data-files to determine what a given data file object relates to.
◆ IsRegistered
bool FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile.IsRegistered getReturns true if this file has been registered with the data update service.
False if not.
◆ TempDataDirPath
string FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile.TempDataDirPath get setThe path to use when working with temporary files associated with this data file.
◆ TempDataFilePath
virtual string FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile.TempDataFilePath get setThe complete file path to the location of the temporary copy of the data file that is currently being used by the IAspectEngine.
Engines often make a temporary copy of the data file in order to allow the original to be updated. This value will be null if the file is loaded entirely into memory.
◆ UpdateAvailableTime
DateTime FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile.UpdateAvailableTime get setThe date/time that a data update is expected to be available.