Isis Developer Reference
Isis::FilterCachingAlgorithm Class Reference

This algorithm is designed for applications that use ProcessByQuickFilter or very similar I/O patterns to cache cube data appropriately. More...

#include <FilterCachingAlgorithm.h>

Inheritance diagram for Isis::FilterCachingAlgorithm:
Inheritance graph
Collaboration diagram for Isis::FilterCachingAlgorithm:
Collaboration graph

Public Member Functions

 FilterCachingAlgorithm (int numParallelIOs)
 Construct a new FilterCachingAlgorithm.
 
virtual ~FilterCachingAlgorithm ()
 Frees the memory allocated by this caching algorithm.
 
virtual CacheResult recommendChunksToFree (QList< RawCubeChunk * > allocated, QList< RawCubeChunk * > justUsed, const Buffer &justRequested)
 Please see the class description for how this algorithm works.
 

Detailed Description

This algorithm is designed for applications that use ProcessByQuickFilter or very similar I/O patterns to cache cube data appropriately.

The last numParallelIOs worth of I/Os will be left in the cache.

Author
????-??-?? Jai Rideout and Steven Lambright

Constructor & Destructor Documentation

◆ FilterCachingAlgorithm()

Isis::FilterCachingAlgorithm::FilterCachingAlgorithm ( int numParallelIOs)

Construct a new FilterCachingAlgorithm.

The last numParallelIOs will be kept in the cache, while the other chunks in the cache will all be tossed.

Parameters
numParallelIOsThe number of IO operations to keep the chunks around for.

◆ ~FilterCachingAlgorithm()

Isis::FilterCachingAlgorithm::~FilterCachingAlgorithm ( )
virtual

Frees the memory allocated by this caching algorithm.

Member Function Documentation

◆ recommendChunksToFree()

CubeCachingAlgorithm::CacheResult Isis::FilterCachingAlgorithm::recommendChunksToFree ( QList< RawCubeChunk * > allocated,
QList< RawCubeChunk * > justUsed,
const Buffer & justRequested )
virtual

Please see the class description for how this algorithm works.

Parameters
allocatedAll of the allocated cube chunks
justUsedThe cube chunks used in the last I/O
justRequestedThe buffer passed into the last I/O
Returns
The chunks that should be removed from memory

Implements Isis::CubeCachingAlgorithm.


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