A state of the chain iterating. More...

#include <Chain.h>

Inheritance diagram for TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >:

Collaboration diagram for TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >:

[legend]

Public Types
using	CursorSuper = FCommonCursor
	The base cursor type.

typedef TVariant< FEmptyVariantState, ChunkItType, BeltItType >	IteratorType
	The common iterator type.

Public Member Functions
constexpr int32	GetPartMappingSize () const
	Get the current size of the hinting mapping.

template<EParadigm RemappingParadigm = EParadigm::Safe>
int32	RemapPartIndex (const int32 PartIndex) const
	Remap a part index hint using the current mapping.

TCursor &	operator= (TCursor &&InCursor)
	Move a cursor.

TCursor &	operator= (const TCursor &InCursor)
	Copy a cursor.

const TChain *	GetOwner () const
	Get the owning chain of the cursor.

UClass *	GetIterableClass () const
	Get the target sequence class.

bool	IsViable () const
	Check if the cursor is viable and has not finished the iterating.

	operator bool () const
	Check if the cursor is viable.

void	Reset ()
	Detach the cursor from the chain making it an invalid one.

bool	Begin ()
	Begin iterating with the cursor using the current range.

bool	Begin (const int32 InOffset, const int32 InLimit=TNumericLimits< int32 >::Max())
	Begin iterating with the cursor using the supplied range.

bool	Advance ()
	Advance the iterator to the next slot.

bool	Provide ()
	Begin or advance iterating the chain using this cursor.

SubjectHandleType	GetSubject () const
	Get the subject of the current iteration.

SubjectivePtrType	GetSubjective () const
	Get the subjective of the current iteration of the cursor.

template<EParadigm Paradigm = DefaultParadigm, more::enable_if_t< IsUnsafe(Paradigm)\|\|AllowsDirectTraitAccess, int > = 0>
TOutcome< Paradigm, TTraitVoidPtrResult< Paradigm > >	GetTraitPtr (UScriptStruct *const TraitType) const
	Get a trait pointer of a certain type at the current cursor position.

template<EParadigm Paradigm, typename T , more::enable_if_t< IsUnsafe(Paradigm)\|\|AllowsDirectTraitAccess, int > = 0>
TOutcome< Paradigm, TTraitPtrResult< Paradigm, T > >	GetTraitPtr () const
	Get a trait pointer of a certain type.

template<typename T , EParadigm Paradigm = DefaultParadigm, more::enable_if_t< IsUnsafe(Paradigm)\|\|AllowsDirectTraitAccess, int > = 0>
TOutcome< Paradigm, TTraitPtrResult< Paradigm, T > >	GetTraitPtr () const
	Get a trait pointer of a certain type.

template<EParadigm Paradigm, typename T , more::enable_if_t< IsUnsafe(Paradigm)\|\|AllowsDirectTraitAccess, int > = 0>
TOutcome< Paradigm, TTraitRefResult< Paradigm, T > >	GetTraitRef () const
	Get a trait reference of a certain type.

template<typename T , EParadigm Paradigm = DefaultParadigm, more::enable_if_t< IsUnsafe(Paradigm)\|\|AllowsDirectTraitAccess, int > = 0>
TOutcome< Paradigm, TTraitRefResult< Paradigm, T > >	GetTraitRef () const
	Get a trait reference of a certain type.

template<EParadigm Paradigm, typename T >
TOutcome< Paradigm, T >	GetTrait () const
	Get a trait copy of a certain type.

template<typename T , EParadigm Paradigm = DefaultParadigm>
auto	GetTrait () const
	Get a trait copy of a certain type.

template<EParadigm Paradigm = DefaultParadigm>
TOutcome< Paradigm >	GetTrait (UScriptStruct const TraitType, void const OutTraitData, const bool bTraitDataInitialized=true) const
	Get a trait of a certain type.

template<EParadigm Paradigm, typename T >
TOutcome< Paradigm >	GetTrait (T &OutTraitData, const bool bTraitDataInitialized=true) const
	Get a trait of a certain type.

