A wrapper for managed and unmanaged interface pointers. More...

#include <TOptInterfacePtr.h>

Public Types
typedef InterfaceType	Interface

typedef istd::TUniqueInterfacePtr< InterfaceType >	UniqueInterfacePtr

typedef istd::TSharedInterfacePtr< InterfaceType >	SharedInterfacePtr

Public Member Functions
	TOptInterfacePtr (TOptInterfacePtr &&) noexcept=default

TOptInterfacePtr &	operator= (TOptInterfacePtr &&) noexcept=default

	TOptInterfacePtr ()=default

	TOptInterfacePtr (Interface *unamangedPtr)=delete

	TOptInterfacePtr (SharedInterfacePtr managedPtr)

	TOptInterfacePtr (UniqueInterfacePtr &managedPtr)

void	SetUnmanagedPtr (Interface *ptr)

void	SetManagedPtr (SharedInterfacePtr managedPtr)

void	AdoptRawPtr (Interface *rawPtr)
	Adopts ownership of a raw pointer.The pointer must be allocated in a manner compatible with SharedInterfacePtr's deleter.

template<typename T >
bool	AdoptCastedRawPtr (T *rawPtr)

template<class T >
bool	SetCastedPtr (TSharedInterfacePtr< T > &source)

void	TakeOver (TOptInterfacePtr &ptr)

template<class T >
bool	TakeOver (TUniqueInterfacePtr< T > &source)

template<class T >
bool	TakeOver (TUniqueInterfacePtr< T > &&source)

bool	IsValid () const

bool	IsManaged () const

bool	IsUnmanaged () const

void	Reset ()

template<typename InterfaceCast = InterfaceType>
const InterfaceCast *	GetPtr () const

template<typename InterfaceCast = InterfaceType>
InterfaceCast *	GetPtr ()

const Interface *	operator-> () const

Interface *	operator-> ()

const Interface &	operator* () const

Interface &	operator* ()

	TOptInterfacePtr (const TOptInterfacePtr &ptr)
	Copy constructor.

TOptInterfacePtr &	operator= (const TOptInterfacePtr &ptr)
	Assign operator.

	operator bool () const noexcept

Static Public Member Functions
static TOptInterfacePtr	FromUnmanaged (InterfaceType *ptr)

Detailed Description

template<class InterfaceType>
class istd::TOptInterfacePtr< InterfaceType >

A wrapper for managed and unmanaged interface pointers.

TOptInterfacePtr is a versatile smart pointer that can hold either:

A managed pointer (TSharedInterfacePtr) that controls the lifetime of the object.
An unmanaged raw pointer (T*) that is non-owning and must be managed externally.

This is useful in scenarios where:

You need to store pointers that may or may not own the object.
APIs need to accept both owned and borrowed references.
Different code paths require different ownership semantics.

Key characteristics:

Dual mode: Can store either a managed (owned) or unmanaged (borrowed) pointer.
Safe conversion: Provides safe conversion from TUniqueInterfacePtr.
Query ownership: Can check if the pointer is managed or unmanaged.
Copy support: Can be copied (unmanaged) or shared (managed).

Template Parameters

InterfaceType The interface type to expose.

See also: TUniqueInterfacePtr, TSharedInterfacePtr

Example:

class MyClass
{
       istd::TOptInterfacePtr<IMyInterface> m_ptr;
 
public:
       // Accept owned pointer
       void SetOwned(istd::TSharedInterfacePtr<IMyInterface> ptr)
       {
              m_ptr.SetManagedPtr(ptr);
       }
 
       // Accept borrowed pointer
       void SetBorrowed(IMyInterface* ptr)
       {
              m_ptr.SetUnmanagedPtr(ptr);
       }
 
       // Check ownership
       bool IsOwner() const
       {
              return m_ptr.IsManaged();
       }
};

Definition at line 65 of file TOptInterfacePtr.h.

Member Typedef Documentation

◆ Interface

template<class InterfaceType >

typedef InterfaceType istd::TOptInterfacePtr< InterfaceType >::Interface

