FRRAsyncJob Struct Reference

Async job info (task, job name, latest capture batch id) More...

#include <RRActorCommon.h>

Classes
struct	FRRSingleAsyncTask

Public Member Functions
	FRRAsyncJob (const FString &InJobName)
	FRRAsyncJob (FRRAsyncJob &&Other)
int32	GetTasksNum () const
void	SetAsyncTaskAtLast (TFuture< bool > &&InAsyncTask)
	TFuture is move-only! More...
void	AddAsyncTask (const uint64 InCaptureBatchId, TFuture< bool > &&InAsyncTask)
void	AddDefaultAsyncTask ()
void	Clear ()
void	MarkSingleTaskAsDone (int32 TaskIndex, const FString &TaskName)
bool	IsDone () const
void	WaitUntilCompleted ()

Public Attributes
FString	JobName
uint64	LatestCaptureBatchId = 0
	This stores the up-to-the-moment capture batch id every time an async task is added to be scheduled for running! More...
TArray< FRRSingleAsyncTask< bool > >	AsyncTasks

Static Public Attributes
static constexpr const int8	TASK_INDEX_NONE = -1

Detailed Description

Async job info (task, job name, latest capture batch id)

This struct contains TFuture, which has private ctor, thus is move-only and could not be a USTRUCT().

and also make itself by default non-copyable without custom copy ctor!

Constructor & Destructor Documentation

FRRAsyncJob() [1/2]

FRRAsyncJob::FRRAsyncJob ( const FString &  InJobName )

inlineexplicit

FRRAsyncJob() [2/2]

FRRAsyncJob::FRRAsyncJob ( FRRAsyncJob &&  Other )

inline

Member Function Documentation

AddAsyncTask()

void FRRAsyncJob::AddAsyncTask ( const uint64  InCaptureBatchId, TFuture< bool > &&  InAsyncTask  )

inline

AddDefaultAsyncTask()

void FRRAsyncJob::AddDefaultAsyncTask ( )

inline

Clear()

void FRRAsyncJob::Clear ( )

inline

GetTasksNum()

int32 FRRAsyncJob::GetTasksNum ( ) const

inline

IsDone()

bool FRRAsyncJob::IsDone ( ) const

inline

MarkSingleTaskAsDone()

void FRRAsyncJob::MarkSingleTaskAsDone ( int32  TaskIndex, const FString &  TaskName  )

inline

SetAsyncTaskAtLast()

void FRRAsyncJob::SetAsyncTaskAtLast ( TFuture< bool > &&  InAsyncTask )

inline

TFuture is move-only!

WaitUntilCompleted()

void FRRAsyncJob::WaitUntilCompleted ( )

inline

Member Data Documentation

AsyncTasks

TArray<FRRSingleAsyncTask<bool> > FRRAsyncJob::AsyncTasks

JobName

FString FRRAsyncJob::JobName

LatestCaptureBatchId

uint64 FRRAsyncJob::LatestCaptureBatchId = 0

This stores the up-to-the-moment capture batch id every time an async task is added to be scheduled for running!

TASK_INDEX_NONE

constexpr const int8 FRRAsyncJob::TASK_INDEX_NONE = -1

staticconstexpr

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/rapyutasimulationplugins/checkouts/devel/Source/RapyutaSimulationPlugins/Public/Core/RRActorCommon.h