51Degrees Pipeline .NET: FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile Class Reference

Detailed Description

This class contains all configuration and run-time state information that is associated with a particular data file used by an aspect engine.

Inheritance diagram for FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile:

[legend]

Collaboration diagram for FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile:

[legend]

Public Member Functions

	AspectEngineDataFile () Constructor More...
void	SetDataUpdateService (IDataUpdateService dataUpdateService) Set the data update service that this data file is registered with. More...
void	Dispose ()

Protected Member Functions

virtual void Dispose (bool disposing)

Protected Attributes

IDataUpdateService

_dataUpdateService

The data update service that this engine is registered with (if any) More...

Properties

string Identifier [get, set]

IOnPremiseAspectEngine Engine [get, set]

virtual string DataFilePath [get]

The complete file path to the location of the data file. More...

string TempDataDirPath [get, set]

The path to use when working with temporary files associated with this data file. More...

virtual bool AutomaticUpdatesEnabled [get]

True if automatic updates are enabled, false otherwise. More...

virtual string TempDataFilePath [get, set]

The complete file path to the location of the temporary copy of the data file that is currently being used by the IAspectEngine. More...

DateTime UpdateAvailableTime [get, set]

Member Function Documentation

◆ 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

◆ _dataUpdateService

IDataUpdateService FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile._dataUpdateService

protected

The data update service that this engine is registered with (if any)

Property Documentation

◆ AutomaticUpdatesEnabled

virtual bool FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile.AutomaticUpdatesEnabled

get

True if automatic updates are enabled, false otherwise.

◆ DataFilePath

virtual string FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile.DataFilePath

get

The 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.

◆ FormattedUrl

virtual string FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile.FormattedUrl

get

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.

◆ IsRegistered

bool FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile.IsRegistered

get

Returns true if this file has been registered with the data update service.

False if not.

◆ TempDataDirPath

string FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile.TempDataDirPath

get set

The path to use when working with temporary files associated with this data file.

◆ TempDataFilePath

virtual string FiftyOne.Pipeline.Engines.Data.AspectEngineDataFile.TempDataFilePath