template<typename T , EParadigm Paradigm = DefaultParadigm>
auto	GetTrait (T &OutTraitData, const bool bTraitDataInitialized=true) const
	Get a trait of a certain type.

template<EParadigm Paradigm, typename T , int32 TraitLineIndex>
TOutcome< Paradigm, T >	TraitAtLine () const
	Get a copy of a trait of a certain type with an index hint.

template<EParadigm Paradigm, typename T , int32 TraitLineIndex, more::enable_if_t< IsUnsafe(Paradigm)\|\|AllowsDirectTraitAccess, int > = 0>
TOutcome< Paradigm, TTraitPtrResult< Paradigm, T > >	TraitPtrAtLine () const
	Get a pointer to a trait of a certain type with an index hint.

template<EParadigm Paradigm, typename T , int32 TraitLineIndex, more::enable_if_t< IsUnsafe(Paradigm)\|\|AllowsDirectTraitAccess, int > = 0>
TOutcome< Paradigm, TTraitRefResult< Paradigm, T > >	TraitRefAtLine () const
	Get a trait of a certain type with an index hint.

template<EParadigm Paradigm = DefaultParadigm, more::enable_if_t< IsUnsafe(Paradigm)\|\|AllowsDirectTraitAccess, int > = 0>
TOutcome< Paradigm, TTraitVoidPtrResult< Paradigm > >	GetTraitPtrHinted (UScriptStruct *const TraitType, const int32 TraitIndexHint) const
	Get a pointer to a trait of a certain type with an index hint.

template<EParadigm Paradigm, typename T , more::enable_if_t< IsUnsafe(Paradigm)\|\|AllowsDirectTraitAccess, int > = 0>
TOutcome< Paradigm, TTraitPtrResult< Paradigm, T > >	GetTraitPtrHinted (const int32 TraitIndexHint) const
	Get a pointer to a trait of a certain type with an index hint.

template<typename T , EParadigm Paradigm = DefaultParadigm, more::enable_if_t< IsUnsafe(Paradigm)\|\|AllowsDirectTraitAccess, int > = 0>
TOutcome< Paradigm, TTraitPtrResult< Paradigm, T > >	GetTraitPtrHinted (const int32 TraitIndexHint) const
	Get a pointer to a trait of a certain type with an index hint.

template<EParadigm Paradigm, typename T , more::enable_if_t< IsUnsafe(Paradigm)\|\|AllowsDirectTraitAccess, int > = 0>
TOutcome< Paradigm, TTraitRefResult< Paradigm, T > >	GetTraitRefHinted (const int32 TraitIndexHint) const
	Get a trait of a certain type with an index hint.

template<typename T , EParadigm Paradigm = DefaultParadigm, more::enable_if_t< IsUnsafe(Paradigm)\|\|AllowsDirectTraitAccess, int > = 0>
TOutcome< Paradigm, TTraitRefResult< Paradigm, T > >	GetTraitRefHinted (const int32 TraitIndexHint) const
	Get a trait of a certain type with an index hint.

template<EParadigm Paradigm, typename T >
TOutcome< Paradigm, T >	GetTraitHinted (const int32 TraitIndexHint) const
	Get a copy of a trait of a certain type with an index hint.

template<typename T , EParadigm Paradigm = DefaultParadigm>
TOutcome< Paradigm, T >	GetTraitHinted (const int32 TraitIndexHint) const
	Get a copy of a trait of a certain type with an index hint.

template<EParadigm Paradigm = DefaultParadigm>
TOutcome< Paradigm >	GetTraitHinted (UScriptStruct const TraitType, const int32 TraitIndexHint, void const OutTraitData, const bool bTraitDataInitialized=true) const
	Get a trait of a certain type with an index hint.

template<EParadigm Paradigm = DefaultParadigm, typename T = void>
TOutcome< Paradigm >	GetTraitHinted (const int32 TraitIndexHint, T &OutTraitData, const bool bTraitDataInitialized=true) const
	Get a trait of a certain type with an index hint.

