Open 3D Engine AzCore API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::Statistics::StatisticsManager< StatIdType > Class Template Reference

A Collection of Running Statistics, addressable by a hashable class/primitive. e.g. AZ::Crc32, int, AZStd::string, etc. More...

#include <StatisticsManager.h>

Public Member Functions

 StatisticsManager (const StatisticsManager &other)
 
bool ContainsStatistic (const StatIdType &statId) const
 
AZ::u32 GetCount () const
 
void GetAllStatistics (AZStd::vector< NamedRunningStatistic * > &vector)
 
void GetAllStatisticsOfUnits (AZStd::vector< NamedRunningStatistic * > &vector, const char *units)
 
AZ::u32 ApplyUnits (const AZStd::string &units)
 Helper method to apply units to statistics with empty units string.
 
void Clear ()
 
NamedRunningStatisticGetStatistic (const StatIdType &statId)
 
NamedRunningStatisticAddStatistic (const StatIdType &statId, const bool failIfExist=true)
 Returns false if a NamedRunningStatistic with such id already exists.
 
NamedRunningStatisticAddStatistic (const StatIdType &statId, const AZStd::string &name, const AZStd::string &units, const bool failIfExist=true)
 Returns false if a NamedRunningStatistic with such id already exists.
 
virtual void RemoveStatistic (const StatIdType &statId)
 
void ResetStatistic (const StatIdType &statId)
 
void ResetAllStatistics ()
 
void PushSampleForStatistic (const StatIdType &statId, double value)
 
bool GetStatId (NamedRunningStatistic *searchStat, StatIdType &statIdOut) const
 Expensive function because it does a reverse lookup.
 

Detailed Description

template<class StatIdType = AZStd::string>
class AZ::Statistics::StatisticsManager< StatIdType >

A Collection of Running Statistics, addressable by a hashable class/primitive. e.g. AZ::Crc32, int, AZStd::string, etc.

Member Function Documentation

◆ GetStatistic()

template<class StatIdType = AZStd::string>
NamedRunningStatistic * AZ::Statistics::StatisticsManager< StatIdType >::GetStatistic ( const StatIdType &  statId)
inline

Returns nullptr if a statistic with such name doesn't exist, otherwise returns a pointer to the statistic.


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