libCZI
Reading and Writing CZI documents made easy
libCZI::ISubBlockCacheOperation Class Referenceabstract

This interface defines the operations of adding and querying an element to/from the cache. More...

#include <libCZI_Compositor.h>

Inheritance diagram for libCZI::ISubBlockCacheOperation:
libCZI::ISubBlockCache

Public Member Functions

virtual std::shared_ptr< IBitmapDataGet (int subblock_index)=0
 
virtual void Add (int subblock_index, std::shared_ptr< IBitmapData > pBitmap)=0
 
 ISubBlockCacheOperation (const ISubBlockCacheOperation &)=delete
 
ISubBlockCacheOperationoperator= (const ISubBlockCacheOperation &)=delete
 
 ISubBlockCacheOperation (ISubBlockCacheOperation &&) noexcept=delete
 
ISubBlockCacheOperationoperator= (ISubBlockCacheOperation &&) noexcept=delete
 

Detailed Description

This interface defines the operations of adding and querying an element to/from the cache.

Member Function Documentation

◆ Add()

virtual void libCZI::ISubBlockCacheOperation::Add ( int  subblock_index,
std::shared_ptr< IBitmapData pBitmap 
)
pure virtual

Adds the specified bitmap for the specified subblock_index to the cache. If the subblock is already in the cache, then it is overwritten.

Parameters
subblock_indexThe subblock index to add.
pBitmapThe bitmap.

◆ Get()

virtual std::shared_ptr<IBitmapData> libCZI::ISubBlockCacheOperation::Get ( int  subblock_index)
pure virtual

Gets the bitmap for the specified subblock-index. If the subblock is not in the cache, then a nullptr is returned.

Parameters
subblock_indexThe subblock index to get.
Returns
If the subblock is in the cache, then a std::shared_ptr<libCZI::IBitmapData> is returned. Otherwise a nullptr is returned.

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