template<EParadigm Paradigm = DefaultParadigm>
TOutcome< Paradigm, UDetail * >	GetDetailHinted (const TSubclassOf< UDetail > DetailClass, const int32 DetailIndexHint) const
	Get a detail of a certain class at an index hinted.

template<EParadigm Paradigm, class D , TDetailPtrResultSecurity< D > = 0>
TOutcome< Paradigm, TDetailPtrResult< D > >	GetDetailHinted (const int32 DetailIndexHint) const
	Get a detail of a certain class at an index hinted.

template<class D , EParadigm Paradigm = DefaultParadigm>
auto	GetDetailHinted (const int32 DetailIndexHint) const
	Get a detail of a certain class at an index hinted.

template<EParadigm Paradigm = DefaultParadigm, TDetailPtrResultSecurity< UDetail > = 0>
TOutcome< Paradigm, TDetailPtrResult< UDetail > >	GetDetail (const TSubclassOf< UDetail > DetailClass) const
	Get a detail of a certain class.

template<EParadigm Paradigm, class D , TDetailPtrResultSecurity< D > = 0>
TOutcome< Paradigm, TDetailPtrResult< D > >	GetDetail () const
	Get a detail of a certain class.

template<class D , EParadigm Paradigm = DefaultParadigm, TDetailPtrResultSecurity< D > = 0>
TOutcome< Paradigm, TDetailPtrResult< D > >	GetDetail () const
	Get a detail of a certain class.

template<EParadigm Paradigm = DefaultParadigm, TDetailPtrResultSecurity< UDetail > = 0>
TOutcome< Paradigm, TDetailPtrResult< UDetail > >	DetailAtLine (const int32 LineIndex) const
	Get a detail at a certain line index.

template<class P >
constexpr int32	IndexOfPart () const
	Find a hinting index for a part.

template<typename PartT >
PartT	GetPart () const
	Get a part (trait, detail, subject, other) of the current slot by its type.

template<typename PartT >
PartT	GetPartHinted (const int32 PartIndexHint) const
	Get a part (trait, detail, subject, other) of the current slot by its type with an index hint.

	TCursor (const TChain *const InOwner, const int32 InOffset=0, const int32 InLimit=TNumericLimits< int32 >::Max())
	Initialize a new cursor instance for a chain.

	TCursor (TCursor &&InCursor)
	Move-initialize a cursor.

	TCursor (const TCursor &InCursor)
	Copy-initialize a cursor.

template<typename ... OtherPs>
	TCursor (const TCursor< OtherPs... > &InCursor)
	Copy-initialize a cursor from an another cursor type.

	TCursor ()
	Initialize a new invalid cursor.

	~TCursor ()
	Finalize the cursor.

Public Member Functions inherited from FCommonChain::FCommonCursor
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.

Static Public Attributes
static constexpr auto	ChunkItIndex = IteratorType::template IndexOfType<ChunkItType>()
	The index of the chunk iterator within the variant type.

static constexpr auto	BeltItIndex = IteratorType::template IndexOfType<BeltItType>()
	The index of the belt iterator within the variant type.

Friends
template<typename... OtherPs>
struct	TCursor

Additional Inherited Members
Protected Member Functions inherited from FCommonChain::FCommonCursor
	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 inherited from FCommonChain::FCommonCursor
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

template<typename ChunkItT, typename BeltItT, EParadigm InDefaultParadigm>
template<typename... Ps>
struct TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >

A state of the chain iterating.

Cursors also unify the component hinting indices across different chunks/belts.

Template Parameters

Ps	The predefined types of parts to obtain efficiently while iterating.

Member Typedef Documentation

◆ CursorSuper

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

using TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::CursorSuper = FCommonCursor

The base cursor type.

◆ IteratorType

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

typedef TVariant<FEmptyVariantState, ChunkItType, BeltItType> TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::IteratorType

The common iterator type.

Constructor & Destructor Documentation

◆ TCursor() [1/5]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::TCursor	(	const TChain *const	InOwner,
		const int32	InOffset = `0`,
		const int32	InLimit = `TNumericLimits<int32>::Max()`
	)

