51Degrees Pipeline .NET  4.1

51Degrees Pipeline for .NET

FiftyOne.Pipeline.Engines.FlowElements.IOnPremiseAspectEngine Interface Reference

Detailed Description

Interface for an AspectEngine that processes evidence using one or more local data files.

Inheritance diagram for FiftyOne.Pipeline.Engines.FlowElements.IOnPremiseAspectEngine:

[legend]

Collaboration diagram for FiftyOne.Pipeline.Engines.FlowElements.IOnPremiseAspectEngine:

[legend]

Public Member Functions

void  RefreshData (string dataFileIdentifier)
Causes the engine to reload data from the file at IAspectEngineDataFile.DataFilePath for the data file matching the given identifier. More...
void  RefreshData (string dataFileIdentifier, Stream data)
Causes the engine to reload data from the supplied Stream for the file matching the given identifier. More...
IAspectEngineDataFile  GetDataFileMetaData (string dataFileIdentifier=null)
Get the details of a specific data file used by this engine. More...
void  AddDataFile (IAspectEngineDataFile dataFile)
Add the specified data file to the engine. More...

Properties

IReadOnlyList< IAspectEngineDataFile >  DataFiles [get]
Details of the data files used by this engine. More...
string  TempDataDirPath [get]
The complete file path to the directory that is used by the engine to store temporary copies of any data files that it uses. More...

Member Function Documentation

◆ GetDataFileMetaData()

IAspectEngineDataFile FiftyOne.Pipeline.Engines.FlowElements.IOnPremiseAspectEngine.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.

Implemented in FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBase< T, TMeta >.

◆ RefreshData() [1/2]

void FiftyOne.Pipeline.Engines.FlowElements.IOnPremiseAspectEngine.RefreshData ( string   dataFileIdentifier )

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

Implemented in FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBase< T, TMeta >.

◆ RefreshData() [2/2]

void FiftyOne.Pipeline.Engines.FlowElements.IOnPremiseAspectEngine.RefreshData ( string   dataFileIdentifier,
Stream   data  
)

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

Implemented in FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBase< T, TMeta >.

Property Documentation

◆ DataFiles

IReadOnlyList<IAspectEngineDataFile> FiftyOne.Pipeline.Engines.FlowElements.IOnPremiseAspectEngine.DataFiles
get

Details of the data files used by this engine.

◆ TempDataDirPath

string FiftyOne.Pipeline.Engines.FlowElements.IOnPremiseAspectEngine.TempDataDirPath
get

The complete file path to the directory that is used by the engine to store temporary copies of any data files that it uses.