SimpleTimer Class Reference

#include <SimpleTimer.h>

Public Member Functions
	SimpleTimer ()
void	Reset ()
void	TakeTimeStamp ()
void	StopTimer (FString prefix="Code executed in ", FString suffix=" milliseconds", bool printToScreen=false)
double	GetAverageTime ()
double	PrintAverageTime (FString prefix="Average execution time ", FString suffix=" milliseconds", bool printToScreen=false)
void	ResetAverageTime ()

Private Attributes
double	startTime
double	totalMilliseconds = 0.0
int	counter = 0

Detailed Description

Simple milliseconds timer for quick performance or other timing testing. Should only be used for local testing.

---

To measure execution time of some code block:

1. Add include to the .cpp or .h file #include "Agrarsense/Debugging/SimpleTimer.h"
2. Create timer auto timer = SimpleTimer(); // code to measure here timer.StopTimer();
3. If you want to reset the same timer and continue using to measure other code block timer.Reset(); // more code to measure here timer.StopTimer(false, "more things to measure: ", " ms");

---

To measure average execution time of some code block:

1. Add include to .h file #include "Agrarsense/Debugging/SimpleTimer.h
2. Create SimpleTimer variable to .h file SimpleTimer timer;
3. Init timer somewhere, for example in the BeginPlay timer = SimpleTimer();
4. To measure average time of some code block timer.TakeTimeStamp(); // code to measure here timer.PrintAverageTime();

Definition at line 49 of file SimpleTimer.h.

Constructor & Destructor Documentation

SimpleTimer()

SimpleTimer::SimpleTimer ( )

inline

Start SimpleTimer

Definition at line 57 of file SimpleTimer.h.

    {
        TakeTimeStamp();
    }

References TakeTimeStamp().

Member Function Documentation

GetAverageTime()

double SimpleTimer::GetAverageTime ( )

inline

Get average time without printing it.

Definition at line 105 of file SimpleTimer.h.

    {
        double endTime = FPlatformTime::Seconds();
        float milliseconds = (endTime - startTime) * 1000;
 
        totalMilliseconds += milliseconds;
        ++counter;
        double currentAvg = totalMilliseconds / counter;
 
        return currentAvg;
    }

References counter, startTime, and totalMilliseconds.

Referenced by PrintAverageTime().

PrintAverageTime()

double SimpleTimer::PrintAverageTime ( FString  prefix = "Average execution time ", FString  suffix = " milliseconds", bool  printToScreen = false  )

inline

print current average execution time.

Parameters

printToScreen	should message be printed on the screen. Default false.
prefix	Message prefix as FString.
suffix	Message suffix as FString.

Definition at line 123 of file SimpleTimer.h.

    {
        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;
    }

References GetAverageTime().

Referenced by ALidarManager::TickParallel().

Reset()

void SimpleTimer::Reset ( )

inline

Reset timer

Definition at line 65 of file SimpleTimer.h.

    {
        TakeTimeStamp();
 
        totalMilliseconds = 0.0;
        counter = 0;
    }

References counter, TakeTimeStamp(), and totalMilliseconds.

ResetAverageTime()

void SimpleTimer::ResetAverageTime ( )

inline

Definition at line 141 of file SimpleTimer.h.

    {
        totalMilliseconds = 0.0;
        counter = 0;
    }

References counter, and totalMilliseconds.

Referenced by ALidarManager::RemoveRaycastLidar().

StopTimer()

void SimpleTimer::StopTimer ( FString  prefix = "Code executed in ", FString  suffix = " milliseconds", bool  printToScreen = false  )

inline

Stop the timer and print result.

Parameters

printToScreen	should message be printed on the screen. Default false.
prefix	Message prefix as FString.
suffix	Message suffix as FString.

Definition at line 87 of file SimpleTimer.h.

    {
        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));
        }
    }

References startTime.

TakeTimeStamp()

void SimpleTimer::TakeTimeStamp ( )

inline

Take current timestamp

Definition at line 76 of file SimpleTimer.h.

    {
        startTime = FPlatformTime::Seconds();
    }

References startTime.

Referenced by Reset(), SimpleTimer(), and ALidarManager::TickParallel().

Member Data Documentation

counter

int SimpleTimer::counter = 0

private

Definition at line 151 of file SimpleTimer.h.

Referenced by GetAverageTime(), Reset(), and ResetAverageTime().

startTime

double SimpleTimer::startTime

private

Definition at line 149 of file SimpleTimer.h.

Referenced by GetAverageTime(), StopTimer(), and TakeTimeStamp().

totalMilliseconds

double SimpleTimer::totalMilliseconds = 0.0

private

Definition at line 150 of file SimpleTimer.h.

Referenced by GetAverageTime(), Reset(), and ResetAverageTime().

---

The documentation for this class was generated from the following file:

• Unreal/Agrarsense/Source/Agrarsense/Debugging/SimpleTimer.h