UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Types | Public Member Functions | Friends | List of all members
Chaos::TConstContainerItemHandle< T_CONTAINER, T_ITEM > Class Template Reference

#include <ContainerItemHandle.h>

+ Inheritance diagram for Chaos::TConstContainerItemHandle< T_CONTAINER, T_ITEM >:

Public Types

using FContainer = T_CONTAINER
 
using FItem = T_ITEM
 
using FHandle = TConstContainerItemHandle< FContainer, FItem >
 

Public Member Functions

 TConstContainerItemHandle ()
 
 TConstContainerItemHandle (const T_CONTAINER &InContainer, int InIndex)
 
const FItem * TryGet () const
 
const FItem & Get () const
 
const FItem * operator-> () const
 
const FItem & operator* () const
 
bool IsValid () const
 
void Reset ()
 
const FContainer * GetContainer () const
 
int GetIndex () const
 

Friends

bool operator== (const FHandle &L, const FHandle &R)
 
bool operator!= (const FHandle &L, const FHandle &R)
 
bool operator< (const FHandle &L, const FHandle &R)
 

Detailed Description

template<typename T_CONTAINER, typename T_ITEM>
class Chaos::TConstContainerItemHandle< T_CONTAINER, T_ITEM >

A handle to an item held by index in a container. The container must provide the following API: 

-   int NumItems() const;
  • bool IsValid(int32 Index) const;
  • FItem* TryGetItem(int32 Index);
  • const FItem* TryGetItem(int32 Index) const;
  • FItem& GetItem(int32 Index);
  • const FItem& GetItem(int32 Index) const;

Member Typedef Documentation

◆ FContainer

template<typename T_CONTAINER , typename T_ITEM >
using Chaos::TConstContainerItemHandle< T_CONTAINER, T_ITEM >::FContainer = T_CONTAINER

◆ FHandle

template<typename T_CONTAINER , typename T_ITEM >
using Chaos::TConstContainerItemHandle< T_CONTAINER, T_ITEM >::FHandle = TConstContainerItemHandle<FContainer, FItem>

◆ FItem

template<typename T_CONTAINER , typename T_ITEM >
using Chaos::TConstContainerItemHandle< T_CONTAINER, T_ITEM >::FItem = T_ITEM

Constructor & Destructor Documentation

◆ TConstContainerItemHandle() [1/2]

template<typename T_CONTAINER , typename T_ITEM >
Chaos::TConstContainerItemHandle< T_CONTAINER, T_ITEM >::TConstContainerItemHandle ( )
inline

◆ TConstContainerItemHandle() [2/2]

template<typename T_CONTAINER , typename T_ITEM >
Chaos::TConstContainerItemHandle< T_CONTAINER, T_ITEM >::TConstContainerItemHandle ( const T_CONTAINER &  InContainer,
int  InIndex 
)
inline

Member Function Documentation

◆ Get()

template<typename T_CONTAINER , typename T_ITEM >
const FItem & Chaos::TConstContainerItemHandle< T_CONTAINER, T_ITEM >::Get ( ) const
inline

◆ GetContainer()

template<typename T_CONTAINER , typename T_ITEM >
const FContainer * Chaos::TConstContainerItemHandle< T_CONTAINER, T_ITEM >::GetContainer ( ) const
inline

◆ GetIndex()

template<typename T_CONTAINER , typename T_ITEM >
int Chaos::TConstContainerItemHandle< T_CONTAINER, T_ITEM >::GetIndex ( ) const
inline

◆ IsValid()

template<typename T_CONTAINER , typename T_ITEM >
bool Chaos::TConstContainerItemHandle< T_CONTAINER, T_ITEM >::IsValid ( ) const
inline

◆ operator*()

template<typename T_CONTAINER , typename T_ITEM >
const FItem & Chaos::TConstContainerItemHandle< T_CONTAINER, T_ITEM >::operator* ( ) const
inline

◆ operator->()

template<typename T_CONTAINER , typename T_ITEM >
const FItem * Chaos::TConstContainerItemHandle< T_CONTAINER, T_ITEM >::operator-> ( ) const
inline

◆ Reset()

template<typename T_CONTAINER , typename T_ITEM >
void Chaos::TConstContainerItemHandle< T_CONTAINER, T_ITEM >::Reset ( )
inline

◆ TryGet()

template<typename T_CONTAINER , typename T_ITEM >
const FItem * Chaos::TConstContainerItemHandle< T_CONTAINER, T_ITEM >::TryGet ( ) const
inline

Friends And Related Symbol Documentation

◆ operator!=

template<typename T_CONTAINER , typename T_ITEM >
bool operator!= ( const FHandle &  L,
const FHandle &  R 
)
friend

◆ operator<

template<typename T_CONTAINER , typename T_ITEM >
bool operator< ( const FHandle &  L,
const FHandle &  R 
)
friend

◆ operator==

template<typename T_CONTAINER , typename T_ITEM >
bool operator== ( const FHandle &  L,
const FHandle &  R 
)
friend
The documentation for this class was generated from the following file: