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

This interface defines the global operations on the cache. It is used to control the memory usage of the cache. More...

#include <libCZI_Compositor.h>

Inheritance diagram for libCZI::ISubBlockCacheControl:
libCZI::ISubBlockCache

Classes

struct  PruneOptions
 

Public Member Functions

virtual void Prune (const PruneOptions &options)=0
 
 ISubBlockCacheControl (const ISubBlockCacheControl &)=delete
 
ISubBlockCacheControloperator= (const ISubBlockCacheControl &)=delete
 
 ISubBlockCacheControl (ISubBlockCacheControl &&) noexcept=delete
 
ISubBlockCacheControloperator= (ISubBlockCacheControl &&) noexcept=delete
 

Detailed Description

This interface defines the global operations on the cache. It is used to control the memory usage of the cache.

Member Function Documentation

◆ Prune()

virtual void libCZI::ISubBlockCacheControl::Prune ( const PruneOptions options)
pure virtual

Prunes the cache. This means that sub-blocks are removed from the cache until the cache satisfies the conditions given in the options. Note that the prune operation is not done automatically - it must be called manually. I.e. when adding an element to the cache, the cache is not pruned automatically.

Parameters
optionsOptions for controlling the operation.

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