inline

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.

◆ TCursor() [2/5]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::TCursor ( TCursor< Ps > && InCursor )

inline

Move-initialize a cursor.

◆ TCursor() [3/5]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::TCursor ( const TCursor< Ps > & InCursor )

inline

Copy-initialize a cursor.

Parameters

InCursor The original cursor to copy.

◆ TCursor() [4/5]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<typename ... OtherPs>

TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::TCursor ( const TCursor< OtherPs... > & InCursor )

inline

Copy-initialize a cursor from an another cursor type.

Parameters

InCursor The original cursor to copy.

◆ TCursor() [5/5]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::TCursor ( )

inline

Initialize a new invalid cursor.

◆ ~TCursor()

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::~TCursor ( )

inline

Finalize the cursor.

Member Function Documentation

◆ Advance()

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

bool TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::Advance ( )

inline

Advance the iterator to the next slot.

Returns: Does the next iteration makes sense?

◆ Begin() [1/2]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

bool TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::Begin ( )

inline

Begin iterating with the cursor using the current range.

Returns: Does the first iteration makes sense?

◆ Begin() [2/2]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

bool TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::Begin	(	const int32	InOffset,
		const int32	InLimit = `TNumericLimits<int32>::Max()`
	)

inline

Begin iterating with the cursor using the supplied range.

Parameters

InOffset	The slot offset to begin iterating with.
InLimit	The maximum number of slots to iterate by.

Returns: Does the first iteration makes sense?

◆ DetailAtLine()

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<EParadigm Paradigm = DefaultParadigm, TDetailPtrResultSecurity< UDetail > = 0>

TOutcome< Paradigm, TDetailPtrResult< UDetail > > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::DetailAtLine ( const int32 LineIndex ) const

inline

Get a detail at a certain line index.

Template Parameters

Paradigm The paradigm to work under.

Parameters

LineIndex The detail line index.

Returns: The detail at the specified index.

◆ GetDetail() [1/3]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<EParadigm Paradigm, class D , TDetailPtrResultSecurity< D > = 0>

TOutcome< Paradigm, TDetailPtrResult< D > > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetDetail ( ) const

inline

Get a detail of a certain class.

Statically typed version.

Template Parameters

Paradigm	The paradigm to work under.
D	The class of detail to get. May be a base class.

Returns: A pointer to the detail of the specified type.; nullptr If there is no such detail within the current iteration.

◆ GetDetail() [2/3]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<class D , EParadigm Paradigm = DefaultParadigm, TDetailPtrResultSecurity< D > = 0>

TOutcome< Paradigm, TDetailPtrResult< D > > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetDetail ( ) const

inline

Get a detail of a certain class.

Statically typed default paradigm version.

Template Parameters

D	The class of detail to get. May be a base class.
Paradigm	The paradigm to work under.

Returns: A pointer to the detail of the specified type.; nullptr If there is no such detail within the current iteration.

◆ GetDetail() [3/3]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<EParadigm Paradigm = DefaultParadigm, TDetailPtrResultSecurity< UDetail > = 0>

TOutcome< Paradigm, TDetailPtrResult< UDetail > > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetDetail ( const TSubclassOf< UDetail > DetailClass ) const

inline

Get a detail of a certain class.

Template Parameters

Paradigm The paradigm to work under.

Parameters

DetailClass The class of detail to get. May be a base class.

Returns: A pointer to the detail of the specified type.; nullptr If there is no such detail within the current iteration.

◆ GetDetailHinted() [1/3]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<EParadigm Paradigm, class D , TDetailPtrResultSecurity< D > = 0>

TOutcome< Paradigm, TDetailPtrResult< D > > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetDetailHinted ( const int32 DetailIndexHint ) const

inline

Get a detail of a certain class at an index hinted.

Templated version.

The detail index hint is relative to the parts pack or the detailmark of the filter.

Template Parameters

Paradigm	The paradigm to work under.
D	The class of the detail to get.

Parameters

DetailIndexHint The hinting detail index.

