StatBag

Scaleform::StatBag

Declaration

class StatBag;

Description

StatBag represents a bag, or collection of statistics data. Any type of Stat can be added into the bag; after statistics data is added it can be iterated through with Iterator class, obtained from GetIterator.

Methods

Method	Description
Add	Adds statistical value of a certain id.
AddMemoryStat	Optimization function for the memory statistics.
Clear	Clears out the stat bag, removing all states.
GetInterface	Obtains the interface for retrieving the statistics of a group and returns the interface identified by type such as logical group, sum group, auto sum group.
GetIterator	Obtains an Iterator for the specified stat group. Default implementation will return all of the stats in the bag.
GetStat	Obtains the statistics in a bag.
IncrementMemoryStat	Optimization function for memory heap statistics.
Reset	Resets statistics values, usually causing peaks to be recorded.
SetMax	Sets the maximum statistics value of a certain id in a stat bag.
SetMin	Sets the minimum statistics value in a certain id in a stat bag.
StatBag	Creates a stat bag (collection of statistics data) with specified number of entries.
UpdateGroups	Updates all cumulative groups in the list.

Operators

Operator	Description
+=	Adds the statistics values of a different stat bag to the current stat bag.
=	Assigns the statistics value of a different stat bag to the current stat bag.

Structures

Structure	Description
Iterator	Iterator for iterating through the statistics data in the bag.

File

SF_Stats.h