vtkGeoTreeNodeCache Class Reference

Manages a list of vtkGeoTreeNodes. More...

#include <vtkGeoTreeNodeCache.h>

Inheritance diagram for vtkGeoTreeNodeCache:

Collaboration diagram for vtkGeoTreeNodeCache:

Public Types
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkGeoTreeNodeCache *	NewInstance () const
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 ()
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkGeoTreeNodeCache *	New ()
static int	IsTypeOf (const char *type)
static vtkGeoTreeNodeCache *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkGeoTreeNodeCache ()
	~vtkGeoTreeNodeCache ()
void	TrimToCacheMinimum ()
void	DeleteDataFromSiblings (vtkGeoTreeNode *node)
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
int	Size
int	CacheMinimumLimit
int	CacheMaximumLimit
vtkSmartPointer< vtkGeoTreeNode >	Newest
vtkSmartPointer< vtkGeoTreeNode >	Oldest
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

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 39 of file vtkGeoTreeNodeCache.h.

Member Typedef Documentation

typedef vtkObject vtkGeoTreeNodeCache::Superclass

Definition at line 43 of file vtkGeoTreeNodeCache.h.

Constructor & Destructor Documentation

vtkGeoTreeNodeCache::vtkGeoTreeNodeCache ( )

protected

vtkGeoTreeNodeCache::~vtkGeoTreeNodeCache ( )

protected

Member Function Documentation

static vtkGeoTreeNodeCache* vtkGeoTreeNodeCache::New ( )

static

static int vtkGeoTreeNodeCache::IsTypeOf ( const char *  type )

static

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 ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkGeoTreeNodeCache::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkGeoTreeNodeCache* vtkGeoTreeNodeCache::NewInstance

(

)

const

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 85 of file vtkGeoTreeNodeCache.h.

int vtkGeoTreeNodeCache::CacheMinimumLimit

protected

Definition at line 86 of file vtkGeoTreeNodeCache.h.

int vtkGeoTreeNodeCache::CacheMaximumLimit

protected

Definition at line 87 of file vtkGeoTreeNodeCache.h.

vtkSmartPointer<vtkGeoTreeNode> vtkGeoTreeNodeCache::Newest

protected

Definition at line 89 of file vtkGeoTreeNodeCache.h.

vtkSmartPointer<vtkGeoTreeNode> vtkGeoTreeNodeCache::Oldest

protected

Definition at line 90 of file vtkGeoTreeNodeCache.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Geovis/Core/vtkGeoTreeNodeCache.h