Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
FAutomationTestInfo Class Reference

#include <AutomationTest.h>

+ Collaboration diagram for FAutomationTestInfo:

Public Member Functions

 FAutomationTestInfo ()
 
 FAutomationTestInfo (const FString &InDisplayName, const FString &InFullTestPath, const FString &InTestName, const uint32 InTestFlags, const int32 InNumParticipantsRequired, const FString &InParameterName=FString(), const FString &InSourceFile=FString(), int32 InSourceFileLine=0, const FString &InAssetPath=FString(), const FString &InOpenCommand=FString())
 
void AddTestFlags (const uint32 InTestFlags)
 
const FString & GetDisplayName () const
 
const FString & GetFullTestPath () const
 
FString GetTestName () const
 
const FString GetTestParameter () const
 
const FString GetSourceFile () const
 
const int32 GetSourceFileLine () const
 
const FString GetAssetPath () const
 
const FString GetOpenCommand () const
 
const uint32 GetTestFlags () const
 
void ResetNumDevicesRunningTest ()
 
void InformOfNewDeviceRunningTest ()
 
const int GetNumDevicesRunningTest () const
 
const int32 GetNumParticipantsRequired () const
 
void SetDisplayName (const FString &InDisplayName)
 
void SetNumParticipantsRequired (int32 NumRequired)
 

Private Attributes

FString DisplayName
 
FString FullTestPath
 
FString TestName
 
FString TestParameter
 
FString SourceFile
 
int32 SourceFileLine
 
FString AssetPath
 
FString OpenCommand
 
uint32 TestFlags
 
uint32 NumParticipantsRequired
 
uint32 NumDevicesCurrentlyRunningTest
 

Detailed Description

Simple class to store the automation test info

Definition at line 267 of file AutomationTest.h.

Constructor & Destructor Documentation

◆ FAutomationTestInfo() [1/2]

FAutomationTestInfo::FAutomationTestInfo ( )
inline

Definition at line 272 of file AutomationTest.h.

◆ FAutomationTestInfo() [2/2]

FAutomationTestInfo::FAutomationTestInfo ( const FString & InDisplayName,
const FString & InFullTestPath,
const FString & InTestName,
const uint32 InTestFlags,
const int32 InNumParticipantsRequired,
const FString & InParameterName = FString(),
const FString & InSourceFile = FString(),
int32 InSourceFileLine = 0,
const FString & InAssetPath = FString(),
const FString & InOpenCommand = FString() )
inline

Constructor

Parameters
InDisplayName- Name used in the UI
InTestName- The test command string
InTestFlag- Test flags
InParameterName- optional parameter. e.g. asset name

Definition at line 286 of file AutomationTest.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Function Documentation

◆ AddTestFlags()

void FAutomationTestInfo::AddTestFlags ( const uint32 InTestFlags)
inline

Add a test flag if a parent node.

@Param InTestFlags - the child test flag to add.

Definition at line 307 of file AutomationTest.h.

◆ GetAssetPath()

const FString FAutomationTestInfo::GetAssetPath ( ) const
inline

Gets the asset potentially associated with the test.

Returns
the source line number.

Definition at line 377 of file AutomationTest.h.

◆ GetDisplayName()

const FString & FAutomationTestInfo::GetDisplayName ( ) const
inline

Get the display name of this test.

Returns
the display name.

Definition at line 317 of file AutomationTest.h.

◆ GetFullTestPath()

const FString & FAutomationTestInfo::GetFullTestPath ( ) const
inline

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

Returns
the display name.

Definition at line 327 of file AutomationTest.h.

◆ GetNumDevicesRunningTest()

const int FAutomationTestInfo::GetNumDevicesRunningTest ( ) const
inline

Get the number of devices running this test

Returns
The number of devices which have been given this test to run

Definition at line 423 of file AutomationTest.h.

◆ GetNumParticipantsRequired()

const int32 FAutomationTestInfo::GetNumParticipantsRequired ( ) const
inline

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

