IAnalyticsPropertyStore.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Misc/DateTime.h"
#include "Templates/Function.h"
#include "AnalyticsEventAttribute.h"
 
class IAnalyticsPropertyStore
{
public:
    enum class EStatusCode : uint32
    {
        Success,
        NotFound,
        BadType,
        Declined,
    };
 
public:
    virtual ~IAnalyticsPropertyStore() = default;
 
    virtual uint32 Num() const = 0;
 
    virtual bool Contains(const FString& Key) const = 0;
 
    virtual bool Remove(const FString& Key) = 0;
 
    virtual void RemoveAll() = 0;
 
    virtual EStatusCode Set(const FString& Key, int32 Value) = 0;
    virtual EStatusCode Set(const FString& Key, uint32 Value) = 0;
    virtual EStatusCode Set(const FString& Key, int64 Value) = 0;
    virtual EStatusCode Set(const FString& Key, uint64 Value) = 0;
    virtual EStatusCode Set(const FString& Key, float Value) = 0;
    virtual EStatusCode Set(const FString& Key, double Value) = 0;
    virtual EStatusCode Set(const FString& Key, bool Value) = 0;
    virtual EStatusCode Set(const FString& Key, const FString& Value, uint32 CharCountCapacityHint = 0) = 0;
    virtual EStatusCode Set(const FString& Key, const FDateTime& Value) = 0;
 
    virtual EStatusCode Set(const FString& Key, int32 Value, const TFunction<bool(const int32* /*Actual*/, const int32& /*Proposed*/)>& ConditionFn) = 0;
    virtual EStatusCode Set(const FString& Key, uint32 Value, const TFunction<bool(const uint32* /*Actual*/, const uint32& /*Proposed*/)>& ConditionFn) = 0;
    virtual EStatusCode Set(const FString& Key, int64 Value, const TFunction<bool(const int64* /*Actual*/, const int64& /*Proposed*/)>& ConditionFn) = 0;
    virtual EStatusCode Set(const FString& Key, uint64 Value, const TFunction<bool(const uint64* /*Actual*/, const uint64& /*Proposed*/)>& ConditionFn) = 0;
    virtual EStatusCode Set(const FString& Key, float Value, const TFunction<bool(const float* /*Actual*/, const float& /*Proposed*/)>& ConditionFn) = 0;
    virtual EStatusCode Set(const FString& Key, double Value, const TFunction<bool(const double* /*Actual*/, const double& /*Proposed*/)>& ConditionFn) = 0;
    virtual EStatusCode Set(const FString& Key, bool Value, const TFunction<bool(const bool* /*Actual*/, const bool& /*Proposed*/)>& ConditionFn) = 0;
    virtual EStatusCode Set(const FString& Key, const FString& Value, const TFunction<bool(const FString* /*Actual*/, const FString& /*Proposed*/)>& ConditionFn) = 0;
    virtual EStatusCode Set(const FString& Key, const FDateTime& Value, const TFunction<bool(const FDateTime* /*Actual*/, const FDateTime& /*Proposed*/)>& ConditionFn) = 0;
 
    virtual EStatusCode Update(const FString& Key, const TFunction<bool(int32& /*InOutValue*/)>& UpdateFn) = 0;
    virtual EStatusCode Update(const FString& Key, const TFunction<bool(uint32& /*InOutValue*/)>& UpdateFn) = 0;
    virtual EStatusCode Update(const FString& Key, const TFunction<bool(int64& /*InOutValue*/)>& UpdateFn) = 0;
    virtual EStatusCode Update(const FString& Key, const TFunction<bool(uint64& /*InOutValue*/)>& UpdateFn) = 0;
    virtual EStatusCode Update(const FString& Key, const TFunction<bool(float& /*InOutValue*/)>& UpdateFn) = 0;
    virtual EStatusCode Update(const FString& Key, const TFunction<bool(double& /*InOutValue*/)>& UpdateFn) = 0;
    virtual EStatusCode Update(const FString& Key, const TFunction<bool(bool& /*InOutValue*/)>& UpdateFn) = 0;
    virtual EStatusCode Update(const FString& Key, const TFunction<bool(FString& /*InOutValue*/)>& UpdateFn) = 0;
    virtual EStatusCode Update(const FString& Key, const TFunction<bool(FDateTime& /*InOutValue*/)>& UpdateFn) = 0;
 
    virtual EStatusCode Get(const FString& Key, int32& OutValue) const = 0;
    virtual EStatusCode Get(const FString& Key, uint32& OutValue) const = 0;
    virtual EStatusCode Get(const FString& Key, int64& OutValue) const = 0;
    virtual EStatusCode Get(const FString& Key, uint64& OutValue) const = 0;
    virtual EStatusCode Get(const FString& Key, float& OutValue) const = 0;
    virtual EStatusCode Get(const FString& Key, double& OutValue) const = 0;
    virtual EStatusCode Get(const FString& Key, bool& OutValue) const = 0;
    virtual EStatusCode Get(const FString& Key, FString& OutValue) const = 0;
    virtual EStatusCode Get(const FString& Key, FDateTime& OutValue)const = 0;
 
    virtual void VisitAll(const TFunction<void(FAnalyticsEventAttribute&&)>& VisitFn) const = 0;
 
    virtual bool Flush(bool bAsync = false, const FTimespan& Timeout = FTimespan::MaxValue()) = 0;
};
 
template<typename T>
class TAnalyticsProperty
{
public:
    TAnalyticsProperty(const TCHAR* InKey) : Key(InKey){}
 
    IAnalyticsPropertyStore::EStatusCode Set(IAnalyticsPropertyStore* Store, const T& Value) const { return Store->Set(Key, Value); }
    IAnalyticsPropertyStore::EStatusCode Set(IAnalyticsPropertyStore* Store, const T& Value, const TFunction<bool(const T*, const T&)>& ConditionFn) const { return Store->Set(Key, Value, ConditionFn); }
    IAnalyticsPropertyStore::EStatusCode Get(IAnalyticsPropertyStore* Store, T& OutValue) const { return Store->Get(Key, OutValue); }
    IAnalyticsPropertyStore::EStatusCode Update(IAnalyticsPropertyStore* Store, const TFunction<bool(T& InOutValue)>& UpdateFn) const { return Store->Update(Key, UpdateFn); }
 
    const FString Key;
};
 
template<>
class TAnalyticsProperty<FString>
{
public:
    TAnalyticsProperty(const TCHAR* InKey) : Key(InKey){}
 
    IAnalyticsPropertyStore::EStatusCode Set(IAnalyticsPropertyStore* Store, const FString& Value, uint32 CharCountCapacityHint = 0) const { return Store->Set(Key, Value, CharCountCapacityHint); }
    IAnalyticsPropertyStore::EStatusCode Set(IAnalyticsPropertyStore* Store, const FString& Value, const TFunction<bool(const FString*, const FString&)>& ConditionFn) const { return Store->Set(Key, Value, ConditionFn); }
    IAnalyticsPropertyStore::EStatusCode Get(IAnalyticsPropertyStore* Store, FString& OutValue) const { return Store->Get(Key, OutValue); }
    IAnalyticsPropertyStore::EStatusCode Update(IAnalyticsPropertyStore* Store, const TFunction<bool(FString& InOutValue)>& UpdateFn) const { return Store->Update(Key, UpdateFn); }
 
    const FString Key;
};