Definition at line 68 of file TOptInterfacePtr.h.

◆ SharedInterfacePtr

template<class InterfaceType >

typedef istd::TSharedInterfacePtr<InterfaceType> istd::TOptInterfacePtr< InterfaceType >::SharedInterfacePtr

Definition at line 70 of file TOptInterfacePtr.h.

◆ UniqueInterfacePtr

template<class InterfaceType >

typedef istd::TUniqueInterfacePtr<InterfaceType> istd::TOptInterfacePtr< InterfaceType >::UniqueInterfacePtr

Definition at line 69 of file TOptInterfacePtr.h.

Constructor & Destructor Documentation

◆ TOptInterfacePtr() [1/6]

template<class InterfaceType >

istd::TOptInterfacePtr< InterfaceType >::TOptInterfacePtr ( TOptInterfacePtr< InterfaceType > && )

defaultnoexcept

◆ TOptInterfacePtr() [2/6]

template<class InterfaceType >

istd::TOptInterfacePtr< InterfaceType >::TOptInterfacePtr ( )

default

◆ TOptInterfacePtr() [3/6]

template<class InterfaceType >

istd::TOptInterfacePtr< InterfaceType >::TOptInterfacePtr ( Interface * unamangedPtr )

delete

◆ TOptInterfacePtr() [4/6]

template<class InterfaceType >

istd::TOptInterfacePtr< InterfaceType >::TOptInterfacePtr ( SharedInterfacePtr managedPtr )

inlineexplicit

Definition at line 91 of file TOptInterfacePtr.h.

◆ TOptInterfacePtr() [5/6]

template<class InterfaceType >

istd::TOptInterfacePtr< InterfaceType >::TOptInterfacePtr ( UniqueInterfacePtr & managedPtr )

inlineexplicit

Definition at line 97 of file TOptInterfacePtr.h.

References istd::TSharedInterfacePtr< InterfaceType, RootIntefaceType >::FromUnique().

◆ TOptInterfacePtr() [6/6]

template<class InterfaceType >

istd::TOptInterfacePtr< InterfaceType >::TOptInterfacePtr ( const TOptInterfacePtr< InterfaceType > & ptr )

inline

Copy constructor.

Definition at line 356 of file TOptInterfacePtr.h.

Member Function Documentation

◆ AdoptCastedRawPtr()

template<class InterfaceType >

template<typename T >

bool istd::TOptInterfacePtr< InterfaceType >::AdoptCastedRawPtr ( T * rawPtr )

inline

Definition at line 138 of file TOptInterfacePtr.h.

References istd::TOptInterfacePtr< InterfaceType >::AdoptRawPtr(), and istd::TOptInterfacePtr< InterfaceType >::Reset().

◆ AdoptRawPtr()

template<class InterfaceType >

void istd::TOptInterfacePtr< InterfaceType >::AdoptRawPtr ( Interface * rawPtr )

inline

Adopts ownership of a raw pointer.The pointer must be allocated in a manner compatible with SharedInterfacePtr's deleter.

Do NOT pass stack pointers or memory owned elsewhere.

Definition at line 127 of file TOptInterfacePtr.h.

Referenced by istd::TOptInterfacePtr< InterfaceType >::AdoptCastedRawPtr().

◆ FromUnmanaged()

template<class InterfaceType >

static TOptInterfacePtr istd::TOptInterfacePtr< InterfaceType >::FromUnmanaged ( InterfaceType * ptr )

inlinestatic

Definition at line 81 of file TOptInterfacePtr.h.

References istd::TOptInterfacePtr< InterfaceType >::SetUnmanagedPtr().

◆ GetPtr() [1/2]

template<class InterfaceType >

template<typename InterfaceCast = InterfaceType>

InterfaceCast * istd::TOptInterfacePtr< InterfaceType >::GetPtr ( )

inline

Definition at line 297 of file TOptInterfacePtr.h.

References istd::TInterfacePtr< InterfaceType, PolymorphicPointerImpl >::GetPtr(), and istd::TInterfacePtr< InterfaceType, PolymorphicPointerImpl >::IsValid().

