Class for quick re-accessing of cubes based on file name. More...

#include <CubeManager.h>

Collaboration diagram for Isis::CubeManager:

Public Member Functions
	CubeManager ()
	This initializes a CubeManager object. More...

	~CubeManager ()
	This is the CubeManager destructor. More...

void	SetNumOpenCubes (unsigned int numCubes)
	This sets the maximum number of opened cubes for this instance of CubeManager. More...

void	CleanCubes (const QString &cubeFileName)
	This method removes a cube from memory, if it exists. More...

void	CleanCubes ()
	This method removes all cubes from memory. More...

Cube *	OpenCube (const QString &cubeFileName)
	This method opens a cube. More...

Static Public Member Functions
static Cube *	Open (const QString &cubeFileName)
	This method calls the method OpenCube() on the static instance. More...

static void	CleanUp (const QString &cubeFileName)
	This method calls CleanCubes(const QString &cubeFileName) on the static instance. More...

static void	CleanUp ()
	This method calls CleanCubes() on the static instance. More...

Protected Attributes
QMap< QString, Cube * >	p_cubes
	This keeps track of the open cubes. More...

QQueue< QString >	p_opened
	This keeps track of cubes that have been opened. More...

unsigned int	p_currentLimit
	The current limit regarding number of open files allowed. More...

unsigned int	p_maxOpenFiles
	60% of the maximum number of open files allowed by system resources More...

Static Protected Attributes
static CubeManager *	p_instance = 0
	There is always at least one instance of CubeManager around. More...

Detailed Description

Class for quick re-accessing of cubes based on file name.

This class holds cubes in static memory for reading. This is helpful to prevent reading of the same cube many times. Files will remain opened for reading, this is not for use with a cube that will ever be written to. You can either use the static methods of the class, in which case cubes will be cleaned up after IsisMain(...) is done executing, or you can instantiate the class for more control.

Author: 2008-05-20 Steven Lambright

Author: 2008-06-19 Steven Lambright - Added CleanUp methods

History:: 2008-08-19 Steven Koechle - Removed Geos includes

Author: 2009-02-12 Steven Lambright - Made the class available as an instance and not just statically. Added optional cube open limits.

History:: 2009-11-03 Mackenzie Boyd - Modified to include cube attributes (input) when opening cubes.

History:: 2011-06-08 Steven Lambright - Better handles the case when a Cube fails to open, fixes #161.

