|
| virtual vtkTypeBool | IsA (const char *type) |
| | Return 1 if this class is the same type of (or a subclass of) the named class.
|
| |
| vtkGarbageCollector * | NewInstance () const |
| |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| | Methods invoked by print to print information about the object including superclasses.
|
| |
| | vtkBaseTypeMacro (vtkObject, vtkObjectBase) |
| |
| virtual void | DebugOn () |
| | Turn debugging output on.
|
| |
| virtual void | DebugOff () |
| | Turn debugging output off.
|
| |
| bool | GetDebug () |
| | Get the value of the debug flag.
|
| |
| void | SetDebug (bool debugFlag) |
| | Set the value of the debug flag.
|
| |
| virtual void | Modified () |
| | Update the modification time for this object.
|
| |
| virtual vtkMTimeType | GetMTime () |
| | Return this object's modified time.
|
| |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| | Methods invoked by print to print information about the object including superclasses.
|
| |
| 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.
|
| |
| unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| |
| vtkCommand * | GetCommand (unsigned long tag) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| |
| void | RemoveObserver (vtkCommand *) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| |
| void | RemoveObservers (unsigned long event, vtkCommand *) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| |
| void | RemoveObservers (const char *event, vtkCommand *) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| |
| vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| |
| vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| |
| 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.
|
| |
| 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.
|
| |
| 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.
|
| |
| int | InvokeEvent (unsigned long event, void *callData) |
| | This method invokes an event and return whether the event was aborted or not.
|
| |
| int | InvokeEvent (const char *event, void *callData) |
| | This method invokes an event and return whether the event was aborted or not.
|
| |
| const char * | GetClassName () const |
| | Return the class name as a string.
|
| |
| virtual vtkTypeBool | IsA (const char *name) |
| | Return 1 if this class is the same type of (or a subclass of) the named class.
|
| |
| virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
| | Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
|
| |
| virtual void | Delete () |
| | Delete a VTK object.
|
| |
| virtual void | FastDelete () |
| | Delete a reference to this object.
|
| |
| void | InitializeObjectBase () |
| |
| void | Print (ostream &os) |
| | Print an object to an ostream.
|
| |
| virtual void | Register (vtkObjectBase *o) |
| | Increase the reference count (mark as used by another object).
|
| |
| virtual void | UnRegister (vtkObjectBase *o) |
| | Decrease the reference count (release by another object).
|
| |
| int | GetReferenceCount () |
| | Return the current reference count of this object.
|
| |
| void | SetReferenceCount (int) |
| | Sets the reference count.
|
| |
| bool | GetIsInMemkind () const |
| | A local state flag that remembers whether this object lives in the normal or extended memory space.
|
| |
| virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| | Methods invoked by print to print information about the object including superclasses.
|
| |
| virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| | Methods invoked by print to print information about the object including superclasses.
|
| |
|
| static vtkTypeBool | IsTypeOf (const char *type) |
| |
| static vtkGarbageCollector * | SafeDownCast (vtkObjectBase *o) |
| |
| static vtkGarbageCollector * | New () |
| |
| static void | Collect () |
| | Collect immediately using any objects whose collection was previously deferred as a root for the reference graph walk.
|
| |
| static void | Collect (vtkObjectBase *root) |
| | Collect immediately using the given object as the root for a reference graph walk.
|
| |
|
| static void | DeferredCollectionPush () |
| | Push/Pop whether to do deferred collection.
|
| |
| static void | DeferredCollectionPop () |
| | Push/Pop whether to do deferred collection.
|
| |
|
| static void | SetGlobalDebugFlag (bool flag) |
| | Set/Get global garbage collection debugging flag.
|
| |
| static bool | GetGlobalDebugFlag () |
| | Set/Get global garbage collection debugging flag.
|
| |
| static vtkObject * | New () |
| | Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
|
| |
| static void | BreakOnError () |
| | This method is called when vtkErrorMacro executes.
|
| |
| static void | SetGlobalWarningDisplay (int val) |
| | This is a global flag that controls whether any debug, warning or error messages are displayed.
|
| |
| static void | GlobalWarningDisplayOn () |
| | This is a global flag that controls whether any debug, warning or error messages are displayed.
|
| |
| static void | GlobalWarningDisplayOff () |
| | This is a global flag that controls whether any debug, warning or error messages are displayed.
|
| |
| static int | GetGlobalWarningDisplay () |
| | This is a global flag that controls whether any debug, warning or error messages are displayed.
|
| |
| static vtkTypeBool | IsTypeOf (const char *name) |
| | Return 1 if this class type is the same type of (or a subclass of) the named class.
|
| |
| static vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
| | Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
|
| |
| static vtkObjectBase * | New () |
| | Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
|
| |
| static void | SetMemkindDirectory (const char *directoryname) |
| | The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
|
| |
| static bool | GetUsingMemkind () |
| | A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
|
| |
Detect and break reference loops.
vtkGarbageCollector is used by VTK classes that may be involved in reference counting loops (such as Algorithm <-> Executive). It detects strongly connected components of the reference graph that have been leaked deletes them. The garbage collector uses the ReportReferences method to search the reference graph and construct a net reference count for each connected component. If the net reference count is zero the entire set of objects is deleted. Deleting each component may leak other components, which are then collected recursively.
To enable garbage collection for a class, add these members:
public:
{
}
{
}
protected:
{
}
Detect and break reference loops.
abstract base class for most VTK objects
virtual void UnRegister(vtkObjectBase *o)
Decrease the reference count (release by another object).
virtual void Register(vtkObjectBase *o)
Increase the reference count (mark as used by another object).
virtual void ReportReferences(vtkGarbageCollector *)
void UnRegisterInternal(vtkObjectBase *, vtkTypeBool check) override
void RegisterInternal(vtkObjectBase *, vtkTypeBool check) override
void VTKCOMMONCORE_EXPORT vtkGarbageCollectorReport(vtkGarbageCollector *collector, vtkSmartPointerBase &ptr, const char *desc)
Function to report a reference held by a smart pointer to a collector.
The implementations should be in the .cxx file in practice. It is important that the reference be reported using the real pointer or smart pointer instance that holds the reference. When collecting the garbage collector will actually set this pointer to nullptr. The destructor of the class should be written to deal with this. It is also expected that an invariant is maintained for any reference that is reported. The variable holding the reference must always either be nullptr or refer to a fully constructed valid object. Therefore code like "this->Object->UnRegister(this)" must be avoided if "this->Object" is a reported reference because it is possible that the object is deleted before UnRegister returns but then "this->Object" will be left as a dangling pointer. Instead use code like
so that the reported reference maintains the invariant.
If subclassing from a class that already supports garbage collection, one need only provide the ReportReferences method.
Definition at line 94 of file vtkGarbageCollector.h.
Public Member Functions inherited from vtkObject
1.9.6