Detailed Description

Abstract base class for caches that use IFlowData as the key.

Internally, the cache actually uses a DataKey instance derived from IFlowData.

Template Parameters: TValue - The type of data to store in the cache.

Inheritance diagram for FiftyOne.Pipeline.Engines.Caching.DataKeyedCacheBase< TValue >:

Collaboration diagram for FiftyOne.Pipeline.Engines.Caching.DataKeyedCacheBase< TValue >:

Public Member Functions

	DataKeyedCacheBase (CacheConfiguration configuration) Constructor More...
virtual void	Put (IFlowData data, TValue value) Add the specified data to the cache. More...
void	Dispose () IDisposable support More...

Protected Member Functions

abstract IEvidenceKeyFilter	GetFilter () Returns the IEvidenceKeyFilter to use when generating a key from IFlowData instances. More...
virtual void	Dispose (bool disposing) Dispose of this instance More...

Properties

virtual TValue

this[IFlowData data] [get]

Get the More...

Constructor & Destructor Documentation

◆ DataKeyedCacheBase()

FiftyOne.Pipeline.Engines.Caching.DataKeyedCacheBase< TValue >.DataKeyedCacheBase

(

CacheConfiguration

configuration

)

Constructor

Parameters: configuration - The cache configuration to use when creating the internal cache.

Member Function Documentation

◆ Dispose() [1/2]

void FiftyOne.Pipeline.Engines.Caching.DataKeyedCacheBase< TValue >.Dispose

(

)

IDisposable support

◆ Dispose() [2/2]

virtual void FiftyOne.Pipeline.Engines.Caching.DataKeyedCacheBase< TValue >.Dispose

(

bool

disposing

)

protected virtual

Dispose of this instance

Parameters: disposing - True if this is called from the Dispose method. False if it is called from the finalizer.

◆ GetFilter()

abstract IEvidenceKeyFilter FiftyOne.Pipeline.Engines.Caching.DataKeyedCacheBase< TValue >.GetFilter

(

)

protected pure virtual

Returns the IEvidenceKeyFilter to use when generating a key from IFlowData instances.

Only evidence values that the filter includes will be used to create the key.

Returns: An IEvidenceKeyFilter instance.

Implemented in FiftyOne.Pipeline.Engines.Caching.DefaultFlowCache.

◆ Put()

virtual void FiftyOne.Pipeline.Engines.Caching.DataKeyedCacheBase< TValue >.Put	(	IFlowData	data,
		TValue	value
	)

virtual

Add the specified data to the cache.

Parameters: data - The IFlowData to use as a key.; value - The
TValue
to store with the key.

Property Documentation

◆ this[IFlowData data]

virtual TValue FiftyOne.Pipeline.Engines.Caching.DataKeyedCacheBase< TValue >.this[IFlowData data]

get

Get the

TValue associated with the key generated from the supplied IFlowData instance.

Parameters: data - The IFlowData to use as a key.

Returns: If a matching item exists in the cache then the
TValue
is returned. If not, the default value is returned. (i.e. null for reference types, 0 for int, etc)

51Degrees Pipeline .NET 4.2Newer Version 4.3

FiftyOne.Pipeline.Engines.Caching.DataKeyedCacheBase< TValue > Class Template Reference abstract