FJobSpecification

Encapsulates information about a Job specification passed into BeginJobSpecification

Choose your operating system:

Windows

macOS

Linux

References

Module

SwarmInterface

Header

/Engine/Source/Editor/SwarmInterface/Public/SwarmInterface.h

Include

#include "SwarmInterface.h"

Syntax

class FJobSpecification

Remarks

Encapsulates information about a Job specification passed into BeginJobSpecification

Variables

Name Description

Public variable

uint32

 

DescriptionCount

Public variable

const TCHAR ...

 

DescriptionKeys

Optional Job description values in key/value form

Public variable

const TCHAR ...

 

DescriptionValues

Public variable

const TCHAR ...

 

ExecutableName

The Job's executable name and parameter string

Public variable

TJobTaskFlags

 

Flags

Flags used to control the behavior of the executing Job

Public variable

const TCHAR ...

 

OptionalDependencies

Public variable

uint32

 

OptionalDependencyCount

Public variable

const TCHAR ...

 

Parameters

Public variable

const TCHAR ...

 

RequiredDependencies

Any additional Job dependencies

Public variable

uint32

 

RequiredDependencyCount

Constructors

Name Description

Public function

FJobSpecification()

Default constructor, initializes to an empty (invalid) job.

Public function

FJobSpecification

(
    const TCHAR* JobExecutableName,
    const TCHAR* JobParameters,
    TJobTaskFlags JobFlags
)

Constructor, initializes to default and specified values

Functions

Name Description

Public function

void

 

AddDependencies

(
    const TCHAR** NewRequiredD...,
    uint32 NewRequiredDependencyCount,
    const TCHAR** NewOptionalD...,
    uint32 NewOptionalDependencyCount
)

Used to add channel dependencies to a Job.

Public function

void

 

AddDescription

(
    const TCHAR** NewDescripti...,
    const TCHAR** NewDescripti...,
    uint32 NewDescriptionCount
)