Class ProfilerIndexStatGroup

Represents a profiler stat group defined in profiler stat metadata.

Hierarchy

FrameworkObject
- ProfilerIndexStatGroup

Index

Constructors

Methods

getIndex getName getNextStatTimeNanoseconds getStatsIdentifiersInGroup getStatsInGroup

Constructors

`Protected`constructor

new ProfilerIndexStatGroup(isInternalConstructor?): ProfilerIndexStatGroup
Parameters
- OptionalisInternalConstructor: boolean
Returns ProfilerIndexStatGroup
Overrides FrameworkObject.constructor

Methods

getIndex

getIndex(): ProfilerIndex
Returns profiler index to which this stat group belongs.

Returns ProfilerIndex
Profiler index that created this stat group.

getName

getName(): string
Returns the name of the stat group.

Returns string
Name of the stat group.

getNextStatTimeNanoseconds

getNextStatTimeNanoseconds(currentNanoseconds?): number
Returns the next time after the given time where some of the stats changes the value (so that stat point needs to be displayed).
Parameters
- OptionalcurrentNanoseconds: number
  The time from which to start the search for changes (this time being excluded).
Returns number
Returns the next time where the value of any of the stat changes. Returns 0 if there is not change after that.

getStatsIdentifiersInGroup

getStatsIdentifiersInGroup(): ProfilerDatabaseIdentifier[]
Returns identifiers of all stats belonging to this group.

Returns ProfilerDatabaseIdentifier[]
Stat identifiers for all stats in given group.

getStatsInGroup

getStatsInGroup(): ProfilerIndexStat[]
Returns index instances of all stats belonging to this group.

Returns ProfilerIndexStat[]
Stat instances for all stats in given group.