UE::Editor::DataStorage::FRowHandleArrayView Class Reference

#include <TypedElementRowHandleArrayView.h>

Public Types
enum class	EFlags { None = 0 , IsSorted = 1 << 0 , IsUnique = 1 << 1 }

Public Member Functions
	FRowHandleArrayView ()=default
TYPEDELEMENTFRAMEWORK_API	FRowHandleArrayView (const RowHandle *Rows UE_LIFETIMEBOUND, int32 RowCount, EFlags Flags)
TYPEDELEMENTFRAMEWORK_API	FRowHandleArrayView (TConstArrayView< RowHandle > Rows, EFlags Flags)
TYPEDELEMENTFRAMEWORK_API	FRowHandleArrayView (std::initializer_list< RowHandle > Rows UE_LIFETIMEBOUND, EFlags Flags)
TYPEDELEMENTFRAMEWORK_API const RowHandle *	begin () const
TYPEDELEMENTFRAMEWORK_API const RowHandle *	end () const
TYPEDELEMENTFRAMEWORK_API RowHandle	operator[] (uint32 Index) const
TYPEDELEMENTFRAMEWORK_API const RowHandle *	GetData () const
TYPEDELEMENTFRAMEWORK_API const RowHandle &	First () const
TYPEDELEMENTFRAMEWORK_API const RowHandle &	Last () const
TYPEDELEMENTFRAMEWORK_API int32	Num () const
TYPEDELEMENTFRAMEWORK_API int32	NumBytes () const
TYPEDELEMENTFRAMEWORK_API	operator TConstArrayView< RowHandle > () const
TYPEDELEMENTFRAMEWORK_API bool	IsSorted () const
TYPEDELEMENTFRAMEWORK_API bool	IsUnique () const
TYPEDELEMENTFRAMEWORK_API bool	IsEmpty () const
TYPEDELEMENTFRAMEWORK_API bool	Contains (RowHandle Row) const

Detailed Description

Provides a view of a list of row handles. Note that this view is more restrictive than typical array views. For instance, an typical array view would remain valid after changing values the array, but will invalidate FRowHandleArrayView as the value may not be unique and/or cause the array to no longer be sorted.

Member Enumeration Documentation

EFlags

enum class UE::Editor::DataStorage::FRowHandleArrayView::EFlags

strong

Enumerator
None
IsSorted
IsUnique

Constructor & Destructor Documentation

FRowHandleArrayView() [1/4]

UE::Editor::DataStorage::FRowHandleArrayView::FRowHandleArrayView ( )

default

FRowHandleArrayView() [2/4]

TYPEDELEMENTFRAMEWORK_API UE::Editor::DataStorage::FRowHandleArrayView::FRowHandleArrayView	(	const RowHandle *Rows	UE_LIFETIMEBOUND,
		int32	RowCount,
		EFlags	Flags
	)

FRowHandleArrayView() [3/4]

UE::Editor::DataStorage::FRowHandleArrayView::FRowHandleArrayView	(	TConstArrayView< RowHandle >	Rows,
		EFlags	Flags
	)

FRowHandleArrayView() [4/4]

UE::Editor::DataStorage::FRowHandleArrayView::FRowHandleArrayView	(	std::initializer_list< RowHandle > Rows	UE_LIFETIMEBOUND,
		EFlags	Flags
	)

Member Function Documentation

begin()

const RowHandle * UE::Editor::DataStorage::FRowHandleArrayView::begin

(

)

const

Returns a pointer to the first row in the view. This function is primarily used for compatibility to C++ features and libraries.

Contains()

bool UE::Editor::DataStorage::FRowHandleArrayView::Contains

(

RowHandle

Row

)

const

Whether or not the view contains the provided row. If the view is sorted a much binary search can be used for a much faster search otherwise a slower linear search is done.

end()

const RowHandle * UE::Editor::DataStorage::FRowHandleArrayView::end

(

)

const

Returns a pointer the address after the last row in the view. This function is primarily used for compatibility to C++ features and libraries.

First()

const RowHandle & UE::Editor::DataStorage::FRowHandleArrayView::First

(

)

const

If the view is not empty, this return the last row handle in the view. Calling this function on an empty view will cause an assert.

GetData()

const RowHandle * UE::Editor::DataStorage::FRowHandleArrayView::GetData

(

)

const

Returns the address of row handles in memory.

IsEmpty()

bool UE::Editor::DataStorage::FRowHandleArrayView::IsEmpty

(

)

const

Whether or not there are any values in the view.

IsSorted()

bool UE::Editor::DataStorage::FRowHandleArrayView::IsSorted

(

)

const

Whether or not the contained rows are numerically ordered from smallest to largest.

IsUnique()

bool UE::Editor::DataStorage::FRowHandleArrayView::IsUnique

(

)

const

Whether or all rows in the view only appear once.

Last()

const RowHandle & UE::Editor::DataStorage::FRowHandleArrayView::Last

(

)

const

If the view is not empty, this return the last row handle in the view. Calling this function on an empty view will cause an assert.

Num()

int32 UE::Editor::DataStorage::FRowHandleArrayView::Num

(

)

const

The number of rows this view shows.

NumBytes()

int32 UE::Editor::DataStorage::FRowHandleArrayView::NumBytes

(

)

const

Returns the total number of bytes that are in use by rows. This is may not be the total amount of memory in use by the container this view maps to.

operator TConstArrayView< RowHandle >()

UE::Editor::DataStorage::FRowHandleArrayView::operator TConstArrayView< RowHandle >

(

)

const

Conversion operator to allow the view to be transparently used in places where a immutable array view of row handles is required.

operator[]()

RowHandle UE::Editor::DataStorage::FRowHandleArrayView::operator[]

(

uint32

Index

)

const

Retrieves the row handle at the provided index or asserts if the index is out of bounds.

---

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

• Engine/Source/Runtime/TypedElementFramework/Public/Elements/Framework/TypedElementRowHandleArrayView.h
• Engine/Source/Runtime/TypedElementFramework/Private/Elements/Framework/TypedElementRowHandleArrayView.cpp