TSPtrG

TSPtr is a convenience class - it wraps around a pointer to an object that is a subclass of [CSharedMix](API\Runtime\uLangCore\uLang\Common\Containers\CSharedMix) [or any class that has the methods: Reference() & Dereference()] and acts just like a regular pointer except that it automatically references and dereferences the object as needed.

API > API/Runtime > API/Runtime/uLangCore > API/Runtime/uLangCore/uLang > API/Runtime/uLangCore/uLang/Common > API/Runtime/uLangCore/uLang/Common/Containers

References

   
Module uLangCore
Header /Engine/Source/Runtime/Solaris/uLangCore/Public/uLang/Common/Containers/SharedPointer.h
Include #include "uLang/Common/Containers/SharedPointer.h"

Syntax

template<class ObjectType, bool AllowNull, class AllocatorType, typename... AllocatorArgsType>  
class TSPtrG

Remarks

TSPtr is a convenience class - it wraps around a pointer to an object that is a subclass of CSharedMix [or any class that has the methods: Reference() & Dereference()] and acts just like a regular pointer except that it automatically references and dereferences the object as needed. The AllocatorType must provide the methods void * Allocate(size_t) and void Deallocate(void *)

Variables

  Type Name Description
Protected variable AllocatorType _Allocator How to deallocate the object This allocator can be 0 in size
Protected variable ObjectType * _Object Pointer to original object.
Protected variable ReleaseFuncType _ReleaseFunc  

Constructors

  Type Name Description
Public function ULANG_FORCEINLINE

TSPtrG ( NullPtrType NullPtr
)

  
Public function ULANG_FORCEINLINE

TSPtrG ( const TSPtrG& Other
)

  
Public function ULANG_FORCEINLINE

TSPtrG ( const TSPtrG< OtherObjectType, OtherAllowNull, AllocatorType, AllocatorArgsType... >& Other
)

  
Public function ULANG_FORCEINLINE

TSPtrG ( TSPtrG&& Other
)

  
Public function ULANG_FORCEINLINE

TSPtrG ( TSPtrG< OtherObjectType, OtherAllowNull, AllocatorType, AllocatorArgsType... >&& Other
)

  
Protected function ULANG_FORCEINLINE

TSPtrG ( ObjectType* Object,
const AllocatorType& Allocator
)

  

Destructors

  Type Name Description
Public function ULANG_FORCEINLINE

~TSPtrG ()

  

Functions

  Type Name Description
Public function Const ULANG_FORCEINLINE const TSPtrG< OtherObjectType, AllowNull, AllocatorType, AllocatorArgsType... > &

As ()

  
Public function ULANG_FORCEINLINETSPtrG< OtherObjectType, AllowNull, AllocatorType, AllocatorArgsType... > &

As ()

  
Public function ULANG_FORCEINLINETSPtrG< ObjectType, false, AllocatorType, AllocatorArgsType... > &

AsRef ()

  
Public function ULANG_FORCEINLINETSPtrG< ObjectType, false, AllocatorType, AllocatorArgsType... >

AsRef ()

  
Public function Const ULANG_FORCEINLINE const TSPtrG< ObjectType, false, AllocatorType, AllocatorArgsType... > &

AsRef ()

  
Protected function ULANG_FORCEINLINETSPtrG &

AssignCopy ( const TSPtrG< OtherObjectType, OtherAllowNull, AllocatorType, AllocatorArgsType... >& Other
)

  
Protected function ULANG_FORCEINLINETSPtrG &

AssignMove ( TSPtrG< OtherObjectType, OtherAllowNull, AllocatorType, AllocatorArgsType... >&& Other
)

  
Protected function ULANG_FORCEINLINE void Set the release function pointer to a valid value.
Public function Const ULANG_FORCEINLINE ObjectType *

Get ()

  
Public function Const ULANG_FORCEINLINE const AllocatorType &  
Public function Const ULANG_FORCEINLINE bool

IsValid ()

  
Public function Static ULANG_FORCEINLINETSPtrG

New ( AllocatorArgsType&&... AllocatorArgs,
CtorArgsType&&... CtorArgs
)

  
Protected function ULANG_FORCEINLINE void

Release ()

 Let go of our object.
Public function ULANG_FORCEINLINE void

Reset ()

  
Public function ULANG_FORCEINLINETSPtrG &

SetNew ( CtorArgsType&&... CtorArgs
)

  

Operators

  Type Name Description
Public function Const ULANG_FORCEINLINE  
Public function ULANG_FORCEINLINE  
Public function Const ULANG_FORCEINLINE  
Public function Const ULANG_FORCEINLINE bool  
Public function Const ULANG_FORCEINLINE bool

operator!= ( OtherObjectType* Object
)

  
Public function Const ULANG_FORCEINLINE bool

operator!= ( const TSPtrG< OtherObjectType, OtherAllowNull, AllocatorType, AllocatorArgsType... >& Other
)

  
Public function Const ULANG_FORCEINLINE bool  
Public function Const ULANG_FORCEINLINE bool

operator!= ( const TSPtrG& Other
)

  
Public function Const ULANG_FORCEINLINE ObjectType &  
Public function Const ULANG_FORCEINLINE bool

operator< ( const TSPtrG& Other
)

  
Public function Const ULANG_FORCEINLINE bool

operator< ( const TSPtrG< OtherObjectType, OtherAllowNull, AllocatorType, AllocatorArgsType... >& Other
)

  
Public function Const ULANG_FORCEINLINE bool

operator< ( OtherObjectType* Object
)

  
Public function ULANG_FORCEINLINETSPtrG &

operator= ( TSPtrG< OtherObjectType, OtherAllowNull, AllocatorType, AllocatorArgsType... >&& Other
)

  
Public function ULANG_FORCEINLINETSPtrG &

operator= ( TSPtrG&& Other
)

  
Public function ULANG_FORCEINLINETSPtrG &

operator= ( const TSPtrG< OtherObjectType, OtherAllowNull, AllocatorType, AllocatorArgsType... >& Other
)

  
Public function ULANG_FORCEINLINETSPtrG &

operator= ( const TSPtrG& Other
)

  
Public function ULANG_FORCEINLINETSPtrG &  
Public function Const ULANG_FORCEINLINE bool  
Public function Const ULANG_FORCEINLINE bool

operator== ( const TSPtrG& Other
)

  
Public function Const ULANG_FORCEINLINE bool

operator== ( const TSPtrG< OtherObjectType, OtherAllowNull, AllocatorType, AllocatorArgsType... >& Other
)

  
Public function Const ULANG_FORCEINLINE bool

operator== ( OtherObjectType* Object
)

  
Public function Const ULANG_FORCEINLINE bool

operator> ( OtherObjectType* Object
)

  
Public function Const ULANG_FORCEINLINE bool

operator> ( const TSPtrG< OtherObjectType, OtherAllowNull, AllocatorType, AllocatorArgsType... >& Other
)

  
Public function Const ULANG_FORCEINLINE bool

operator> ( const TSPtrG& Other
)

  
Public function Const ULANG_FORCEINLINE ObjectType *  

Typedefs

Name Description
ReleaseFuncType Indirection to keep knowledge about ObjectType out of default constructor and destructor so that TSPtrG can be forward declared with an incomplete ObjectType argument The price we pay is 8 more bytes of memory, indirect function call on each release, and that we have to (re-)initialize this function pointer in all methods that can set the pointer to something non-null

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page