USGS

Isis 3.0 Developer's Reference (API)

 Home

Isis::CubeCachingAlgorithm::CacheResult Class Reference

This stores the results of the caching algorithm. More...

#include <CubeCachingAlgorithm.h>

List of all members.

Public Member Functions

 CacheResult ()
 Construct a cache algorithm result with the idea that the algorithm did not understand/was unable to determine a good result for what to free.
 CacheResult (QList< RawCubeChunk * >)
 Construct a cache algorithm result with the idea that the algorithm did understand/was able to determine a good result for what to free.
 CacheResult (const CacheResult &other)
 Copy a CacheResult.
virtual ~CacheResult ()
 Free allocated memory.
bool algorithmUnderstoodData () const
 If this is true, then the results (be them empty or not) should be considered valid.
QList< RawCubeChunk * > getChunksToFree () const
CacheResult & operator= (const CacheResult &other)
 Assign one cache result to another.

Detailed Description

This stores the results of the caching algorithm.

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

Constructor & Destructor Documentation

Isis::CubeCachingAlgorithm::CacheResult::CacheResult (  ) 

Construct a cache algorithm result with the idea that the algorithm did not understand/was unable to determine a good result for what to free.

Isis::CubeCachingAlgorithm::CacheResult::CacheResult ( QList< RawCubeChunk * >  free  ) 

Construct a cache algorithm result with the idea that the algorithm did understand/was able to determine a good result for what to free.

The list may be empty. Typically, if your result uses this constructor, other algorithms will not be subsequently called.

Isis::CubeCachingAlgorithm::CacheResult::CacheResult ( const CacheResult &  other  ) 

Copy a CacheResult.

Parameters:
other The result we're copying into ourselves
Isis::CubeCachingAlgorithm::CacheResult::~CacheResult (  )  [virtual]

Free allocated memory.

Member Function Documentation

bool Isis::CubeCachingAlgorithm::CacheResult::algorithmUnderstoodData (  )  const

If this is true, then the results (be them empty or not) should be considered valid.

If this is false, then the results are empty and the caching algorithm failed.

Returns:
True if the recommendation is valid
QList< RawCubeChunk * > Isis::CubeCachingAlgorithm::CacheResult::getChunksToFree (  )  const
Returns:
list of RawCubeChunks to remove from RAM according to this caching algorithm. Valid if algorithmUnderstoodData() is true.
CubeCachingAlgorithm::CacheResult & Isis::CubeCachingAlgorithm::CacheResult::operator= ( const CacheResult &  other  ) 

Assign one cache result to another.

Parameters:
other The RHS of the assignment operator; the cache result we're copying from.
Returns:
A reference to *this
The documentation for this class was generated from the following files: