Navigation
API > API/Runtime > API/Runtime/TypedElementFramework
Base used for context implementations. This will verify if a context is correctly implemented. Classes that implement capabilities should use this template to automatically satisfy the requirements of a query contract. Any missing functionality will be filled in by this template with a placeholder function that asserts. The supported capabilities are automatically extracted from the implementation type but can be overruled by providing a list of capabilities as extra template arguments. Note that any capabilities provided this way do need to be implemented by the implementation type.
| Name | TQueryContextImpl |
| Type | class |
| Header File | /Engine/Source/Runtime/TypedElementFramework/Public/Elements/Framework/TypedElementQueryContextImplementation.h |
| Include Path | #include "Elements/Framework/TypedElementQueryContextImplementation.h" |
Syntax
template<typename ImplementationType, ContextCapability... SupportedCapabilities>
class TQueryContextImpl : public UE::Editor::DataStorage::Queries::IContextContract
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TQueryContextImpl
(
TArgs&&... Args |
Elements/Framework/TypedElementQueryContextImplementation.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~TQueryContextImpl() |
Elements/Framework/TypedElementQueryContextImplementation.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Implementation | ImplementationType | Elements/Framework/TypedElementQueryContextImplementation.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool CheckCompatiblity
(
const TQueryFunction< ReturnType >& Function |
Generic access. | Elements/Framework/TypedElementQueryContextImplementation.h | |
bool CurrentBatchTableHasColumns () |
Checks if the rows in the current batch have the requested columns. | ||
virtual bool CurrentBatchTableHasColumns
(
TConstArrayView< const UScriptStruct* > Columns |
Checks if the rows in the current batch have the requested columns. | ||
bool CurrentRowHasColumns () |
Returns whether a column matches the requested type or not. | ||
virtual bool CurrentRowHasColumns
(
TConstArrayView< const UScriptStruct* > Columns |
Mini-DSL to declare TEDS capabilities. | ||
void ForEachRow
(
CallbackType&& Callback, |
|||
virtual uint32 GetBatchRowCount () |
Capability to provide information about the currently active batch. | ||
virtual TConstArrayView< RowHandle > GetBatchRowHandles() |
Returns an view with the rows used by this batch. | ||
const ImplementationType & GetContextImplementation () |
Elements/Framework/TypedElementQueryContextImplementation.h | ||
ImplementationType & GetContextImplementation () |
Elements/Framework/TypedElementQueryContextImplementation.h | ||
virtual RowHandle GetCurrentRow() |
Returns the currently active row. |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool SupportsCapabilities
(
TConstArrayView< FName > Capabilities |
Elements/Framework/TypedElementQueryContextImplementation.h | ||
static bool SupportsCapability () |
Elements/Framework/TypedElementQueryContextImplementation.h | ||
static bool SupportsCapability
(
const FName& Capability |
Elements/Framework/TypedElementQueryContextImplementation.h |