FDetailedTickStats Struct Reference

#include <UnrealEngine.h>

Public Member Functions
	FDetailedTickStats (int32 InNumClassesToReport, float InTimeBetweenLogDumps, float InMinTimeBetweenLogDumps, float InTimesToReport, const TCHAR *InOperationPerformed)
virtual	~FDetailedTickStats ()
bool	BeginObject (UObject *Object)
void	EndObject (UObject *Object, float DeltaTime, bool bForSummary)
void	Reset ()
void	DumpStats ()
void	OnPreGarbageCollect ()

Detailed Description

Helper struct for gathering detailed per object tick stats.

Constructor & Destructor Documentation

FDetailedTickStats()

FDetailedTickStats::FDetailedTickStats	(	int32	InNumObjectsToReport,
		float	InTimeBetweenLogDumps,
		float	InMinTimeBetweenLogDumps,
		float	InTimesToReport,
		const TCHAR *	InOperationPerformed
	)

Constructor, initializing all members.

Constructor, private on purpose and initializing all members.

~FDetailedTickStats()

FDetailedTickStats::~FDetailedTickStats ( )

virtual

Destructor

Destructor, unregisters the GC callback

Member Function Documentation

BeginObject()

bool FDetailedTickStats::BeginObject

(

UObject *

Object

)

Starts tracking an object and returns whether it's a recursive call or not. If it is recursive the function will return false and EndObject should not be called on the object.

Parameters

Object

Object to track

Returns

false if object is already tracked and EndObject should NOT be called, true otherwise

DumpStats()

void FDetailedTickStats::DumpStats

(

)

Dump gathered stats informatoin to the log.

Dump gathered stats information to the log.

EndObject()

void FDetailedTickStats::EndObject	(	UObject *	Object,
		float	DeltaTime,
		bool	bForSummary
	)

Finishes tracking the object and updates the time spent.

Parameters

Object	Object to track
DeltaTime	Time we've been tracking it
bForSummary	Object should be used for high level summary

Add instance of object to stats

Parameters

Object	Object instance
DeltaTime	Time operation took this instance
bForSummary	Object should be used for high level summary

OnPreGarbageCollect()

void FDetailedTickStats::OnPreGarbageCollect ( )

inline

Delegate handler for pre garbage collect event

Reset()

void FDetailedTickStats::Reset

(

)

Reset stats to clean slate.

---

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

• Engine/Source/Runtime/Engine/Public/UnrealEngine.h
• Engine/Source/Runtime/Engine/Private/LevelTick.cpp