Manages a list of vtkGeoTreeNodes. More...
#include <vtkGeoTreeNodeCache.h>
Inheritance diagram for vtkGeoTreeNodeCache:
Collaboration diagram for vtkGeoTreeNodeCache:
Public Types | |
| typedef vtkObject | Superclass |
Public Member Functions | |
| virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
| vtkGeoTreeNodeCache * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More... | |
| void | SendToFront (vtkGeoTreeNode *node) |
| Send a node to the front of the list. More... | |
| void | RemoveNode (vtkGeoTreeNode *node) |
| Remove the node from the list. More... | |
| virtual void | SetCacheMaximumLimit (int) |
| The size of the cache of geospatial nodes. More... | |
| virtual int | GetCacheMaximumLimit () |
| The size of the cache of geospatial nodes. More... | |
| virtual void | SetCacheMinimumLimit (int) |
| The cache is reduced to this size when the maximum limit is reached. More... | |
| virtual int | GetCacheMinimumLimit () |
| The cache is reduced to this size when the maximum limit is reached. More... | |
| virtual int | GetSize () |
| The current size of the list. More... | |
 Public Member Functions inherited from vtkObject | |
| vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
| virtual void | DebugOn () |
| Turn debugging output on. More... | |
| virtual void | DebugOff () |
| Turn debugging output off. More... | |
| bool | GetDebug () |
| Get the value of the debug flag. More... | |
| void | SetDebug (bool debugFlag) |
| Set the value of the debug flag. More... | |
| virtual void | Modified () |
| Update the modification time for this object. More... | |
| virtual vtkMTimeType | GetMTime () |
| Return this object's modified time. More... | |
| void | RemoveObserver (unsigned long tag) |
| void | RemoveObservers (unsigned long event) |
| void | RemoveObservers (const char *event) |
| void | RemoveAllObservers () |
| vtkTypeBool | HasObserver (unsigned long event) |
| vtkTypeBool | HasObserver (const char *event) |
| int | InvokeEvent (unsigned long event) |
| int | InvokeEvent (const char *event) |
| unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkCommand * | GetCommand (unsigned long tag) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObserver (vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
| template<class U , class T > | |
| unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| Allow user to set the AbortFlagOn() with the return value of the callback method. More... | |
| int | InvokeEvent (unsigned long event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More... | |
| int | InvokeEvent (const char *event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More... | |
| Public Member Functions inherited from vtkObjectBase | |
| const char * | GetClassName () const |
| Return the class name as a string. More... | |
| virtual void | Delete () |
| Delete a VTK object. More... | |
| virtual void | FastDelete () |
| Delete a reference to this object. More... | |
| void | InitializeObjectBase () |
| void | Print (ostream &os) |
| Print an object to an ostream. More... | |
| virtual void | Register (vtkObjectBase *o) |
| Increase the reference count (mark as used by another object). More... | |
| virtual void | UnRegister (vtkObjectBase *o) |
| Decrease the reference count (release by another object). More... | |
| int | GetReferenceCount () |
| Return the current reference count of this object. More... | |
| void | SetReferenceCount (int) |
| Sets the reference count. More... | |
| void | PrintRevisions (ostream &) |
| Legacy. More... | |
| virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
| virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
Static Public Member Functions | |
| static vtkGeoTreeNodeCache * | New () |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkGeoTreeNodeCache * | SafeDownCast (vtkObjectBase *o) |
| Static Public Member Functions inherited from vtkObject | |
| static vtkObject * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
| static void | BreakOnError () |
| This method is called when vtkErrorMacro executes. More... | |
| static void | SetGlobalWarningDisplay (int val) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static void | GlobalWarningDisplayOn () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static void | GlobalWarningDisplayOff () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static int | GetGlobalWarningDisplay () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| Static Public Member Functions inherited from vtkObjectBase | |
| static vtkTypeBool | IsTypeOf (const char *name) |
| Return 1 if this class type is the same type of (or a subclass of) the named class. More... | |
| static vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| vtkGeoTreeNodeCache () | |
| ~vtkGeoTreeNodeCache () override | |
| void | TrimToCacheMinimum () |
| Removes data from the oldest nodes and removes them from the list until the list is of size CacheSize. More... | |
| void | DeleteDataFromSiblings (vtkGeoTreeNode *node) |
| Checks whether a node is the last of a set of siblings to be removed from the list. More... | |
| Protected Member Functions inherited from vtkObject | |
| vtkObject () | |
| ~vtkObject () override | |
| void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
| void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
| void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
| These methods allow a command to exclusively grab all events. More... | |
| void | InternalReleaseFocus () |
| These methods allow a command to exclusively grab all events. More... | |
| 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 41 of file vtkGeoTreeNodeCache.h.
Member Typedef Documentation
Definition at line 45 of file vtkGeoTreeNodeCache.h.
Constructor & Destructor Documentation
|
protected |
|
overrideprotected |
Member Function Documentation
|
static |
|
static |
|
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 vtkObjectBase.
|
static |
|
protectedvirtual |
| vtkGeoTreeNodeCache* vtkGeoTreeNodeCache::NewInstance | ( | ) | const |
|
overridevirtual |
|
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 |
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 |
The cache is reduced to this size when the maximum limit is reached.
|
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 |
The current size of the list.
|
protected |
Removes data from the oldest nodes and removes them from the list until the list is of size CacheSize.
|
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
|
protected |
Definition at line 102 of file vtkGeoTreeNodeCache.h.
|
protected |
Definition at line 103 of file vtkGeoTreeNodeCache.h.
|
protected |
Definition at line 104 of file vtkGeoTreeNodeCache.h.
|
protected |
Definition at line 106 of file vtkGeoTreeNodeCache.h.
|
protected |
Definition at line 107 of file vtkGeoTreeNodeCache.h.
The documentation for this class was generated from the following file:
- /home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Geovis/Core/vtkGeoTreeNodeCache.h
