FCommonChain::FCommonCursor Struct Reference

Common chain cursor functionality. More...

#include <CommonChain.h>

Inheritance diagram for FCommonChain::FCommonCursor:

Collaboration diagram for FCommonChain::FCommonCursor:

Public Member Functions
const FCommonChain *	GetOwner () const
	Get the owning chain of the cursor.
int32	GetChainSlotIndex () const
	Get the global (chain-relative) index of the current slot.
bool	IsLimitReached () const
	Check if the iterating limit was reached.
bool	ShouldStop () const
	Check if the cursor should stop iterating.

Protected Member Functions
	FCommonCursor (const FCommonChain *const InOwner, const int32 InOffset=0, const int32 InLimit=TNumericLimits< int32 >::Max())
	Initialize a new cursor instance for a chain.
	FCommonCursor (FCommonCursor &&InCursor)
	Move-initialize a cursor.
	FCommonCursor (const FCommonCursor &InCursor)
	Copy-initialize a cursor.
	FCommonCursor ()
	Initialize a new invalid cursor.
virtual	~FCommonCursor ()
	Finalize the cursor.

Protected Attributes
const FCommonChain *	Owner = nullptr
	The owner of the cursor.
int32	Offset = 0
	The chain slot index offset to begin with.
int32	Limit = TNumericLimits<int32>::Max()
	The maximum number of slots to iterate by.
int32	SlotIndex = InvalidSlotIndex
	The current local slot index.
int32	SegmentIndex = InvalidSegmentIndex
	The index of the currently iterated chain segment.

Detailed Description

Common chain cursor functionality.

All cursors inherit from this class.

Constructor & Destructor Documentation

FCommonCursor() [1/4]

FCommonChain::FCommonCursor::FCommonCursor ( const FCommonChain *const  InOwner, const int32  InOffset = 0, const int32  InLimit = TNumericLimits<int32>::Max()  )

inlineprotected

Initialize a new cursor instance for a chain.

Parameters

InOwner	The owner of the cursor to iterate.
InOffset	The slot offset of the cursor to begin with.
InLimit	The maximum number of slots to iterate by.

FCommonCursor() [2/4]

FCommonChain::FCommonCursor::FCommonCursor ( FCommonCursor &&  InCursor )

inlineprotected

Move-initialize a cursor.

FCommonCursor() [3/4]

FCommonChain::FCommonCursor::FCommonCursor ( const FCommonCursor &  InCursor )

inlineprotected

Copy-initialize a cursor.

Parameters

InCursor

The original cursor to copy.

FCommonCursor() [4/4]

FCommonChain::FCommonCursor::FCommonCursor ( )

inlineprotected

Initialize a new invalid cursor.

~FCommonCursor()

virtual FCommonChain::FCommonCursor::~FCommonCursor ( )

inlineprotectedvirtual

Finalize the cursor.

Member Function Documentation

GetChainSlotIndex()

int32 FCommonChain::FCommonCursor::GetChainSlotIndex ( ) const

inline

Get the global (chain-relative) index of the current slot.

GetOwner()

const FCommonChain * FCommonChain::FCommonCursor::GetOwner ( ) const

inline

Get the owning chain of the cursor.

IsLimitReached()

bool FCommonChain::FCommonCursor::IsLimitReached ( ) const

inline

Check if the iterating limit was reached.

ShouldStop()

bool FCommonChain::FCommonCursor::ShouldStop ( ) const

inline

Check if the cursor should stop iterating.

Member Data Documentation

Limit

int32 FCommonChain::FCommonCursor::Limit = TNumericLimits<int32>::Max()

protected

The maximum number of slots to iterate by.

If the slot index is equal to or greater than this, the iterating should stop.

Offset

int32 FCommonChain::FCommonCursor::Offset = 0

protected

The chain slot index offset to begin with.

Owner

const FCommonChain* FCommonChain::FCommonCursor::Owner = nullptr

protected

The owner of the cursor.

The chain being iterated. If it's a non-null, the chain is being retained.

SegmentIndex

int32 FCommonChain::FCommonCursor::SegmentIndex = InvalidSegmentIndex

protected

The index of the currently iterated chain segment.

SlotIndex

int32 FCommonChain::FCommonCursor::SlotIndex = InvalidSlotIndex

protected

The current local slot index.

---

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

• CommonChain.h