◆ GetDetailHinted() [2/3]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<class D , EParadigm Paradigm = DefaultParadigm>

auto TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetDetailHinted ( const int32 DetailIndexHint ) const

inline

Get a detail of a certain class at an index hinted.

Templated version.

The detail index hint is relative to the parts pack or the detailmark of the filter.

Template Parameters

D	The class of the detail to get.
Paradigm	The paradigm to work under.

Parameters

DetailIndexHint The hinting detail index.

◆ GetDetailHinted() [3/3]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<EParadigm Paradigm = DefaultParadigm>

TOutcome< Paradigm, UDetail * > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetDetailHinted	(	const TSubclassOf< UDetail >	DetailClass,
		const int32	DetailIndexHint
	)		const

inline

Get a detail of a certain class at an index hinted.

The detail index hint is relative to the parts pack or the detailmark of the filter.

Template Parameters

Paradigm The paradigm to work under.

Parameters

DetailClass	The class of the detail to get.
DetailIndexHint	The hinting detail index.

Returns: The detail of the specified class.

◆ GetIterableClass()

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

UClass * TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetIterableClass ( ) const

inline

Get the target sequence class.

◆ GetOwner()

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

const TChain * TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetOwner ( ) const

inline

Get the owning chain of the cursor.

◆ GetPart()

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<typename PartT >

PartT TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetPart ( ) const

inline

Get a part (trait, detail, subject, other) of the current slot by its type.

Templated version.

If the specified part type is also within the cursor's specified parts list, the method is performed using a fast hinting.

Template Parameters

PartT The type of the part to get. Can be a value. a reference or a pointer.

Returns: The part of the current slot in the designated type.

◆ GetPartHinted()

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<typename PartT >

PartT TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetPartHinted ( const int32 PartIndexHint ) const

inline

Get a part (trait, detail, subject, other) of the current slot by its type with an index hint.

Templated version.

Template Parameters

PartT The type of the part to get. Can be a value, a reference or a pointer.

Parameters

PartIndexHint A component index hint, corresponding to an index within the locking filter.

Returns: The part of the current slot in the designated type.

See also: GetPart()

◆ GetPartMappingSize()

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

constexpr int32 TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetPartMappingSize ( ) const

inlineconstexpr

Get the current size of the hinting mapping.

This size is dependent on what is actually used as a mapping basis, i.e. a template pack of parts or a current filter's traitmark/detailmark.

◆ GetSubject()

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

SubjectHandleType TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetSubject ( ) const

inline

Get the subject of the current iteration.

◆ GetSubjective()

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

SubjectivePtrType TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetSubjective ( ) const

inline

Get the subjective of the current iteration of the cursor.

Returns: The subjective at the current cursor position.

◆ GetTrait() [1/5]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<EParadigm Paradigm, typename T >

TOutcome< Paradigm, T > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetTrait ( ) const

inline

Get a trait copy of a certain type.

Template Parameters

Paradigm	The paradigm to work under.
T	The type of the trait to get.

Returns: A copy of the trait of the designated type.

◆ GetTrait() [2/5]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<typename T , EParadigm Paradigm = DefaultParadigm>

auto TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetTrait ( ) const

inline

Get a trait copy of a certain type.

Template Parameters

T	The type of the trait to get.
Paradigm	The paradigm to work under.

Returns: A copy of the trait of the designated type.

◆ GetTrait() [3/5]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<EParadigm Paradigm, typename T >

TOutcome< Paradigm > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetTrait	(	T &	OutTraitData,
		const bool	bTraitDataInitialized = `true`
	)		const

inline

Get a trait of a certain type.

Templated version.

◆ GetTrait() [4/5]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<typename T , EParadigm Paradigm = DefaultParadigm>

auto TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetTrait	(	T &	OutTraitData,
		const bool	bTraitDataInitialized = `true`
	)		const

inline

Get a trait of a certain type.

Templated version.

◆ GetTrait() [5/5]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<EParadigm Paradigm = DefaultParadigm>

