UE::Editor::DataStorage::Queries::FConditions Class Reference

#include <Conditions.h>

Public Types
using	ContainsCallback = TFunctionRef< bool(uint8_t ColumnIndex, TWeakObjectPtr< const UScriptStruct > Column)>

Public Member Functions
TYPEDELEMENTFRAMEWORK_API	FConditions ()
TYPEDELEMENTFRAMEWORK_API	FConditions (FColumnBase Column)
TYPEDELEMENTFRAMEWORK_API FConditions &	Compile (const IQueryConditionCompileContext &CompileContext)
TYPEDELEMENTFRAMEWORK_API bool	IsCompiled () const
TYPEDELEMENTFRAMEWORK_API void	AppendToString (FString &Output) const
TYPEDELEMENTFRAMEWORK_API bool	Verify (TConstArrayView< FColumnBase > AvailableColumns) const
TYPEDELEMENTFRAMEWORK_API bool	Verify (TArray< TWeakObjectPtr< const UScriptStruct > > &MatchedColumns, TConstArrayView< FColumnBase > AvailableColumns, bool AvailableColumnsAreSorted=false) const
TYPEDELEMENTFRAMEWORK_API bool	Verify (TConstArrayView< TWeakObjectPtr< const UScriptStruct > > AvailableColumns, bool AvailableColumnsAreSorted=false) const
TYPEDELEMENTFRAMEWORK_API bool	Verify (TArray< TWeakObjectPtr< const UScriptStruct > > &MatchedColumns, TConstArrayView< TWeakObjectPtr< const UScriptStruct > > AvailableColumns, bool AvailableColumnsAreSorted=false) const
TYPEDELEMENTFRAMEWORK_API bool	Verify (TSet< TWeakObjectPtr< const UScriptStruct > > AvailableColumns) const
TYPEDELEMENTFRAMEWORK_API bool	Verify (ContainsCallback Callback) const
TYPEDELEMENTFRAMEWORK_API uint8_t	MinimumColumnMatchRequired () const
TYPEDELEMENTFRAMEWORK_API TConstArrayView< TWeakObjectPtr< const UScriptStruct > >	GetColumns () const
TYPEDELEMENTFRAMEWORK_API bool	IsEmpty () const
TYPEDELEMENTFRAMEWORK_API bool	UsesDynamicTemplates () const
template<typename AvailableColumnType , typename ProjectionFunctionType >
bool	VerifyWithDynamicColumn (TConstArrayView< AvailableColumnType > AvailableColumns, uint64 &Matches, ProjectionFunctionType Projection) const

Friends
TYPEDELEMENTFRAMEWORK_API friend FConditions	operator&& (const FConditions &Lhs, FColumnBase Rhs)
TYPEDELEMENTFRAMEWORK_API friend FConditions	operator&& (const FConditions &Lhs, const FConditions &Rhs)
TYPEDELEMENTFRAMEWORK_API friend FConditions	operator&& (FColumnBase Lhs, FColumnBase Rhs)
TYPEDELEMENTFRAMEWORK_API friend FConditions	operator&& (FColumnBase Lhs, const FConditions &Rhs)
TYPEDELEMENTFRAMEWORK_API friend FConditions	operator|| (const FConditions &Lhs, FColumnBase Rhs)
TYPEDELEMENTFRAMEWORK_API friend FConditions	operator|| (const FConditions &Lhs, const FConditions &Rhs)
TYPEDELEMENTFRAMEWORK_API friend FConditions	operator|| (FColumnBase Lhs, FColumnBase Rhs)
TYPEDELEMENTFRAMEWORK_API friend FConditions	operator|| (FColumnBase Lhs, const FConditions &Rhs)

Detailed Description

Product of boolean combination of multiple columns. This can be used to verify if a collection of columns match the stored columns. NOTE: You must call Compile() before you call any members accessing the conditions

Member Typedef Documentation

ContainsCallback

using UE::Editor::DataStorage::Queries::FConditions::ContainsCallback = TFunctionRef<bool(uint8_t ColumnIndex, TWeakObjectPtr<const UScriptStruct> Column)>

Constructor & Destructor Documentation

FConditions() [1/2]

UE::Editor::DataStorage::Queries::FConditions::FConditions

(

)

FConditions() [2/2]

UE::Editor::DataStorage::Queries::FConditions::FConditions

(

FColumnBase

Column

)

Member Function Documentation

AppendToString()

void UE::Editor::DataStorage::Queries::FConditions::AppendToString

(

FString &

Output

)

const

Convert the conditions into a string and append them to the provided string.

Compile()

FConditions & UE::Editor::DataStorage::Queries::FConditions::Compile

(

const IQueryConditionCompileContext &

CompileContext

)

GetColumns()

TConstArrayView< TWeakObjectPtr< const UScriptStruct > > UE::Editor::DataStorage::Queries::FConditions::GetColumns

