SimpleTimer.h

Go to the documentation of this file.

// Copyright (c) 2023 FrostBit Software Lab at the Lapland University of Applied Sciences
//
// This work is licensed under the terms of the MIT license.
// For a copy, see <https://opensource.org/licenses/MIT>.
 
#pragma once
 
#include "Engine/GameEngine.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
 
class SimpleTimer
{
 
public:
 
    SimpleTimer()
    {
        TakeTimeStamp();
    }
 
    void Reset()
    {
        TakeTimeStamp();
 
        totalMilliseconds = 0.0;
        counter = 0;
    }
 
    void TakeTimeStamp()
    {
        startTime = FPlatformTime::Seconds();
    }
 
    void StopTimer(FString prefix = "Code executed in ", FString suffix = " milliseconds", bool printToScreen = false)
    {
        double endTime = FPlatformTime::Seconds();
        float milliseconds = (endTime - startTime) * 1000;
 
        FString msString = FString::SanitizeFloat(milliseconds);
        FString msg = prefix + msString + suffix;
        UE_LOG(LogTemp, Warning, TEXT("%s"), *msg);
 
        if (GEngine && printToScreen)
        {
            GEngine->AddOnScreenDebugMessage(-1, 15.0f, FColor::Yellow, FString::Printf(TEXT("%s"), *msg));
        }
    }
 
    double GetAverageTime()
    {
        double endTime = FPlatformTime::Seconds();
        float milliseconds = (endTime - startTime) * 1000;
 
        totalMilliseconds += milliseconds;
        ++counter;
        double currentAvg = totalMilliseconds / counter;
 
        return currentAvg;
    }
 
    double PrintAverageTime(FString prefix = "Average execution time ", FString suffix = " milliseconds", bool printToScreen = false)
    {
        double currentAvg = GetAverageTime();
 
        FString msString = FString::SanitizeFloat(currentAvg);
        FString msg = prefix + msString + suffix;
 
#if WITH_EDITOR
        UE_LOG(LogTemp, Warning, TEXT("%s"), *msg);
        if (GEngine && printToScreen)
        {
            GEngine->AddOnScreenDebugMessage(-1, 15.0f, FColor::Yellow, FString::Printf(TEXT("%s"), *msg));
        }
#endif
 
        return currentAvg;
    }
 
    void ResetAverageTime()
    {
        totalMilliseconds = 0.0;
        counter = 0;
    }
 
private:
 
    double startTime;
    double totalMilliseconds = 0.0;
    int counter = 0;
 
};