TOutcome< Paradigm > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetTrait	(	UScriptStruct *const	TraitType,
		void *const	OutTraitData,
		const bool	bTraitDataInitialized = `true`
	)		const

inline

Get a trait of a certain type.

◆ GetTraitHinted() [1/4]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<EParadigm Paradigm, typename T >

TOutcome< Paradigm, T > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetTraitHinted ( const int32 TraitIndexHint ) const

inline

Get a copy of a trait of a certain type with an index hint.

The trait index hint is relative to the parts pack or the traitmark of the filter.

◆ GetTraitHinted() [2/4]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<typename T , EParadigm Paradigm = DefaultParadigm>

TOutcome< Paradigm, T > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetTraitHinted ( const int32 TraitIndexHint ) const

inline

Get a copy of a trait of a certain type with an index hint.

The trait index hint is relative to the parts pack or the traitmark of the filter.

◆ GetTraitHinted() [3/4]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<EParadigm Paradigm = DefaultParadigm, typename T = void>

TOutcome< Paradigm > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetTraitHinted	(	const int32	TraitIndexHint,
		T &	OutTraitData,
		const bool	bTraitDataInitialized = `true`
	)		const

inline

Get a trait of a certain type with an index hint.

Templated version.

The trait index hint is relative to the parts pack or the traitmark of the filter.

◆ GetTraitHinted() [4/4]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<EParadigm Paradigm = DefaultParadigm>

TOutcome< Paradigm > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetTraitHinted	(	UScriptStruct *const	TraitType,
		const int32	TraitIndexHint,
		void *const	OutTraitData,
		const bool	bTraitDataInitialized = `true`
	)		const

inline

Get a trait of a certain type with an index hint.

The trait index hint is relative to the parts pack or the traitmark of the filter.

◆ GetTraitPtr() [1/3]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<EParadigm Paradigm, typename T , more::enable_if_t< IsUnsafe(Paradigm)||AllowsDirectTraitAccess, int > = 0>

TOutcome< Paradigm, TTraitPtrResult< Paradigm, T > > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetTraitPtr ( ) const

inline

Get a trait pointer of a certain type.

Templated version.

Template Parameters

Paradigm	The security paradigm to use.
T	The type of the trait to get.

Returns: A pointer to the trait of the designated type.

◆ GetTraitPtr() [2/3]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<typename T , EParadigm Paradigm = DefaultParadigm, more::enable_if_t< IsUnsafe(Paradigm)||AllowsDirectTraitAccess, int > = 0>

TOutcome< Paradigm, TTraitPtrResult< Paradigm, T > > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetTraitPtr ( ) const

inline

Get a trait pointer of a certain type.

Templated version.

Template Parameters

T	The type of the trait to get.
Paradigm	The security paradigm to use.

Returns: A pointer to the trait of the designated type.

◆ GetTraitPtr() [3/3]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<EParadigm Paradigm = DefaultParadigm, more::enable_if_t< IsUnsafe(Paradigm)||AllowsDirectTraitAccess, int > = 0>

TOutcome< Paradigm, TTraitVoidPtrResult< Paradigm > > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetTraitPtr ( UScriptStruct *const TraitType ) const

inline

Get a trait pointer of a certain type at the current cursor position.

Template Parameters

Paradigm The security paradigm to use.

Returns: A pointer to the trait of the designated type.

◆ GetTraitPtrHinted() [1/3]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<EParadigm Paradigm, typename T , more::enable_if_t< IsUnsafe(Paradigm)||AllowsDirectTraitAccess, int > = 0>

TOutcome< Paradigm, TTraitPtrResult< Paradigm, T > > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetTraitPtrHinted ( const int32 TraitIndexHint ) const

inline

Get a pointer to a trait of a certain type with an index hint.

Templated version.

The trait index hint is relative to the parts pack or the traitmark of the filter.

◆ GetTraitPtrHinted() [2/3]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<typename T , EParadigm Paradigm = DefaultParadigm, more::enable_if_t< IsUnsafe(Paradigm)||AllowsDirectTraitAccess, int > = 0>

