FSimpleIndexedHandleBase Struct Reference

#include <IndexedHandle.h>

Inheritance diagram for FSimpleIndexedHandleBase:

Public Member Functions
	FSimpleIndexedHandleBase ()=default
	FSimpleIndexedHandleBase (int32 InIndex)
bool	operator== (const FSimpleIndexedHandleBase &Other) const
bool	operator!= (const FSimpleIndexedHandleBase &Other) const
int32	GetIndex () const
bool	IsValid () const
	operator bool () const
void	Invalidate ()
void	SetIndex (int32 InIndex)

Protected Attributes
int32	Index = INDEX_NONE

Friends
uint32	GetTypeHash (const FSimpleIndexedHandleBase &Handle)

Detailed Description

Index based handle that doesn't use a serial number. For fast access in to index based data structures when we don't expect handles to be able to be stale

Constructor & Destructor Documentation

FSimpleIndexedHandleBase() [1/2]

FSimpleIndexedHandleBase::FSimpleIndexedHandleBase ( )

default

FSimpleIndexedHandleBase() [2/2]

FSimpleIndexedHandleBase::FSimpleIndexedHandleBase ( int32  InIndex )

inline

Parameters

InIndex

- passing INDEX_NONE will make this handle Invalid

Member Function Documentation

GetIndex()

int32 FSimpleIndexedHandleBase::GetIndex ( ) const

inline

Returns

INDEX_NONE if invalid or >=0 for a potentially valid handle

Invalidate()

void FSimpleIndexedHandleBase::Invalidate ( )

inline

Makes the handle Invalid

IsValid()

bool FSimpleIndexedHandleBase::IsValid ( ) const

inline

Returns

true if this handle is valid, this doesn't check that it's in the correct range for the underlying resource it's providing a handle for

operator bool()

FSimpleIndexedHandleBase::operator bool ( ) const

inline

boolean operator useful when embedding declaration in if statement

Returns

same as IsValid()

See also

IsValid

operator!=()

bool FSimpleIndexedHandleBase::operator!= ( const FSimpleIndexedHandleBase &  Other ) const

inline

operator==()

bool FSimpleIndexedHandleBase::operator== ( const FSimpleIndexedHandleBase &  Other ) const

inline

SetIndex()

void FSimpleIndexedHandleBase::SetIndex ( int32  InIndex )

inline

Parameters

InIndex

- passing INDEX_NONE will make this handle Invalid

Friends And Related Symbol Documentation

GetTypeHash

uint32 GetTypeHash ( const FSimpleIndexedHandleBase &  Handle )

friend

Member Data Documentation

Index

int32 FSimpleIndexedHandleBase::Index = INDEX_NONE

protected

---

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

• Engine/Source/Runtime/AIModule/Public/IndexedHandle.h