vtkGeoTreeNodeCache Class Reference

#include <vtkGeoTreeNodeCache.h>

Inheritance diagram for vtkGeoTreeNodeCache:

Inheritance graph
[legend]
Collaboration diagram for vtkGeoTreeNodeCache:

Collaboration graph
[legend]

List of all members.


Detailed Description

Manages a list of vtkGeoTreeNodes.

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.

Definition at line 38 of file vtkGeoTreeNodeCache.h.


Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
void SendToFront (vtkGeoTreeNode *node)
void RemoveNode (vtkGeoTreeNode *node)
virtual void SetCacheMaximumLimit (int)
virtual int GetCacheMaximumLimit ()
virtual void SetCacheMinimumLimit (int)
virtual int GetCacheMinimumLimit ()
virtual int GetSize ()

Static Public Member Functions

static vtkGeoTreeNodeCacheNew ()
static int IsTypeOf (const char *type)
static vtkGeoTreeNodeCacheSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkGeoTreeNodeCache ()
 ~vtkGeoTreeNodeCache ()
void TrimToCacheMinimum ()
void DeleteDataFromSiblings (vtkGeoTreeNode *node)

Protected Attributes

int Size
int CacheMinimumLimit
int CacheMaximumLimit
vtkSmartPointer< vtkGeoTreeNodeNewest
vtkSmartPointer< vtkGeoTreeNodeOldest

Member Typedef Documentation

Reimplemented from vtkObject.

Definition at line 42 of file vtkGeoTreeNodeCache.h.


Constructor & Destructor Documentation

vtkGeoTreeNodeCache::vtkGeoTreeNodeCache (  )  [protected]

vtkGeoTreeNodeCache::~vtkGeoTreeNodeCache (  )  [protected]


Member Function Documentation

static vtkGeoTreeNodeCache* vtkGeoTreeNodeCache::New (  )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkGeoTreeNodeCache::GetClassName (  )  [virtual]

Reimplemented from vtkObject.

static int vtkGeoTreeNodeCache::IsTypeOf ( const char *  name  )  [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

virtual int vtkGeoTreeNodeCache::IsA ( const char *  name  )  [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

static vtkGeoTreeNodeCache* vtkGeoTreeNodeCache::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkObject.

virtual void vtkGeoTreeNodeCache::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

virtual void vtkGeoTreeNodeCache::SetCacheMaximumLimit ( int   )  [virtual]

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.

virtual int vtkGeoTreeNodeCache::GetCacheMaximumLimit (  )  [virtual]

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.

virtual void vtkGeoTreeNodeCache::SetCacheMinimumLimit ( int   )  [virtual]

The cache is reduced to this size when the maximum limit is reached.

virtual int vtkGeoTreeNodeCache::GetCacheMinimumLimit (  )  [virtual]

The cache is reduced to this size when the maximum limit is reached.

void vtkGeoTreeNodeCache::SendToFront ( vtkGeoTreeNode node  ) 

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 vtkGeoTreeNodeCache::RemoveNode ( vtkGeoTreeNode node  ) 

Remove the node from the list.

virtual int vtkGeoTreeNodeCache::GetSize (  )  [virtual]

The current size of the list.

void vtkGeoTreeNodeCache::TrimToCacheMinimum (  )  [protected]

Removes data from the oldest nodes and removes them from the list until the list is of size CacheSize.

void vtkGeoTreeNodeCache::DeleteDataFromSiblings ( vtkGeoTreeNode node  )  [protected]

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.


Member Data Documentation

int vtkGeoTreeNodeCache::Size [protected]

Definition at line 84 of file vtkGeoTreeNodeCache.h.

Definition at line 85 of file vtkGeoTreeNodeCache.h.

Definition at line 86 of file vtkGeoTreeNodeCache.h.

Definition at line 88 of file vtkGeoTreeNodeCache.h.

Definition at line 89 of file vtkGeoTreeNodeCache.h.


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

Generated on Wed Aug 24 11:38:09 2011 for VTK by  doxygen 1.5.6