FConditionalScopeLogTime Struct Reference

#include <StatsMisc.h>

Inheritance diagram for FConditionalScopeLogTime:

Public Types
enum	EScopeLogTimeUnits { ScopeLog_DontLog , ScopeLog_Milliseconds , ScopeLog_Seconds }

Public Member Functions
CORE_API	FConditionalScopeLogTime (bool bCondition, const WIDECHAR *InName, FTotalTimeAndCount *InCumulative=nullptr, EScopeLogTimeUnits InUnits=ScopeLog_Milliseconds)
CORE_API	FConditionalScopeLogTime (bool bCondition, const ANSICHAR *InName, FTotalTimeAndCount *InCumulative=nullptr, EScopeLogTimeUnits InUnits=ScopeLog_Milliseconds)
CORE_API	~FConditionalScopeLogTime ()

Protected Member Functions
double	GetDisplayScopedTime (double InScopedTime) const
FString	GetDisplayUnitsString () const

Protected Attributes
const double	StartTime
const FString	Name
FTotalTimeAndCount *	Cumulative
EScopeLogTimeUnits	Units

Detailed Description

Utility class to log time passed in seconds, adding cumulative stats to passed in variable.

Member Enumeration Documentation

EScopeLogTimeUnits

enum FConditionalScopeLogTime::EScopeLogTimeUnits

Enumerator
ScopeLog_DontLog
ScopeLog_Milliseconds
ScopeLog_Seconds

Constructor & Destructor Documentation

FConditionalScopeLogTime() [1/2]

FConditionalScopeLogTime::FConditionalScopeLogTime	(	bool	bCondition,
		const WIDECHAR *	InName,
		FTotalTimeAndCount *	InCumulative = nullptr,
		EScopeLogTimeUnits	InUnits = ScopeLog_Milliseconds
	)

Initialization constructor.

Parameters

InName	- String that will be displayed in the log
InGlobal	- Pointer to the variable that holds the cumulative stats

FConditionalScopeLogTime() [2/2]

FConditionalScopeLogTime::FConditionalScopeLogTime	(	bool	bCondition,
		const ANSICHAR *	InName,
		FTotalTimeAndCount *	InCumulative = nullptr,
		EScopeLogTimeUnits	InUnits = ScopeLog_Milliseconds
	)

~FConditionalScopeLogTime()

FConditionalScopeLogTime::~FConditionalScopeLogTime

(

)

Destructor.

Member Function Documentation

GetDisplayScopedTime()

double FConditionalScopeLogTime::GetDisplayScopedTime ( double  InScopedTime ) const

protected

GetDisplayUnitsString()

FString FConditionalScopeLogTime::GetDisplayUnitsString ( ) const

protected

Member Data Documentation

Cumulative

FTotalTimeAndCount* FConditionalScopeLogTime::Cumulative

protected

Name

const FString FConditionalScopeLogTime::Name

protected

StartTime

const double FConditionalScopeLogTime::StartTime

protected

Units

EScopeLogTimeUnits FConditionalScopeLogTime::Units

protected

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/Core/Public/Stats/StatsMisc.h
• Engine/Source/Runtime/Core/Private/Stats/StatsMisc.cpp