FStatsTreeElement

An element in a profiling / stats tree

Choose your operating system:

Windows

macOS

Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Stats/StatsHierarchical.h

Include

#include "Stats/StatsHierarchical.h"

Syntax

class FStatsTreeElement

Remarks

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.

Variables

Name Description

Protected variable

TArray< TShared...

 

Children

Children of the tree

Protected variable

uint32

 

Cycles

Protected variable

uint32

 

CyclesOfChildren

Derived data (computed by UpdatePoseMeasurement)

Protected variable

uint32

 

Invocations

Protected variable

FName

 

Name

Protected variable

FString

 

Path

Protected variable

double

 

RatioAgainstMaximumExclusive

Protected variable

double

 

RatioAgainstMaximumInclusive

Protected variable

double

 

RatioAgainstTotalExclusive

Protected variable

double

 

RatioAgainstTotalInclusive

Constructors

Name Description

Public function

FStatsTreeElement()

Default constructor.

Functions

Name Description

Public function Const

double

 

AverageSeconds

(
    bool bInclusive
)

Returns the average number of seconds recorded (total / num)

Public function Const

double

 

Contribution

(
    bool bAgainstMaximum,
    bool bInclusive
)

Returns the contribution between 0.0 and 1.0 within the parent element.

Protected function

FStatsTreeEl...

 

FindChild

(
    const FString& InPath
)

Returns the child or nullptr based on a given path

Public function Const

const TArray...

 

GetChildren()

Returns all child elements.

Public function Const

FName

 

GetFName()

Returns the name of this element.

Public function Const

FString

 

GetName()

Returns the name of this element as a FString.

Public function Const

FString

 

GetPath()

Returns the invocation path of this element.

Public function Const

uint32

 

MaxCycles

(
    bool bInclusive
)

Returns the number of maximum cycles for this element (and children)

Public function Const

uint32

 

Num

(
    bool bInclusive
)

Returns the number of invocations collected into this element

Public function Const

uint32

 

TotalCycles

(
    bool bInclusive
)

Returns the total number of cycles recorded

Public function Const

double

 

TotalSeconds

(
    bool bInclusive
)

Returns the total number of seconds recorded

Protected function

void

 

UpdatePostMeasurement

(
    double InCyclesPerTimerToRemove
)