1. Epic GamesDeveloper
  3. IAutomationControllerManager

IAutomationControllerManager

Interface for AutomationController .

API > API/Developer > API/Developer/AutomationController

References

   
Module AutomationController
Header /Engine/Source/Developer/AutomationController/Public/IAutomationControllerManager.h
Include #include "IAutomationControllerManager.h"

Syntax

class IAutomationControllerManager

Remarks

Interface for AutomationController .

Destructors

  Type Name Description
Public function Virtual   Virtual destructor.

Functions

  Type Name Description
Public function Const const bool Check if the automation tests have completed.
Public function void Remove results from the automation controller module.
Public function const bool

ExportReport ( uint32 FileExportTypeMask
)

 Generate an automation report.
Public function Const FString

GetClusterGroupName ( const int32 ClusterIndex
)

 Get the group name of the specified cluster.
Public function Const FString

GetDeviceName ( const int32 ClusterIndex,
const int32 DeviceIndex
)

 Get a device name.
Public function Const FString

GetDeviceTypeName ( const int32 ClusterIndex
)

 Get name of a particular device cluster.
Public function TArray< TSharedPtr< IAutomationReport > > Gives the array of enabled test results to the UI.
Public function Const void

GetEnabledTestNames ( TArray< FString >& OutEnabledTestNames
)

 Gets the names of all the enabled tests.
Public function Const int32 Returns number of tests that will be run.
Public function TArray< TSharedPtr< IAutomationReport > > & Gives the array of filtered test results to the UI.
Public function Const void

GetFilteredTestNames ( TArray< FString >& OutFilteredTestNames
)

 Gets the names of all the filtered tests.
Public function Const FString

GetGameInstanceName ( const int32 ClusterIndex,
const int32 DeviceIndex
)

 Get a game instance name.
Public function Const int32 Get num devices types.
Public function Const int32

GetNumDevicesInCluster ( const int32 ClusterIndex
)

 Get num devices in specified cluster.
Public function int32 Get the number of test passes.
Public function Const FString  
Public function Const EAutomationControllerModuleState::Type Gets the controller's current test state.
Public function void

Init ()

 Initializes the automation controller.
Public function Const bool Returns whether the automation tests should include developer content directories.
Public function Const bool Checks if a device group flag is set.
Public function bool Return true when the manager is ready and capable of executing tests.
Public function Const bool Returns if analytics should be sent
Public function Const bool Check that the test we are looking to run is runnable.
Public function Const bool Returns if PIE should be kept open when test pass end
Public function FOnAutomationControllerReset & Gets a delegate that is invoked when the controller's reset.
Public function FOnAutomationControllerManagerShutdown & Gets the multicast delegate that is invoked when the controller manager shuts down.
Public function FOnAutomationControllerManagerTestsAvailable & Gets the multicast delegate that is invoked when the controller has tests available.
Public function FOnAutomationControllerTestsComplete & Gets the test complete multicast delegate.
Public function FOnAutomationControllerTestsRefreshed & Gets the multicast delegate that is invoked when the controller's test status changes.
Public function void Removes all callbacks.
Public function Const const bool Check if the automation tests results have errors.
Public function Const const bool Check if the automation tests results have logs.
Public function Const const bool Check if the automation tests results have warnings.
Public function void

RequestAvailableWorkers ( const FGuid& InSessionId
)

 Broadcast a request for workers to ping if they are available.
Public function void

RequestLoadAsset ( const FString& InAssetName
)

 Request an asset to be loaded in the editor.
Public function void Send request for tests that are available to run.
Public function void

ResetAutomationTestTimeout ( const TCHAR* Reason
)

  
Public function void

RunTests ( const bool bIsLocalSession
)

 Resets all enabled tests to be able to run during Tick by local/remote machines.
Public function void

SetDeveloperDirectoryIncluded ( const bool bInDeveloperDirectoryIncluded
)

 Sets whether the automation tests should include developer content directories.
Public function void

SetEnabledTests ( const TArray< FString >& EnabledTests
)

 Sets any tests that match a name in the enabled tests array.
Public function void Filters the visible list of tests.
Public function void

SetKeepPIEOpen ( const bool bNewValue
)

 Sets if PIE should be kept open when test pass end
Public function void

SetNumPasses ( const int32 InNumPasses
)

 Sets the number of test passes.
Public function void

SetRequestedTestFlags ( const uint32 InRequestedTestFlags
)

 Sets what flags we're considering automation tests from
Public function void

SetSendAnalytics ( const bool bNewValue
)

 Sets if analytics should be sent
Public function void

SetVisibleTestsEnabled ( const bool bEnabled
)

 Sets whether all visible tests are enabled or not.
Public function void Shuts down the manager.
Public function void

Startup ()

 Starts up the manager.
Public function void Stops all running tests.
Public function void

Tick ()

 Tick function that will execute enabled tests for different device clusters.
Public function void Toggles a device group flag.
Public function void Updates the clusters when the device grouping changes.

Deprecated Functions

  Type Name Description
Public function TArray< TSharedPtr< IAutomationReport > > & Use GetFilteredReports or GetEnabledReports instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page