1. Epic GamesDeveloper
  3. FAutomationTestInfo

FAutomationTestInfo

Simple class to store the automation test info

API > API/Runtime > API/Runtime/Core

Simple class to store the automation test info

   
Name FAutomationTestInfo
Type class
Header File /Engine/Source/Runtime/Core/Public/Misc/AutomationTest.h
Include Path #include "Misc/AutomationTest.h"

Syntax

class FAutomationTestInfo

Constructors

Name Remarks Include Path Unreal Specifiers
Default constructor. Misc/AutomationTest.h  

FAutomationTestInfo ( const FString& InDisplayName,
const FString& InFullTestPath,
const FString& InTestName,
const EAutomationTestFlags InTestFlags,
const int32 InNumParticipantsRequired,
const FString& InParameterName,
const FString& InSourceFile,
int32 InSourceFileLine,
const FString& InAssetPath,
const FString& InOpenCommand,
const FString& InTestTags
)

 Constructor Misc/AutomationTest.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AssetPath FString The asset path associated with the test. Misc/AutomationTest.h  
DisplayName FString Display name used in the UI Misc/AutomationTest.h  
FullTestPath FString   Misc/AutomationTest.h  
NumDevicesCurrentlyRunningTest uint32 The number of devices which have been given this test to run Misc/AutomationTest.h  
NumParticipantsRequired uint32 The number of participants this test requires Misc/AutomationTest.h  
OpenCommand FString A custom open command for the test. Misc/AutomationTest.h  
SourceFile FString The source file this test originated in. Misc/AutomationTest.h  
SourceFileLine int32 The line number in the source file this test originated on. Misc/AutomationTest.h  
TestFlags EAutomationTestFlags The test flags. Misc/AutomationTest.h  
TestName FString Test name used to run the test Misc/AutomationTest.h  
TestParameter FString Parameter - e.g. an asset name or map name Misc/AutomationTest.h  
TestTags FString Tags defined on this test Misc/AutomationTest.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddTestFlags ( const EAutomationTestFlags InTestFlags
)

 Add a test flag if a parent node.@Param InTestFlags - the child test flag to add. Misc/AutomationTest.h  

const FString GetAssetPath()

 Gets the asset potentially associated with the test. Misc/AutomationTest.h  

const FString & GetDisplayName()

 Get the display name of this test. Misc/AutomationTest.h  

const FString & GetFullTestPath()

 Gets the full path for this test if you wanted to run it. Misc/AutomationTest.h  

const int GetNumDevicesRunningTest()

 Get the number of devices running this test Misc/AutomationTest.h  

const int32 GetNumParticipantsRequired()

 Get the number of participant this test needs in order to be run Misc/AutomationTest.h  

const FString GetOpenCommand()

 Gets the open command potentially associated with the test. Misc/AutomationTest.h  

const FString GetSourceFile()

 Get the source file this test originated in. Misc/AutomationTest.h  

const int32 GetSourceFileLine()

 Get the line number in the source file this test originated on. Misc/AutomationTest.h  

const EAutomationTestFlags GetTestFlags()

 Get the type of test. Misc/AutomationTest.h  

FString GetTestName()

 Get the test name of this test. Misc/AutomationTest.h  

const FString GetTestParameter()

 Get the type of parameter. This will be the asset name for linked assets. Misc/AutomationTest.h  

FString GetTestTags()

 Get the tags associated with this test. Misc/AutomationTest.h  

void InformOfNewDeviceRunningTest()

 Be notified of a new device running the test so we should update our flag counting these Misc/AutomationTest.h  

void ResetNumDevicesRunningTest()

 Zero the number of devices running this test Misc/AutomationTest.h  

void SetDisplayName ( const FString& InDisplayName
)

 Set the display name of the child node.@Param InDisplayName - the new child test name. Misc/AutomationTest.h  

void SetNumParticipantsRequired ( int32 NumRequired
)

 Set the number of participant this test needs in order to be run Misc/AutomationTest.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page