VTK  9.3.20240318
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkWeakPointerBase Class Reference

Non-templated superclass for vtkWeakPointer. More...

#include <vtkWeakPointerBase.h>

Inheritance diagram for vtkWeakPointerBase:
[legend]
Collaboration diagram for vtkWeakPointerBase:
[legend]

Classes

class  NoReference
 

Public Member Functions

 vtkWeakPointerBase () noexcept
 Initialize smart pointer to nullptr. More...
 
 vtkWeakPointerBase (vtkObjectBase *r)
 Initialize smart pointer to given object. More...
 
 vtkWeakPointerBase (const vtkWeakPointerBase &r)
 Copy r's data object into the new weak pointer. More...
 
 vtkWeakPointerBase (vtkWeakPointerBase &&r) noexcept
 Move r's object into the new weak pointer, setting r to nullptr. More...
 
 ~vtkWeakPointerBase ()
 Destroy smart pointer. More...
 
vtkObjectBaseGetPointer () const
 Get the contained pointer. More...
 
vtkWeakPointerBaseoperator= (vtkObjectBase *r)
 Assign object to reference. More...
 
vtkWeakPointerBaseoperator= (const vtkWeakPointerBase &r)
 Assign object to reference. More...
 
vtkWeakPointerBaseoperator= (vtkWeakPointerBase &&r) noexcept
 Assign object to reference. More...
 

Protected Member Functions

 vtkWeakPointerBase (vtkObjectBase *r, const NoReference &)
 

Protected Attributes

vtkObjectBaseObject
 

Friends

class vtkObjectBaseToWeakPointerBaseFriendship
 

Detailed Description

Non-templated superclass for vtkWeakPointer.

vtkWeakPointerBase holds a pointer to a vtkObjectBase or subclass instance, but it never affects the reference count of the vtkObjectBase. However, when the vtkObjectBase referred to is destroyed, the pointer gets initialized to nullptr, thus avoid dangling references.

Definition at line 22 of file vtkWeakPointerBase.h.

Constructor & Destructor Documentation

◆ vtkWeakPointerBase() [1/5]

vtkWeakPointerBase::vtkWeakPointerBase ( )
inlinenoexcept

Initialize smart pointer to nullptr.

Definition at line 28 of file vtkWeakPointerBase.h.

◆ vtkWeakPointerBase() [2/5]

vtkWeakPointerBase::vtkWeakPointerBase ( vtkObjectBase r)

Initialize smart pointer to given object.

◆ vtkWeakPointerBase() [3/5]

vtkWeakPointerBase::vtkWeakPointerBase ( const vtkWeakPointerBase r)

Copy r's data object into the new weak pointer.

◆ vtkWeakPointerBase() [4/5]

vtkWeakPointerBase::vtkWeakPointerBase ( vtkWeakPointerBase &&  r)
noexcept

Move r's object into the new weak pointer, setting r to nullptr.

◆ ~vtkWeakPointerBase()

vtkWeakPointerBase::~vtkWeakPointerBase ( )

Destroy smart pointer.

◆ vtkWeakPointerBase() [5/5]

vtkWeakPointerBase::vtkWeakPointerBase ( vtkObjectBase r,
const NoReference  
)
protected

Member Function Documentation

◆ operator=() [1/3]

vtkWeakPointerBase& vtkWeakPointerBase::operator= ( vtkObjectBase r)

Assign object to reference.

This removes any reference to an old object.

◆ operator=() [2/3]

vtkWeakPointerBase& vtkWeakPointerBase::operator= ( const vtkWeakPointerBase r)

Assign object to reference.

This removes any reference to an old object.

◆ operator=() [3/3]

vtkWeakPointerBase& vtkWeakPointerBase::operator= ( vtkWeakPointerBase &&  r)
noexcept

Assign object to reference.

This removes any reference to an old object.

◆ GetPointer()

vtkObjectBase* vtkWeakPointerBase::GetPointer ( ) const
inline

Get the contained pointer.

Definition at line 66 of file vtkWeakPointerBase.h.

Friends And Related Function Documentation

◆ vtkObjectBaseToWeakPointerBaseFriendship

friend class vtkObjectBaseToWeakPointerBaseFriendship
friend

Definition at line 74 of file vtkWeakPointerBase.h.

Member Data Documentation

◆ Object

vtkObjectBase* vtkWeakPointerBase::Object
protected

Definition at line 84 of file vtkWeakPointerBase.h.


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