FStatsTreeElement Class Reference

#include <StatsHierarchical.h>

Public Member Functions
CORE_API	FStatsTreeElement ()
CORE_API FName	GetFName () const
CORE_API FString	GetName () const
CORE_API FString	GetPath () const
CORE_API uint32	Num (bool bInclusive=false) const
CORE_API uint32	TotalCycles (bool bInclusive=true) const
CORE_API uint32	MaxCycles (bool bInclusive=true) const
CORE_API double	TotalSeconds (bool bInclusive=true) const
CORE_API double	AverageSeconds (bool bInclusive=true) const
CORE_API double	Contribution (bool bAgainstMaximum=false, bool bInclusive=true) const
CORE_API const TArray< TSharedPtr< FStatsTreeElement > > &	GetChildren () const

Protected Member Functions
CORE_API FStatsTreeElement *	FindChild (const FString &InPath)
CORE_API void	UpdatePostMeasurement (double InCyclesPerTimerToRemove=0)

Protected Attributes
FName	Name
FString	Path
uint32	Invocations
uint32	Cycles
uint32	CyclesOfChildren
double	RatioAgainstTotalInclusive
double	RatioAgainstTotalExclusive
double	RatioAgainstMaximumInclusive
double	RatioAgainstMaximumExclusive
TArray< TSharedPtr< FStatsTreeElement > >	Children

Friends
class	FStatsHierarchical
class	FStatsHierarchicalClient

Detailed Description

An element in a profiling / stats tree

The FStatsTreeElement represents a single node in a profiling tree. Each element contains a description including its name, path (invocation path / call-stack) and its duration in system cycles.

Constructor & Destructor Documentation

FStatsTreeElement()

FStatsTreeElement::FStatsTreeElement

(

)

Member Function Documentation

AverageSeconds()

double FStatsTreeElement::AverageSeconds

(

bool

bInclusive = true

)

const

Contribution()

double FStatsTreeElement::Contribution	(	bool	bAgainstMaximum = false,
		bool	bInclusive = true
	)		const

FindChild()

FStatsTreeElement * FStatsTreeElement::FindChild ( const FString &  InPath )

protected

GetChildren()

const TArray< TSharedPtr< FStatsTreeElement > > & FStatsTreeElement::GetChildren

(

)

const

GetFName()

FName FStatsTreeElement::GetFName

(

)

const

GetName()

FString FStatsTreeElement::GetName

(

)

const

GetPath()

FString FStatsTreeElement::GetPath

(

)

const

MaxCycles()

uint32 FStatsTreeElement::MaxCycles

(

bool

bInclusive = true

)

const

Num()

uint32 FStatsTreeElement::Num

(

bool

bInclusive = false

)

const

TotalCycles()

uint32 FStatsTreeElement::TotalCycles

(

bool

bInclusive = true

)

const

TotalSeconds()

double FStatsTreeElement::TotalSeconds

(

bool

bInclusive = true

)

const

UpdatePostMeasurement()

void FStatsTreeElement::UpdatePostMeasurement ( double  InCyclesPerTimerToRemove = 0 )

protected

Friends And Related Symbol Documentation

FStatsHierarchical

friend class FStatsHierarchical

friend

FStatsHierarchicalClient

friend class FStatsHierarchicalClient

friend

Member Data Documentation

Children

TArray<TSharedPtr<FStatsTreeElement> > FStatsTreeElement::Children

protected

Cycles

uint32 FStatsTreeElement::Cycles

protected

CyclesOfChildren

uint32 FStatsTreeElement::CyclesOfChildren

protected

Invocations

uint32 FStatsTreeElement::Invocations

protected

Name

FName FStatsTreeElement::Name

protected

Path

FString FStatsTreeElement::Path

protected

RatioAgainstMaximumExclusive

double FStatsTreeElement::RatioAgainstMaximumExclusive

protected

RatioAgainstMaximumInclusive

double FStatsTreeElement::RatioAgainstMaximumInclusive

protected

RatioAgainstTotalExclusive

double FStatsTreeElement::RatioAgainstTotalExclusive

protected

RatioAgainstTotalInclusive

double FStatsTreeElement::RatioAgainstTotalInclusive

protected

---

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

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