FAutomationTestInfo

Simple class to store the automation test info

Windows
MacOS
Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Misc/AutomationTest.h

Include

#include "Misc/AutomationTest.h"

Syntax

class FAutomationTestInfo

Remarks

Simple class to store the automation test info

Constructors

Name Description

Public function

FAutomationTestInfo()

Default constructor.

Public function

FAutomationTestInfo

(
    const FString & InDisplayName,
    const FString & InFullTestPath,
    const FString & InTestName,
    const uint32 InTestFlags,
    const int32 InNumParticipantsRequir...,
    const FString & InParameterName,
    const FString & InSourceFile,
    int32 InSourceFileLine,
    const FString & InAssetPath,
    const FString & InOpenCommand
)

Constructor

Functions

Name Description

Public function

void

 

AddTestFlags

(
    const uint8 InTestFlags
)

Add a test flag if a parent node.

InTestFlags - the child test flag to add.

Public function Const

const FStrin ...

 

GetAssetPath()

Gets the asset potentially associated with the test.

Public function Const

const FStrin ...

 

GetDisplayName()

Get the display name of this test.

Public function Const

const FStrin ...

 

GetFullTestPath()

Gets the full path for this test if you wanted to run it.

Public function Const

const int

 

GetNumDevicesRunningTest()

Get the number of devices running this test

Public function Const

const int32

 

GetNumParticipantsRequired()

Get the number of participant this test needs in order to be run

Public function Const

const FStrin ...

 

GetOpenCommand()

Gets the open command potentially associated with the test.

Public function Const

const FStrin ...

 

GetSourceFile()

Get the source file this test originated in.

Public function Const

const int32

 

GetSourceFileLine()

Get the line number in the source file this test originated on.

Public function Const

const uint32

 

GetTestFlags()

Get the type of test.

Public function Const

FString

 

GetTestName()

Get the test name of this test.

Public function Const

const FStrin ...

 

GetTestParameter()

Get the type of parameter. This will be the asset name for linked assets.

Public function

void

 

InformOfNewDeviceRunningTest()

Be notified of a new device running the test so we should update our flag counting these

Public function

void

 

ResetNumDevicesRunningTest()

Zero the number of devices running this test

Public function

void

 

SetDisplayName

(
    const FString & InDisplayName
)

Set the display name of the child node.

InDisplayName - the new child test name.

Public function

void

 

SetNumParticipantsRequired

(
    int32 NumRequired
)

Set the number of participant this test needs in order to be run

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback