UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
TSequenceHistory< HistorySize > Class Template Reference

#include <SequenceHistory.h>

Public Types

typedef uint32 WordT
 

Public Member Functions

 TSequenceHistory ()
 
void Reset ()
 
void AddDeliveryStatus (bool Delivered)
 
bool IsDelivered (SIZE_T Index) const
 
bool operator== (const TSequenceHistory &Other) const
 
bool operator!= (const TSequenceHistory &Other) const
 
void Write (FBitWriter &Writer, SIZE_T NumWords) const
 
void Read (FBitReader &Reader, SIZE_T NumWords)
 

Static Public Attributes

static constexpr SIZE_T BitsPerWord = sizeof(WordT) * 8
 
static constexpr SIZE_T WordCount = HistorySize / BitsPerWord
 
static constexpr SIZE_T MaxSizeInBits = WordCount * BitsPerWord
 
static constexpr SIZE_T Size = HistorySize
 

Detailed Description

template<SIZE_T HistorySize>
class TSequenceHistory< HistorySize >

Util class to manage history of received sequence numbers

Member Typedef Documentation

◆ WordT

template<SIZE_T HistorySize>
typedef uint32 TSequenceHistory< HistorySize >::WordT

Constructor & Destructor Documentation

◆ TSequenceHistory()

template<SIZE_T HistorySize>
TSequenceHistory< HistorySize >::TSequenceHistory ( )

Member Function Documentation

◆ AddDeliveryStatus()

template<SIZE_T HistorySize>
void TSequenceHistory< HistorySize >::AddDeliveryStatus ( bool  Delivered)

Store delivery status, oldest will be dropped

◆ IsDelivered()

template<SIZE_T HistorySize>
bool TSequenceHistory< HistorySize >::IsDelivered ( SIZE_T  Index) const

Query the status of a specific index, index 0 is last stored status

◆ operator!=()

template<SIZE_T HistorySize>
bool TSequenceHistory< HistorySize >::operator!= ( const TSequenceHistory< HistorySize > &  Other) const
inline

◆ operator==()

template<SIZE_T HistorySize>
bool TSequenceHistory< HistorySize >::operator== ( const TSequenceHistory< HistorySize > &  Other) const
inline

◆ Read()

template<SIZE_T HistorySize>
void TSequenceHistory< HistorySize >::Read ( FBitReader Reader,
SIZE_T  NumWords 
)

Read history from BitStream

◆ Reset()

template<SIZE_T HistorySize>
void TSequenceHistory< HistorySize >::Reset ( )

Reset

◆ Write()

template<SIZE_T HistorySize>
void TSequenceHistory< HistorySize >::Write ( FBitWriter Writer,
SIZE_T  NumWords 
) const

Write history to BitStream

Member Data Documentation

◆ BitsPerWord

template<SIZE_T HistorySize>
constexpr SIZE_T TSequenceHistory< HistorySize >::BitsPerWord = sizeof(WordT) * 8
staticconstexpr

◆ MaxSizeInBits

template<SIZE_T HistorySize>
constexpr SIZE_T TSequenceHistory< HistorySize >::MaxSizeInBits = WordCount * BitsPerWord
staticconstexpr

◆ Size

template<SIZE_T HistorySize>
constexpr SIZE_T TSequenceHistory< HistorySize >::Size = HistorySize
staticconstexpr

◆ WordCount

template<SIZE_T HistorySize>
constexpr SIZE_T TSequenceHistory< HistorySize >::WordCount = HistorySize / BitsPerWord
staticconstexpr

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