#include <GraphicsDataCache.h>

Inheritance diagram for GraphicsDataCache< CacheElementType >:

Collaboration diagram for GraphicsDataCache< CacheElementType >:

Public Types
using	ElementFactory = std::function< std::unique_ptr< CacheElementType >()>

using	Initializer = std::function< bool(const GraphicsDataCacheKey &Key, CacheElementType &element)>

Public Member Functions
	GraphicsDataCache (const GraphicsDataCache &)=delete

GraphicsDataCache &	operator= (const GraphicsDataCache &)=delete

	GraphicsDataCache (double scaledSampleRate, ElementFactory elementFactory)

	~GraphicsDataCache () override

IteratorRange< GraphicsDataCacheIterator< CacheElementType > >	PerformLookup (const ZoomInfo &zoomInfo, double t0, double t1)

const CacheElementType *	PerformLookup (GraphicsDataCacheKey key)

void	setInitializer (Initializer initializer)

Public Member Functions inherited from GraphicsDataCacheBase
virtual	~GraphicsDataCacheBase ()=default

void	Invalidate ()
	Invalidate the cache content. More...

double	GetScaledSampleRate () const noexcept
	Returns the sample rate associated with cache. More...

void	UpdateViewportWidth (int64_t width) noexcept

int64_t	GetMaxViewportWidth () const noexcept

Protected Member Functions
virtual void	CheckCache (const ZoomInfo &, double, double)

virtual bool	InitializeElement (const GraphicsDataCacheKey &key, CacheElementType &element)

Protected Member Functions inherited from GraphicsDataCacheBase
	GraphicsDataCacheBase (double scaledSampleRate)

void	SetScaledSampleRate (double scaledSampleRate)

virtual GraphicsDataCacheElementBase *	CreateElement (const GraphicsDataCacheKey &key)=0
	Create a new Cache element. Implementation is responsible of the lifetime control. More...

virtual void	DisposeElement (GraphicsDataCacheElementBase *element)=0
	This method is called, when the cache element should be evicted. Implementation may not deallocate the object. More...

virtual bool	UpdateElement (const GraphicsDataCacheKey &key, GraphicsDataCacheElementBase &element)=0
	This method is called on all elements matching the request that are not complete (i. e. IsComplete if false). More...

BaseLookupResult	PerformBaseLookup (const ZoomInfo &zoomInfo, double t0, double t1)
	Perform a lookup inside the cache. This method modifies mLookup and invalidates any previous result. More...

const GraphicsDataCacheElementBase *	PerformBaseLookup (GraphicsDataCacheKey key)
	Perform a lookup for the given key. This method modifies mLookup and invalidates any previous result. More...

Private Member Functions
GraphicsDataCacheElementBase *	CreateElement (const GraphicsDataCacheKey &key) override
	Create a new Cache element. Implementation is responsible of the lifetime control. More...

void	DisposeElement (GraphicsDataCacheElementBase *element) override
	This method is called, when the cache element should be evicted. Implementation may not deallocate the object. More...

bool	UpdateElement (const GraphicsDataCacheKey &key, GraphicsDataCacheElementBase &element) override
	This method is called on all elements matching the request that are not complete (i. e. IsComplete if false). More...

Private Attributes
Initializer	mInitializer

ElementFactory	mElementFactory

std::deque< std::unique_ptr< CacheElementType > >	mCache

std::vector< CacheElementType * >	mFreeList

Additional Inherited Members
Static Public Attributes inherited from GraphicsDataCacheBase
static constexpr uint32_t	CacheElementWidth = 256

Protected Types inherited from GraphicsDataCacheBase
using	Lookup = std::vector< LookupElement >
	Cache lookup is a vector, with items sorted using Key. More...

Detailed Description

template<typename CacheElementType>
class GraphicsDataCache< CacheElementType >

Definition at line 231 of file GraphicsDataCache.h.

Member Typedef Documentation

◆ ElementFactory

template<typename CacheElementType >

using GraphicsDataCache< CacheElementType >::ElementFactory = std::function<std::unique_ptr<CacheElementType>()>

Definition at line 234 of file GraphicsDataCache.h.

◆ Initializer

template<typename CacheElementType >

using GraphicsDataCache< CacheElementType >::Initializer = std::function<bool(const GraphicsDataCacheKey& Key, CacheElementType& element)>

Definition at line 239 of file GraphicsDataCache.h.

Constructor & Destructor Documentation

◆ GraphicsDataCache() [1/2]

template<typename CacheElementType >

GraphicsDataCache< CacheElementType >::GraphicsDataCache ( const GraphicsDataCache< CacheElementType > & )

delete

◆ GraphicsDataCache() [2/2]

template<typename CacheElementType >

GraphicsDataCache< CacheElementType >::GraphicsDataCache	(	double	scaledSampleRate,
		ElementFactory	elementFactory
	)

inlineexplicit

Definition at line 241 of file GraphicsDataCache.h.

       : GraphicsDataCacheBase(scaledSampleRate), mElementFactory(std::move(elementFactory))
   {
   }

◆ ~GraphicsDataCache()

template<typename CacheElementType >

GraphicsDataCache< CacheElementType >::~GraphicsDataCache ( )

inlineoverride

Definition at line 246 of file GraphicsDataCache.h.

   {
      Invalidate();
   }

References GraphicsDataCacheBase::Invalidate().

Here is the call graph for this function:

Member Function Documentation

◆ CheckCache()

template<typename CacheElementType >

virtual void GraphicsDataCache< CacheElementType >::CheckCache	(	const ZoomInfo &	,
		double	,
		double
	)

inlineprotectedvirtual

Reimplemented in WaveBitmapCache.

Definition at line 273 of file GraphicsDataCache.h.

274 {

275 }

Referenced by GraphicsDataCache< CacheElementType >::PerformLookup().

Here is the caller graph for this function:

◆ CreateElement()

template<typename CacheElementType >

GraphicsDataCacheElementBase * GraphicsDataCache< CacheElementType >::CreateElement ( const GraphicsDataCacheKey & key )

inlineoverrideprivatevirtual

Create a new Cache element. Implementation is responsible of the lifetime control.

Implements GraphicsDataCacheBase.

Definition at line 299 of file GraphicsDataCache.h.

   {
      CacheElementType* element = nullptr;
 
      if (!mFreeList.empty())
      {
         element = mFreeList.back();
         mFreeList.pop_back();
      }
 
      if (element == nullptr)
      {
         mCache.push_back(std::move(mElementFactory()));
         element = mCache.back().get();
      }
 
      if (element == nullptr)
         return nullptr;
 
      if (mInitializer)
      {
         if (!mInitializer(key, *element))
         {
            DisposeElement(element);
            return nullptr;
         }
      }
      else if (!InitializeElement(key, *element))
      {
         DisposeElement(element);
         return nullptr;
      }
 
      return element;
   }

References GraphicsDataCache< CacheElementType >::DisposeElement(), GraphicsDataCache< CacheElementType >::InitializeElement(), key, GraphicsDataCache< CacheElementType >::mCache, GraphicsDataCache< CacheElementType >::mElementFactory, GraphicsDataCache< CacheElementType >::mFreeList, and GraphicsDataCache< CacheElementType >::mInitializer.

Here is the call graph for this function:

◆ DisposeElement()

template<typename CacheElementType >

void GraphicsDataCache< CacheElementType >::DisposeElement ( GraphicsDataCacheElementBase * element )

inlineoverrideprivatevirtual

This method is called, when the cache element should be evicted. Implementation may not deallocate the object.

Implements GraphicsDataCacheBase.

Definition at line 335 of file GraphicsDataCache.h.

   {
      if (element == nullptr)
         return;
 
      element->Dispose();
 
      mFreeList.push_back(static_cast<CacheElementType*>(element));
   }

References GraphicsDataCacheElementBase::Dispose(), and GraphicsDataCache< CacheElementType >::mFreeList.

Referenced by GraphicsDataCache< CacheElementType >::CreateElement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InitializeElement()

template<typename CacheElementType >

virtual bool GraphicsDataCache< CacheElementType >::InitializeElement	(	const GraphicsDataCacheKey &	key,
		CacheElementType &	element
	)

inlineprotectedvirtual

Reimplemented in WaveBitmapCache, and WaveDataCache.

Definition at line 278 of file GraphicsDataCache.h.

   {
      if constexpr (std::is_assignable_v<
                       CacheElementType, GraphicsDataCacheKey>)
      {
         element = key;
         return true;
      }
      else if constexpr (std::is_constructible_v<
                            CacheElementType, GraphicsDataCacheKey>)
      {
         element = CacheElementType(key);
         return true;
      }
      else
      {
         return false;
      }
   }

References key.

Referenced by GraphicsDataCache< CacheElementType >::CreateElement(), and GraphicsDataCache< CacheElementType >::UpdateElement().