TOutcome< Paradigm, TTraitPtrResult< Paradigm, T > > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetTraitPtrHinted ( const int32 TraitIndexHint ) const

inline

Get a pointer to a trait of a certain type with an index hint.

Templated version.

The trait index hint is relative to the parts pack or the traitmark of the filter.

◆ GetTraitPtrHinted() [3/3]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<EParadigm Paradigm = DefaultParadigm, more::enable_if_t< IsUnsafe(Paradigm)||AllowsDirectTraitAccess, int > = 0>

TOutcome< Paradigm, TTraitVoidPtrResult< Paradigm > > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetTraitPtrHinted	(	UScriptStruct *const	TraitType,
		const int32	TraitIndexHint
	)		const

inline

Get a pointer to a trait of a certain type with an index hint.

The trait index hint is relative to the parts pack or the traitmark of the filter.

◆ GetTraitRef() [1/2]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<EParadigm Paradigm, typename T , more::enable_if_t< IsUnsafe(Paradigm)||AllowsDirectTraitAccess, int > = 0>

TOutcome< Paradigm, TTraitRefResult< Paradigm, T > > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetTraitRef ( ) const

inline

Get a trait reference of a certain type.

◆ GetTraitRef() [2/2]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<typename T , EParadigm Paradigm = DefaultParadigm, more::enable_if_t< IsUnsafe(Paradigm)||AllowsDirectTraitAccess, int > = 0>

TOutcome< Paradigm, TTraitRefResult< Paradigm, T > > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetTraitRef ( ) const

inline

Get a trait reference of a certain type.

◆ GetTraitRefHinted() [1/2]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<EParadigm Paradigm, typename T , more::enable_if_t< IsUnsafe(Paradigm)||AllowsDirectTraitAccess, int > = 0>

TOutcome< Paradigm, TTraitRefResult< Paradigm, T > > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetTraitRefHinted ( const int32 TraitIndexHint ) const

inline

Get a trait of a certain type with an index hint.

The trait index hint is relative to the parts pack or the traitmark of the filter.

◆ GetTraitRefHinted() [2/2]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<typename T , EParadigm Paradigm = DefaultParadigm, more::enable_if_t< IsUnsafe(Paradigm)||AllowsDirectTraitAccess, int > = 0>

TOutcome< Paradigm, TTraitRefResult< Paradigm, T > > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::GetTraitRefHinted ( const int32 TraitIndexHint ) const

inline

Get a trait of a certain type with an index hint.

The trait index hint is relative to the parts pack or the traitmark of the filter.

◆ IndexOfPart()

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<class P >

constexpr int32 TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::IndexOfPart ( ) const

inlineconstexpr

Find a hinting index for a part.

If there's a template part pack it will be used as a basis for the index. Otherwise, the current filter's traitmark/detailmark will be used instead.

Template Parameters

P	The class of the part to find an index of.

Returns: The index of the part or INDEX_NONE, if it was not found for hinting.

◆ IsViable()

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

bool TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::IsViable ( ) const

inline

Check if the cursor is viable and has not finished the iterating.

Returns: The state of examination.

◆ operator bool()

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::operator bool ( ) const

inline

Check if the cursor is viable.

◆ operator=() [1/2]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

TCursor & TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::operator= ( const TCursor< Ps > & InCursor )

inline

Copy a cursor.

◆ operator=() [2/2]

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

TCursor & TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::operator= ( TCursor< Ps > && InCursor )

inline

Move a cursor.

◆ Provide()

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

bool TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::Provide ( )

inline

Begin or advance iterating the chain using this cursor.

Returns: Is the iteration possible? Returns false if the iterating should be ended.

◆ RemapPartIndex()

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<EParadigm RemappingParadigm = EParadigm::Safe>

int32 TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::RemapPartIndex ( const int32 PartIndex ) const

inline

Remap a part index hint using the current mapping.

◆ Reset()

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

void TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::Reset ( )

inline

Detach the cursor from the chain making it an invalid one.

The cursor will also release its owning chain as/if needed.

◆ TraitAtLine()

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<EParadigm Paradigm, typename T , int32 TraitLineIndex>

