Apparatus Version 1.23
ECS data-oriented workflow for Unreal Engine.
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FCommonChain::TCommonMechanicTask< ChainT > Struct Template Reference

A common asynchronous task. More...

#include <CommonChain.h>

Inheritance diagram for FCommonChain::TCommonMechanicTask< ChainT >:
Inheritance graph
[legend]
Collaboration diagram for FCommonChain::TCommonMechanicTask< ChainT >:
Collaboration graph
[legend]

Public Member Functions

 TCommonMechanicTask ()
 
 TCommonMechanicTask (const ChainT *const InOwner, const bool bInConcurrent=false)
 

Protected Member Functions

void DoBeginWork ()
 This must be executed within a new thread's context, which is always within a solid mechanism.
 
void DoEndWork ()
 This must be executed within a new thread context.
 
void DoWork ()
 

Protected Attributes

const ChainT * Owner = nullptr
 The owning chain of the task.
 
bool bConcurrent = false
 Is this task running in a concurrent mode.
 

Detailed Description

template<typename ChainT>
struct FCommonChain::TCommonMechanicTask< ChainT >

A common asynchronous task.

Constructor & Destructor Documentation

◆ TCommonMechanicTask() [1/2]

template<typename ChainT >
FCommonChain::TCommonMechanicTask< ChainT >::TCommonMechanicTask ( )
inline

◆ TCommonMechanicTask() [2/2]

template<typename ChainT >
FCommonChain::TCommonMechanicTask< ChainT >::TCommonMechanicTask ( const ChainT *const  InOwner,
const bool  bInConcurrent = false 
)
inline

Member Function Documentation

◆ DoBeginWork()

template<typename ChainT >
void FCommonChain::TCommonMechanicTask< ChainT >::DoBeginWork ( )
protected

This must be executed within a new thread's context, which is always within a solid mechanism.

◆ DoEndWork()

template<typename ChainT >
void FCommonChain::TCommonMechanicTask< ChainT >::DoEndWork ( )
protected

This must be executed within a new thread context.

◆ DoWork()

template<typename ChainT >
void FCommonChain::TCommonMechanicTask< ChainT >::DoWork ( )
inlineprotected

Member Data Documentation

◆ bConcurrent

template<typename ChainT >
bool FCommonChain::TCommonMechanicTask< ChainT >::bConcurrent = false
protected

Is this task running in a concurrent mode.

◆ Owner

template<typename ChainT >
const ChainT* FCommonChain::TCommonMechanicTask< ChainT >::Owner = nullptr
protected

The owning chain of the task.


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