1. Epic GamesDeveloper
  3. IAutomationControllerManager

IAutomationControllerManager

Interface for AutomationController .

API > API/Developer > API/Developer/AutomationController

Interface for AutomationController .

   
Name IAutomationControllerManager
Type class
Header File /Engine/Source/Developer/AutomationController/Public/IAutomationControllerManager.h
Include Path #include "IAutomationControllerManager.h"

Syntax

class IAutomationControllerManager

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IAutomationControllerManager()

 Virtual destructor. IAutomationControllerManager.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

const bool CheckTestResultsAvailable()

 Check if the automation tests have completed. IAutomationControllerManager.h  

void ClearAutomationReports()

 Remove results from the automation controller module. IAutomationControllerManager.h  

const bool ExportReport ( uint32 FileExportTypeMask
)

 Generate an automation report. IAutomationControllerManager.h  

FString GetClusterGroupName ( const int32 ClusterIndex
) const

 Get the group name of the specified cluster. IAutomationControllerManager.h  

FString GetDeviceName ( const int32 ClusterIndex,
const int32 DeviceIndex
) const

 Get a device name. IAutomationControllerManager.h  

FString GetDeviceTypeName ( const int32 ClusterIndex
) const

 Get name of a particular device cluster. IAutomationControllerManager.h  

TArray< TSharedPtr< IAutomationReport > > GetEnabledReports()

 Gives the array of enabled test results to the UI. IAutomationControllerManager.h  

void GetEnabledTestNames ( TArray< FString >& OutEnabledTestNames
) const

 Gets the names of all the enabled tests. IAutomationControllerManager.h  

int32 GetEnabledTestsNum()

 Returns number of tests that will be run. IAutomationControllerManager.h  

TArray< TSharedPtr< IAutomationReport > > & GetFilteredReports()

 Gives the array of filtered test results to the UI. IAutomationControllerManager.h  

void GetFilteredTestNames ( TArray< FString >& OutFilteredTestNames
) const

 Gets the names of all the filtered tests. IAutomationControllerManager.h  

FGuid GetGameInstanceId ( const int32 ClusterIndex,
const int32 DeviceIndex
) const

 Get a game instance ID. IAutomationControllerManager.h  

FString GetGameInstanceName ( const int32 ClusterIndex,
const int32 DeviceIndex
) const

 Get a game instance name. IAutomationControllerManager.h  

int32 GetNumDeviceClusters()

 Get num devices types. IAutomationControllerManager.h  

int32 GetNumDevicesInCluster ( const int32 ClusterIndex
) const

 Get num devices in specified cluster. IAutomationControllerManager.h  

int32 GetNumPasses()

 Get the number of test passes. IAutomationControllerManager.h  

FString GetReportOutputPath()

   IAutomationControllerManager.h  

TArray< TSharedPtr< IAutomationReport > > & GetReports()

 Gives the array of filtered test results to the UI. IAutomationControllerManager.h  
Gets the controller's current test state. IAutomationControllerManager.h  

void Init()

 Initializes the automation controller. IAutomationControllerManager.h  

bool IsDeveloperDirectoryIncluded()

 Returns whether the automation tests should include developer content directories. IAutomationControllerManager.h  

bool IsDeviceGroupFlagSet ( EAutomationDeviceGroupTypes::Type InDeviceGroup
) const

 Checks if a device group flag is set. IAutomationControllerManager.h  

bool IsReadyForTests ()

 Return true when the manager is ready and capable of executing tests. IAutomationControllerManager.h  

bool IsSendAnalytics()

 Returns if analytics should be sent IAutomationControllerManager.h  

bool IsTestRunnable ( IAutomationReportPtr InReport
) const

 Check that the test we are looking to run is runnable. IAutomationControllerManager.h  

bool KeepPIEOpen()

 Returns if PIE should be kept open when test pass end IAutomationControllerManager.h  

FOnAutomationControllerReset & OnControllerReset()

 Gets a delegate that is invoked when the controller's reset. IAutomationControllerManager.h  

FOnAutomationControllerManagerShutdown & OnShutdown()

 Gets the multicast delegate that is invoked when the controller manager shuts down. IAutomationControllerManager.h  

FOnAutomationControllerManagerTestsAvailable & OnTestsAvailable()

 Gets the multicast delegate that is invoked when the controller has tests available. IAutomationControllerManager.h  

FOnAutomationControllerTestsComplete & OnTestsComplete()

 Gets the test complete multicast delegate. IAutomationControllerManager.h  

FOnAutomationControllerTestsRefreshed & OnTestsRefreshed()

 Gets the multicast delegate that is invoked when the controller's test status changes. IAutomationControllerManager.h  

void RemoveCallbacks()

 Removes all callbacks. IAutomationControllerManager.h  

const bool ReportsHaveErrors()

 Check if the automation tests results have errors. IAutomationControllerManager.h  

const bool ReportsHaveLogs()

 Check if the automation tests results have logs. IAutomationControllerManager.h  

const bool ReportsHaveWarnings()

 Check if the automation tests results have warnings. IAutomationControllerManager.h  

void RequestAvailableWorkers ( const FGuid& InSessionId
)

 Broadcast a request for workers to ping if they are available. IAutomationControllerManager.h  

void RequestLoadAsset ( const FString& InAssetName
)

 Request an asset to be loaded in the editor. IAutomationControllerManager.h  

void RequestTests()

 Send request for tests that are available to run. IAutomationControllerManager.h  

void ResetAutomationTestTimeout ( const TCHAR* Reason
)

   IAutomationControllerManager.h  

void RunTests ( const bool bIsLocalSession
)

 Resets all enabled tests to be able to run during Tick by local/remote machines. IAutomationControllerManager.h  

void SetDeveloperDirectoryIncluded ( const bool bInDeveloperDirectoryIncluded
)

 Sets whether the automation tests should include developer content directories. IAutomationControllerManager.h  

void SetEnabledTests ( const TArray< FString >& EnabledTests
)

 Sets any tests that match a name in the enabled tests array. IAutomationControllerManager.h  

void SetFilter ( TSharedPtr< AutomationFilterCollection > InFilter
)

 Filters the visible list of tests. IAutomationControllerManager.h  

void SetKeepPIEOpen ( const bool bNewValue
)

 Sets if PIE should be kept open when test pass end IAutomationControllerManager.h  

void SetNumPasses ( const int32 InNumPasses
)

 Sets the number of test passes. IAutomationControllerManager.h  

void SetRequestedTestFlags ( const EAutomationTestFlags InRequestedTestFlags
)

 Sets what flags we're considering automation tests from IAutomationControllerManager.h  

void SetSendAnalytics ( const bool bNewValue
)

 Sets if analytics should be sent IAutomationControllerManager.h  

void SetVisibleTestsEnabled ( const bool bEnabled
)

 Sets whether all visible tests are enabled or not. IAutomationControllerManager.h  

void Shutdown()

 Shuts down the manager. IAutomationControllerManager.h  

void Startup()

 Starts up the manager. IAutomationControllerManager.h  

void StopTests()

 Stops all running tests. IAutomationControllerManager.h  

void Tick()

 Tick function that will execute enabled tests for different device clusters. IAutomationControllerManager.h  

void ToggleDeviceGroupFlag ( EAutomationDeviceGroupTypes::Type InDeviceGroup
)

 Toggles a device group flag. IAutomationControllerManager.h  

void UpdateDeviceGroups()

 Updates the clusters when the device grouping changes. IAutomationControllerManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page