(

)

const

Returns a list of all columns used. This can include duplicate columns.

IsCompiled()

bool UE::Editor::DataStorage::Queries::FConditions::IsCompiled

(

)

const

IsEmpty()

bool UE::Editor::DataStorage::Queries::FConditions::IsEmpty

(

)

const

Whether or not there are any columns registered for operation.

MinimumColumnMatchRequired()

uint8_t UE::Editor::DataStorage::Queries::FConditions::MinimumColumnMatchRequired

(

)

const

Returns the minimum number of columns needed for a successful match.

UsesDynamicTemplates()

bool UE::Editor::DataStorage::Queries::FConditions::UsesDynamicTemplates

(

)

const

Whether the conditions contain any columns that are dynamic templates.

Verify() [1/6]

bool UE::Editor::DataStorage::Queries::FConditions::Verify

(

ContainsCallback

Callback

)

const

Runs through the list of query conditions and uses the callback to verify if a column is available.

Verify() [2/6]

bool UE::Editor::DataStorage::Queries::FConditions::Verify	(	TArray< TWeakObjectPtr< const UScriptStruct > > &	MatchedColumns,
		TConstArrayView< FColumnBase >	AvailableColumns,
		bool	AvailableColumnsAreSorted = false
	)		const

Runs the provided list of columns through the conditions and returns true if a valid combination of columns is found. This version returns a list of the columns that were used to match the condition.

Verify() [3/6]

bool UE::Editor::DataStorage::Queries::FConditions::Verify	(	TArray< TWeakObjectPtr< const UScriptStruct > > &	MatchedColumns,
		TConstArrayView< TWeakObjectPtr< const UScriptStruct > >	AvailableColumns,
		bool	AvailableColumnsAreSorted = false
	)		const

Runs the provided list of columns through the conditions and returns true if a valid combination of columns is found. This version returns a list of the columns that were used to match the condition.

Verify() [4/6]

bool UE::Editor::DataStorage::Queries::FConditions::Verify

(

TConstArrayView< FColumnBase >

AvailableColumns

)

const

Runs the provided list of columns through the conditions and returns true if a valid combination of columns is found.

Verify() [5/6]

bool UE::Editor::DataStorage::Queries::FConditions::Verify	(	TConstArrayView< TWeakObjectPtr< const UScriptStruct > >	AvailableColumns,
		bool	AvailableColumnsAreSorted = false
	)		const

Runs the provided list of columns through the conditions and returns true if a valid combination of columns is found.

Verify() [6/6]

bool UE::Editor::DataStorage::Queries::FConditions::Verify

(

TSet< TWeakObjectPtr< const UScriptStruct > >

AvailableColumns

)

const

Runs the provided list of columns through the conditions and returns true if a valid combination of columns is found.

VerifyWithDynamicColumn()

template<typename AvailableColumnType , typename ProjectionFunctionType >

bool UE::Editor::DataStorage::Queries::FConditions::VerifyWithDynamicColumn	(	TConstArrayView< AvailableColumnType >	AvailableColumns,
		uint64 &	Matches,
		ProjectionFunctionType	Projection
	)		const

Friends And Related Symbol Documentation

operator&& [1/4]

TYPEDELEMENTFRAMEWORK_API friend FConditions operator&& ( const FConditions &  Lhs, const FConditions &  Rhs  )

friend

operator&& [2/4]

TYPEDELEMENTFRAMEWORK_API friend FConditions operator&& ( const FConditions &  Lhs, FColumnBase  Rhs  )

friend

operator&& [3/4]

TYPEDELEMENTFRAMEWORK_API friend FConditions operator&& ( FColumnBase  Lhs, const FConditions &  Rhs  )

friend

operator&& [4/4]

TYPEDELEMENTFRAMEWORK_API friend FConditions operator&& ( FColumnBase  Lhs, FColumnBase  Rhs  )

friend

operator|| [1/4]

TYPEDELEMENTFRAMEWORK_API friend FConditions operator|| ( const FConditions &  Lhs, const FConditions &  Rhs  )

friend

operator|| [2/4]

TYPEDELEMENTFRAMEWORK_API friend FConditions operator|| ( const FConditions &  Lhs, FColumnBase  Rhs  )

friend

operator|| [3/4]

TYPEDELEMENTFRAMEWORK_API friend FConditions operator|| ( FColumnBase  Lhs, const FConditions &  Rhs  )

friend

operator|| [4/4]

TYPEDELEMENTFRAMEWORK_API friend FConditions operator|| ( FColumnBase  Lhs, FColumnBase  Rhs  )

friend

---

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

• Engine/Source/Runtime/TypedElementFramework/Public/DataStorage/Queries/Conditions.h
• Engine/Source/Runtime/TypedElementFramework/Private/DataStorage/Queries/Conditions.cpp