Files
ThirdParty-6/ParaView-5.0.1/VTK/Geovis/Core/vtkGeoTreeNodeCache.h

99 lines
3.2 KiB
C++

/*=========================================================================
Program: Visualization Toolkit
Module: vtkGeoTreeNodeCache.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/*-------------------------------------------------------------------------
Copyright 2008 Sandia Corporation.
Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------*/
// .NAME vtkGeoTreeNodeCache - Manages a list of vtkGeoTreeNodes.
//
// .SECTION Description
// vtkGeoTreeNodeCache keeps track of a linked list of vtkGeoTreeNodes,
// and has operations to move nodes to the front of the list and to
// delete data from the least used nodes. This is used to recover memory
// from nodes that store data that hasn't been used in a while.
#ifndef vtkGeoTreeNodeCache_h
#define vtkGeoTreeNodeCache_h
#include "vtkGeovisCoreModule.h" // For export macro
#include "vtkObject.h"
#include "vtkSmartPointer.h" // For SP ivars
class vtkGeoTreeNode;
class VTKGEOVISCORE_EXPORT vtkGeoTreeNodeCache : public vtkObject
{
public:
static vtkGeoTreeNodeCache *New();
vtkTypeMacro(vtkGeoTreeNodeCache,vtkObject);
virtual void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// The size of the cache of geospatial nodes.
// When the size reaches this limit, the list of non-empty
// nodes will be shortened to CacheMinimumLimit.
vtkSetMacro(CacheMaximumLimit, int);
vtkGetMacro(CacheMaximumLimit, int);
// Description:
// The cache is reduced to this size when the maximum limit is reached.
vtkSetMacro(CacheMinimumLimit, int);
vtkGetMacro(CacheMinimumLimit, int);
// Description:
// Send a node to the front of the list.
// Perform this whenever a node is accessed, so that the most
// recently accessed nodes' data are not deleted.
void SendToFront(vtkGeoTreeNode* node);
// Description:
// Remove the node from the list.
void RemoveNode(vtkGeoTreeNode* node);
// Description:
// The current size of the list.
vtkGetMacro(Size, int);
protected:
vtkGeoTreeNodeCache();
~vtkGeoTreeNodeCache();
// Description:
// Removes data from the oldest nodes and removes them from
// the list until the list is of size CacheSize.
void TrimToCacheMinimum();
// Description:
// Checks whether a node is the last of a set of siblings
// to be removed from the list. If so, deletes data from the
// node and all siblings.
void DeleteDataFromSiblings(vtkGeoTreeNode* node);
int Size;
int CacheMinimumLimit;
int CacheMaximumLimit;
//BTX
vtkSmartPointer<vtkGeoTreeNode> Newest;
vtkSmartPointer<vtkGeoTreeNode> Oldest;
//ETX
private:
vtkGeoTreeNodeCache(const vtkGeoTreeNodeCache&); // Not implemented
void operator=(const vtkGeoTreeNodeCache&); // Not implemented
};
#endif