Returns
The number of participants needed

Definition at line 433 of file AutomationTest.h.

◆ GetOpenCommand()

const FString FAutomationTestInfo::GetOpenCommand ( ) const
inline

Gets the open command potentially associated with the test.

Returns
the source line number.

Definition at line 387 of file AutomationTest.h.

◆ GetSourceFile()

const FString FAutomationTestInfo::GetSourceFile ( ) const
inline

Get the source file this test originated in.

Returns
the source file.

Definition at line 357 of file AutomationTest.h.

◆ GetSourceFileLine()

const int32 FAutomationTestInfo::GetSourceFileLine ( ) const
inline

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

Returns
the source line number.

Definition at line 367 of file AutomationTest.h.

◆ GetTestFlags()

const uint32 FAutomationTestInfo::GetTestFlags ( ) const
inline

Get the type of test.

Returns
the test type.

Definition at line 397 of file AutomationTest.h.

◆ GetTestName()

FString FAutomationTestInfo::GetTestName ( ) const
inline

Get the test name of this test.

Returns
The test name.

Definition at line 337 of file AutomationTest.h.

◆ GetTestParameter()

const FString FAutomationTestInfo::GetTestParameter ( ) const
inline

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

Returns
the parameter.

Definition at line 347 of file AutomationTest.h.

◆ InformOfNewDeviceRunningTest()

void FAutomationTestInfo::InformOfNewDeviceRunningTest ( )
inline

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

Definition at line 413 of file AutomationTest.h.

◆ ResetNumDevicesRunningTest()

void FAutomationTestInfo::ResetNumDevicesRunningTest ( )
inline

Zero the number of devices running this test

Definition at line 405 of file AutomationTest.h.

◆ SetDisplayName()

void FAutomationTestInfo::SetDisplayName ( const FString & InDisplayName)
inline

Set the display name of the child node.

@Param InDisplayName - the new child test name.

Definition at line 444 of file AutomationTest.h.

◆ SetNumParticipantsRequired()

void FAutomationTestInfo::SetNumParticipantsRequired ( int32 NumRequired)
inline

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

@Param NumRequired - The new number of participants needed

Definition at line 454 of file AutomationTest.h.

Member Data Documentation

◆ AssetPath

FString FAutomationTestInfo::AssetPath
private

The asset path associated with the test.

Definition at line 478 of file AutomationTest.h.

◆ DisplayName

FString FAutomationTestInfo::DisplayName
private

Display name used in the UI

Definition at line 461 of file AutomationTest.h.

◆ FullTestPath

FString FAutomationTestInfo::FullTestPath
private

Definition at line 463 of file AutomationTest.h.

◆ NumDevicesCurrentlyRunningTest

uint32 FAutomationTestInfo::NumDevicesCurrentlyRunningTest
private

The number of devices which have been given this test to run

Definition at line 490 of file AutomationTest.h.

◆ NumParticipantsRequired

uint32 FAutomationTestInfo::NumParticipantsRequired
private

The number of participants this test requires

Definition at line 487 of file AutomationTest.h.

◆ OpenCommand

FString FAutomationTestInfo::OpenCommand
private

A custom open command for the test.

Definition at line 481 of file AutomationTest.h.

◆ SourceFile

FString FAutomationTestInfo::SourceFile
private

The source file this test originated in.

Definition at line 472 of file AutomationTest.h.

◆ SourceFileLine

int32 FAutomationTestInfo::SourceFileLine
private

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

Definition at line 475 of file AutomationTest.h.

◆ TestFlags

uint32 FAutomationTestInfo::TestFlags
private

The test flags.

Definition at line 484 of file AutomationTest.h.

◆ TestName

FString FAutomationTestInfo::TestName
private

Test name used to run the test

Definition at line 466 of file AutomationTest.h.

◆ TestParameter

FString FAutomationTestInfo::TestParameter
private

Parameter - e.g. an asset name or map name

Definition at line 469 of file AutomationTest.h.

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