AutomationAnalytics.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Containers/Array.h"
#include "Containers/UnrealString.h"
#include "Templates/SharedPointer.h"
#include "Templates/UnrealTemplate.h"
 
#include "AutomationAnalyticParams.h"
 
class IAnalyticsProvider;
class IAnalyticsProviderET;
 
struct FAnalyticsEventAttribute;
struct FAutomationPerformanceSnapshot;
struct FAutomationWorkerRunTestsReply;
 
 
class FAutomationAnalytics
    : FNoncopyable
{
public:
 
    static IAnalyticsProvider& GetProvider();
 
    static void Initialize();
    
    static bool IsAvailable();
 
    static void Shutdown();
 
    /*
     * Helper function to retrieve the parameter name from a given enum
     */
    static FString GetAutomationEventName(EAutomationEventName::Type InEventName);
    static FString GetAutomationParamName(EAutomationAnalyticParam::Type InEngineParam);
 
    static void InititalizeAnalyticParameterNames();
    
    static bool IsInitialized();
 
public:
 
    //  Events
 
    //FPSCapture Event
    static void FireEvent_FPSCapture(const FAutomationPerformanceSnapshot& PerfSnapshot);
 
    //AutomationTest Event
    static void FireEvent_AutomationTestResults(const FAutomationWorkerRunTestsReply* TestResults, const FString& BeautifiedTestName);
 
private:
    
    static void SetInitialParameters(TArray<FAnalyticsEventAttribute>& ParamArray);
 
    static TArray<FString> AutomationEventNames;
    static TArray<FString> AutomationParamNames;
    static FString MachineSpec;
 
    static bool bIsInitialized;
 
    static TSharedPtr<IAnalyticsProviderET> Analytics;
};