◆ GetPtr() [2/2]

template<class InterfaceType >

template<typename InterfaceCast = InterfaceType>

const InterfaceCast * istd::TOptInterfacePtr< InterfaceType >::GetPtr ( ) const

inline

Definition at line 272 of file TOptInterfacePtr.h.

References istd::TInterfacePtr< InterfaceType, PolymorphicPointerImpl >::GetPtr(), and istd::TInterfacePtr< InterfaceType, PolymorphicPointerImpl >::IsValid().

Referenced by istd::TOptInterfacePtr< InterfaceType >::operator*(), istd::TOptInterfacePtr< InterfaceType >::operator*(), istd::TOptInterfacePtr< InterfaceType >::operator->(), and istd::TOptInterfacePtr< InterfaceType >::operator->().

◆ IsManaged()

template<class InterfaceType >

bool istd::TOptInterfacePtr< InterfaceType >::IsManaged ( ) const

inline

Definition at line 251 of file TOptInterfacePtr.h.

References istd::TInterfacePtr< InterfaceType, PolymorphicPointerImpl >::IsValid().

◆ IsUnmanaged()

template<class InterfaceType >

bool istd::TOptInterfacePtr< InterfaceType >::IsUnmanaged ( ) const

inline

Definition at line 257 of file TOptInterfacePtr.h.

◆ IsValid()

template<class InterfaceType >

bool istd::TOptInterfacePtr< InterfaceType >::IsValid ( ) const

inline

Definition at line 245 of file TOptInterfacePtr.h.

References istd::TInterfacePtr< InterfaceType, PolymorphicPointerImpl >::IsValid().

Referenced by istd::TOptInterfacePtr< InterfaceType >::operator bool().

◆ operator bool()

template<class InterfaceType >

istd::TOptInterfacePtr< InterfaceType >::operator bool ( ) const

inlineexplicitnoexcept

Definition at line 377 of file TOptInterfacePtr.h.

References istd::TOptInterfacePtr< InterfaceType >::IsValid().

◆ operator*() [1/2]

template<class InterfaceType >

Interface & istd::TOptInterfacePtr< InterfaceType >::operator* ( )

inline

Definition at line 345 of file TOptInterfacePtr.h.

References istd::TOptInterfacePtr< InterfaceType >::GetPtr().

◆ operator*() [2/2]

template<class InterfaceType >

const Interface & istd::TOptInterfacePtr< InterfaceType >::operator* ( ) const

inline

Definition at line 337 of file TOptInterfacePtr.h.

References istd::TOptInterfacePtr< InterfaceType >::GetPtr().

◆ operator->() [1/2]

template<class InterfaceType >

Interface * istd::TOptInterfacePtr< InterfaceType >::operator-> ( )

inline

Definition at line 329 of file TOptInterfacePtr.h.

References istd::TOptInterfacePtr< InterfaceType >::GetPtr().

◆ operator->() [2/2]

template<class InterfaceType >

const Interface * istd::TOptInterfacePtr< InterfaceType >::operator-> ( ) const

inline

Definition at line 321 of file TOptInterfacePtr.h.

References istd::TOptInterfacePtr< InterfaceType >::GetPtr().

◆ operator=() [1/2]

template<class InterfaceType >

TOptInterfacePtr & istd::TOptInterfacePtr< InterfaceType >::operator= ( const TOptInterfacePtr< InterfaceType > & ptr )

inline

Assign operator.

Definition at line 367 of file TOptInterfacePtr.h.

◆ operator=() [2/2]

template<class InterfaceType >

TOptInterfacePtr & istd::TOptInterfacePtr< InterfaceType >::operator= ( TOptInterfacePtr< InterfaceType > && )

defaultnoexcept

◆ Reset()

template<class InterfaceType >

void istd::TOptInterfacePtr< InterfaceType >::Reset ( )

inline

Definition at line 263 of file TOptInterfacePtr.h.

References istd::TSharedInterfacePtr< InterfaceType, RootIntefaceType >::Reset().