Here is the caller graph for this function:

◆ operator=()

template<typename CacheElementType >

GraphicsDataCache & GraphicsDataCache< CacheElementType >::operator= ( const GraphicsDataCache< CacheElementType > & )

delete

◆ PerformLookup() [1/2]

template<typename CacheElementType >

IteratorRange< GraphicsDataCacheIterator< CacheElementType > > GraphicsDataCache< CacheElementType >::PerformLookup	(	const ZoomInfo &	zoomInfo,
		double	t0,
		double	t1
	)

inline

Definition at line 252 of file GraphicsDataCache.h.

   {
      CheckCache(zoomInfo, t0, t1);
 
      const auto base = this->PerformBaseLookup(zoomInfo, t0, t1);
 
      return { { base, true }, { base, false } };
   }

References GraphicsDataCache< CacheElementType >::CheckCache(), and GraphicsDataCacheBase::PerformBaseLookup().

Referenced by anonymous_namespace{GraphicsDataCacheTests.cpp}::CheckCacheElementLookup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PerformLookup() [2/2]

template<typename CacheElementType >

const CacheElementType * GraphicsDataCache< CacheElementType >::PerformLookup ( GraphicsDataCacheKey key )

inline

Definition at line 261 of file GraphicsDataCache.h.

   {
      return static_cast<const CacheElementType*>(PerformBaseLookup(key));
   }

References key, and GraphicsDataCacheBase::PerformBaseLookup().

Here is the call graph for this function:

◆ setInitializer()

template<typename CacheElementType >

void GraphicsDataCache< CacheElementType >::setInitializer ( Initializer initializer )

inline

Definition at line 266 of file GraphicsDataCache.h.

   {
      mInitializer = std::move(initializer);
   }

References Journal::Events::anonymous_namespace{JournalEvents.cpp}::initializer, and GraphicsDataCache< CacheElementType >::mInitializer.

◆ UpdateElement()

template<typename CacheElementType >

bool GraphicsDataCache< CacheElementType >::UpdateElement	(	const GraphicsDataCacheKey &	key,
		GraphicsDataCacheElementBase &	element
	)

inlineoverrideprivatevirtual

This method is called on all elements matching the request that are not complete (i. e. IsComplete if false).

Implements GraphicsDataCacheBase.

Definition at line 345 of file GraphicsDataCache.h.

   {
      return InitializeElement(key, static_cast<CacheElementType&>(element));
   }

References GraphicsDataCache< CacheElementType >::InitializeElement(), and key.

Here is the call graph for this function:

Member Data Documentation

◆ mCache

template<typename CacheElementType >

std::deque<std::unique_ptr<CacheElementType> > GraphicsDataCache< CacheElementType >::mCache

private

Definition at line 355 of file GraphicsDataCache.h.

Referenced by GraphicsDataCache< CacheElementType >::CreateElement().

◆ mElementFactory

template<typename CacheElementType >

ElementFactory GraphicsDataCache< CacheElementType >::mElementFactory

private

Definition at line 354 of file GraphicsDataCache.h.

Referenced by GraphicsDataCache< CacheElementType >::CreateElement().

◆ mFreeList

template<typename CacheElementType >

std::vector<CacheElementType*> GraphicsDataCache< CacheElementType >::mFreeList

private

Definition at line 356 of file GraphicsDataCache.h.

Referenced by GraphicsDataCache< CacheElementType >::CreateElement(), and GraphicsDataCache< CacheElementType >::DisposeElement().

◆ mInitializer

template<typename CacheElementType >

Initializer GraphicsDataCache< CacheElementType >::mInitializer

private

Definition at line 352 of file GraphicsDataCache.h.

Referenced by GraphicsDataCache< CacheElementType >::CreateElement(), and GraphicsDataCache< CacheElementType >::setInitializer().

The documentation for this class was generated from the following file:

GraphicsDataCache.h

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ElementFactory

◆ Initializer

Constructor & Destructor Documentation

◆ GraphicsDataCache() [1/2]

◆ GraphicsDataCache() [2/2]

◆ ~GraphicsDataCache()

Member Function Documentation

◆ CheckCache()

◆ CreateElement()

◆ DisposeElement()

◆ InitializeElement()

◆ operator=()

◆ PerformLookup() [1/2]

◆ PerformLookup() [2/2]

◆ setInitializer()

◆ UpdateElement()

Member Data Documentation

◆ mCache

◆ mElementFactory

◆ mFreeList

◆ mInitializer