TTypedElementOwner

A representation of the owner of an element that includes its mutable handle data.

Choose your operating system:

Windows

macOS

Linux

References

Module

TypedElementFramework

Header

/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Framework/TypedElementHandle.h

Include

#include "Elements/Framework/TypedElementHandle.h"

Syntax

template<typename ElementDataType>
struct TTypedElementOwner

Remarks

A representation of the owner of an element that includes its mutable handle data. This type is returned when creating an element, and should be used to populate its internal payload data (if any). @note Owners do not auto-release on destruction, and must be manually destroyed via their owner element registry.

Constructors

Destructors

Name Description

Public function

~TTypedElementOwner()

Functions

Name Description

Public function Const

FTypedElemen...

 

AcquireHandle()

Acquire a copy of the handle that this element represents.

Public function Const

FTypedElemen...

 

AcquireId()

Acquire a copy of the ID that this element represents.

Public function Const

U *

 

GetData()

Attempt to access the mutable data stored within this owner, returning null if it isn't possible.

Public function Const

U &

 

GetDataChecked()

Attempt to access the mutable data stored within this owner, asserting if it isn't possible.

Public function Const

const FTyped...

 

GetId()

Get the ID that this element represents.

Public function Const

bool

 

IsSet()

Has this owner been initialized to a valid element?

Public function

void

 

Private_DestroyNoRef()

Public function

void

 

Private_DestroyReleaseRef()

Public function Const

const TTyped...

 

Private_GetInternalData()

Public function

void

 

Private_InitializeAddRef

(
    TTypedElementInternalData< ElementD...
)

Public function

void

 

Private_InitializeNoRef

(
    TTypedElementInternalData< ElementD...
)

Public function Const

void

 

ReleaseHandle

(
    FTypedElementHandle& InOutElementH...
)

Release a copy of the handle that this element represents.

Public function Const

void

 

ReleaseId

(
    FTypedElementId& InOutElementId
)

Release a copy of the ID that this element represents.

Operators

Name Description

Public function Const

 

operator bool()

Public function

TTypedElemen...

 

operator=

(
    TTypedElementOwner&& InOther
)

Public function

TTypedElemen...

 

operator=

(
    const TTypedElementOwner&
)