TOutcome< Paradigm, T > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::TraitAtLine ( ) const

inline

Get a copy of a trait of a certain type with an index hint.

The trait index hint is relative to the parts pack or the traitmark of the filter.

◆ TraitPtrAtLine()

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<EParadigm Paradigm, typename T , int32 TraitLineIndex, more::enable_if_t< IsUnsafe(Paradigm)||AllowsDirectTraitAccess, int > = 0>

TOutcome< Paradigm, TTraitPtrResult< Paradigm, T > > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::TraitPtrAtLine ( ) const

inline

Get a pointer to a trait of a certain type with an index hint.

Templated version.

The trait index hint is relative to the parts pack or the traitmark of the filter.

◆ TraitRefAtLine()

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<EParadigm Paradigm, typename T , int32 TraitLineIndex, more::enable_if_t< IsUnsafe(Paradigm)||AllowsDirectTraitAccess, int > = 0>

TOutcome< Paradigm, TTraitRefResult< Paradigm, T > > TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::TraitRefAtLine ( ) const

inline

Get a trait of a certain type with an index hint.

The trait index hint is relative to the parts pack or the traitmark of the filter.

Friends And Related Function Documentation

◆ TCursor

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

template<typename... OtherPs>

friend struct TCursor

friend

Member Data Documentation

◆ BeltItIndex

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

constexpr auto TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::BeltItIndex = IteratorType::template IndexOfType<BeltItType>()

staticconstexpr

The index of the belt iterator within the variant type.

◆ ChunkItIndex

template<typename ChunkItT , typename BeltItT , EParadigm InDefaultParadigm>

template<typename... Ps>

constexpr auto TChain< ChunkItT, BeltItT, InDefaultParadigm >::TCursor< Ps >::ChunkItIndex = IteratorType::template IndexOfType<ChunkItType>()

staticconstexpr

The index of the chunk iterator within the variant type.

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

Chain.h

Public Types

Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ CursorSuper

◆ IteratorType

Constructor & Destructor Documentation

◆ TCursor() [1/5]

◆ TCursor() [2/5]

◆ TCursor() [3/5]

◆ TCursor() [4/5]

◆ TCursor() [5/5]

◆ ~TCursor()

Member Function Documentation

◆ Advance()

◆ Begin() [1/2]

◆ Begin() [2/2]

◆ DetailAtLine()

◆ GetDetail() [1/3]

◆ GetDetail() [2/3]

◆ GetDetail() [3/3]

◆ GetDetailHinted() [1/3]

◆ GetDetailHinted() [2/3]

◆ GetDetailHinted() [3/3]

◆ GetIterableClass()

◆ GetOwner()

◆ GetPart()

◆ GetPartHinted()

◆ GetPartMappingSize()

◆ GetSubject()

◆ GetSubjective()

◆ GetTrait() [1/5]

◆ GetTrait() [2/5]

◆ GetTrait() [3/5]

◆ GetTrait() [4/5]

◆ GetTrait() [5/5]

◆ GetTraitHinted() [1/4]

◆ GetTraitHinted() [2/4]

◆ GetTraitHinted() [3/4]

◆ GetTraitHinted() [4/4]

◆ GetTraitPtr() [1/3]

◆ GetTraitPtr() [2/3]

◆ GetTraitPtr() [3/3]

◆ GetTraitPtrHinted() [1/3]

◆ GetTraitPtrHinted() [2/3]

◆ GetTraitPtrHinted() [3/3]

◆ GetTraitRef() [1/2]

◆ GetTraitRef() [2/2]

◆ GetTraitRefHinted() [1/2]

◆ GetTraitRefHinted() [2/2]

◆ IndexOfPart()

◆ IsViable()

◆ operator bool()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Provide()

◆ RemapPartIndex()

◆ Reset()

◆ TraitAtLine()

◆ TraitPtrAtLine()

◆ TraitRefAtLine()

Friends And Related Function Documentation

◆ TCursor

Member Data Documentation

◆ BeltItIndex

◆ ChunkItIndex