History:: 2015-07-15 Ian Humphrey - Added private member variable to store the max number files opened (60% of the system's limitations). Modified SetNumOpenCubes to set the maximum number of open cubes to 60% of the system's file limits if the passed value exceeds this 60% limitations. Modified OpenCube to always clean excess cubes. Updated unit test for better test coverage. Fixes #1951.

Definition at line 70 of file CubeManager.h.

Constructor & Destructor Documentation

◆ CubeManager()

Isis::CubeManager::CubeManager ( )

This initializes a CubeManager object.

Definition at line 28 of file CubeManager.cpp.

References CleanUp(), p_currentLimit, p_maxOpenFiles, and Isis::IException::Programmer.

◆ ~CubeManager()

Isis::CubeManager::~CubeManager ( )

This is the CubeManager destructor.

This method calls CleanCˇubes().

Definition at line 72 of file CubeManager.cpp.

References CleanCubes().

Member Function Documentation

◆ CleanCubes() [1/2]

void Isis::CubeManager::CleanCubes ( )

This method removes all cubes from memory.

All pointers returned via OpenCube will be NULL.

Definition at line 167 of file CubeManager.cpp.

References p_cubes.

Referenced by OpenCube(), and ~CubeManager().

◆ CleanCubes() [2/2]

void Isis::CubeManager::CleanCubes ( const QString & cubeFileName )

This method removes a cube from memory, if it exists.

If the cube is not loaded into memory, nothing happens. This will cause any pointers to this cube, obtained via OpenCube, to be NULL.

Parameters

cubeFileName The filename of the cube to remove from memory

Definition at line 148 of file CubeManager.cpp.

References p_cubes.

Referenced by Isis::ControlNetValidMeasure::~ControlNetValidMeasure().

◆ CleanUp() [1/2]

static void Isis::CubeManager::CleanUp ( )

inlinestatic

This method calls CleanCubes() on the static instance.

See also: CleanCubes

Definition at line 130 of file CubeManager.h.

Referenced by CubeManager().

◆ CleanUp() [2/2]

static void Isis::CubeManager::CleanUp ( const QString & cubeFileName )

inlinestatic

This method calls CleanCubes(const QString &cubeFileName) on the static instance.

See also: CleanCubes(const QString &cubeFileName)

Parameters

cubeFileName The filename of the cube to destroy from memory

Definition at line 120 of file CubeManager.h.

◆ Open()

static Cube* Isis::CubeManager::Open ( const QString & cubeFileName )

inlinestatic

This method calls the method OpenCube() on the static instance.

See also: OpenCube

Parameters

cubeFileName FileName of the cube to be opened

Returns: Cube* Pointer to the cube (guaranteed not null)

Definition at line 84 of file CubeManager.h.

Referenced by Isis::DemShape::DemShape().

◆ OpenCube()

Cube * Isis::CubeManager::OpenCube ( const QString & cubeFileName )

This method opens a cube.

If the cube is already opened, this method will return the cube from memory. The CubeManager class retains ownership of this cube pointer, so do not close the cube, destroy the pointer, or otherwise modify the cube object or pointer such that another object using them would fail. This method does not guarantee you are the only one with this pointer, nor is it recommended to keep this pointer out of a local (method) scope.

Note that this method will allow for 60% of the system's maximum file limit + 1 cubes to be opened, since the cube passed is opened and then cleanup follows. However, since our maximum limit is 60% of the system limit, this will allow enough room for this extra file to be opened before the cleanup occurs.

Parameters

cubeFileName The filename of the cube you wish to open

Returns: Cube* A pointer to the cube object that CubeManager retains ownership to and may delete at any time

Definition at line 95 of file CubeManager.cpp.

References Isis::CubeAttributeInput::bands(), CleanCubes(), Isis::FileName::expanded(), p_cubes, p_currentLimit, p_opened, and Isis::IString::ToQt().

Referenced by Isis::InterestOperator::FindCnetRef(), Isis::InterestOperator::FindOverlapByImageFootPrint(), Isis::ControlNetStatistics::GenerateImageStats(), Isis::InterestOperator::InterestByPoint(), and Isis::InterestOperator::ProcessLocked_Point_Reference().

◆ SetNumOpenCubes()

void Isis::CubeManager::SetNumOpenCubes ( unsigned int numCubes )

inline

This sets the maximum number of opened cubes for this instance of CubeManager.

The last "maxCubes" opened cubes are guaranteed to be valid as long as one of the CleanCubes(...) are not called. If the maximum number of open cubes specified exceeds 60% of system limitations, the maximum number of opened cubes will be set to a 60% of the system's open file limitation (this considers files used by the current process).

Parameters

numCubes Maximum number of open cubes

Definition at line 102 of file CubeManager.h.

Referenced by Isis::ControlNetStatistics::GenerateImageStats(), and Isis::ControlNetValidMeasure::ReadSerialNumbers().

Member Data Documentation

◆ p_cubes

QMap<QString, Cube *> Isis::CubeManager::p_cubes

protected

This keeps track of the open cubes.

Definition at line 145 of file CubeManager.h.

Referenced by CleanCubes(), and OpenCube().

◆ p_currentLimit

unsigned int Isis::CubeManager::p_currentLimit

protected

The current limit regarding number of open files allowed.

Definition at line 151 of file CubeManager.h.

Referenced by CubeManager(), and OpenCube().

◆ p_instance

CubeManager * Isis::CubeManager::p_instance = 0

staticprotected

There is always at least one instance of CubeManager around.

Definition at line 142 of file CubeManager.h.

◆ p_maxOpenFiles

unsigned int Isis::CubeManager::p_maxOpenFiles

protected

60% of the maximum number of open files allowed by system resources

Definition at line 154 of file CubeManager.h.

Referenced by CubeManager().

◆ p_opened

QQueue<QString> Isis::CubeManager::p_opened

protected

This keeps track of cubes that have been opened.

Definition at line 148 of file CubeManager.h.

Referenced by OpenCube().

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

src/base/objs/CubeManager/CubeManager.h
src/base/objs/CubeManager/CubeManager.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CubeManager()

◆ ~CubeManager()

Member Function Documentation

◆ CleanCubes() [1/2]

◆ CleanCubes() [2/2]

◆ CleanUp() [1/2]

◆ CleanUp() [2/2]

◆ Open()

◆ OpenCube()

◆ SetNumOpenCubes()

Member Data Documentation

◆ p_cubes

◆ p_currentLimit

◆ p_instance

◆ p_maxOpenFiles

◆ p_opened