Referenced by istd::TOptInterfacePtr< InterfaceType >::AdoptCastedRawPtr(), istd::TOptInterfacePtr< InterfaceType >::SetCastedPtr(), istd::TOptInterfacePtr< InterfaceType >::TakeOver(), and istd::TOptInterfacePtr< InterfaceType >::TakeOver().

◆ SetCastedPtr()

template<class InterfaceType >

template<class T >

bool istd::TOptInterfacePtr< InterfaceType >::SetCastedPtr ( TSharedInterfacePtr< T > & source )

inline

Definition at line 158 of file TOptInterfacePtr.h.

References istd::TInterfacePtr< InterfaceType, PolymorphicPointerImpl >::IsValid(), istd::TOptInterfacePtr< InterfaceType >::Reset(), and istd::TSharedInterfacePtr< InterfaceType, RootIntefaceType >::SetCastedPtr().

◆ SetManagedPtr()

template<class InterfaceType >

void istd::TOptInterfacePtr< InterfaceType >::SetManagedPtr ( SharedInterfacePtr managedPtr )

inline

Definition at line 113 of file TOptInterfacePtr.h.

◆ SetUnmanagedPtr()

template<class InterfaceType >

void istd::TOptInterfacePtr< InterfaceType >::SetUnmanagedPtr ( Interface * ptr )

inline

Definition at line 103 of file TOptInterfacePtr.h.

References istd::TSharedInterfacePtr< InterfaceType, RootIntefaceType >::Reset().

Referenced by istd::TOptInterfacePtr< InterfaceType >::FromUnmanaged().

◆ TakeOver() [1/3]

template<class InterfaceType >

void istd::TOptInterfacePtr< InterfaceType >::TakeOver ( TOptInterfacePtr< InterfaceType > & ptr )

inline

Definition at line 179 of file TOptInterfacePtr.h.

References istd::TSharedInterfacePtr< InterfaceType, RootIntefaceType >::Reset().

◆ TakeOver() [2/3]

template<class InterfaceType >

template<class T >

bool istd::TOptInterfacePtr< InterfaceType >::TakeOver ( TUniqueInterfacePtr< T > && source )

inline

Definition at line 220 of file TOptInterfacePtr.h.

References istd::TSharedInterfacePtr< InterfaceType, RootIntefaceType >::CreateFromUnique(), istd::TInterfacePtr< InterfaceType, PolymorphicPointerImpl >::IsValid(), and istd::TOptInterfacePtr< InterfaceType >::Reset().

◆ TakeOver() [3/3]

template<class InterfaceType >

template<class T >

bool istd::TOptInterfacePtr< InterfaceType >::TakeOver ( TUniqueInterfacePtr< T > & source )

inline

Definition at line 193 of file TOptInterfacePtr.h.

References istd::TSharedInterfacePtr< InterfaceType, RootIntefaceType >::CreateFromUnique(), istd::TInterfacePtr< InterfaceType, PolymorphicPointerImpl >::IsValid(), and istd::TOptInterfacePtr< InterfaceType >::Reset().

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

Acf/Include/istd/TOptInterfacePtr.h

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ Interface

◆ SharedInterfacePtr

◆ UniqueInterfacePtr

Constructor & Destructor Documentation

◆ TOptInterfacePtr() [1/6]

◆ TOptInterfacePtr() [2/6]

◆ TOptInterfacePtr() [3/6]

◆ TOptInterfacePtr() [4/6]

◆ TOptInterfacePtr() [5/6]

◆ TOptInterfacePtr() [6/6]

Member Function Documentation

◆ AdoptCastedRawPtr()

◆ AdoptRawPtr()

◆ FromUnmanaged()

◆ GetPtr() [1/2]

◆ GetPtr() [2/2]

◆ IsManaged()

◆ IsUnmanaged()

◆ IsValid()

◆ operator bool()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator->() [1/2]

◆ operator->() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Reset()

◆ SetCastedPtr()

◆ SetManagedPtr()

◆ SetUnmanagedPtr()

◆ TakeOver() [1/3]

◆ TakeOver() [2/3]

◆ TakeOver() [3/3]