Kaim::PerformQueryStatistics Class Reference

#include <querystatistics.h>

Class Description

This class is not instantiated in databases when KY_BUILD_SHIPPING is defined It contains statistics on calls to PerformQuery() or PerformQueryWithInputCoordPos().

Note that some queries can call other queries internally.

Expected usage is:

 {
  PerformQueryStatistics* queryStats = database->GetPerformQueryStatistics()
  queryStats.ResetPerformQueryCounter();
  // ..
  // Several frames running
  // ..
  StringBuffer report;
  queryStats.Report(&report); // Give the total number of calls per PerformQueryStat per QueryType (not per frame)
} 

Public Member Functions
void	Report (StringBuffer *report, QueryStatReportType reportType=QueryStatReport_RelevantOnly) const
void	ResetPerformQueryCounter ()

Public Attributes
KyArray< KyUInt32 >	m_perQueryCounter
KyArray< PerformQueryStatCounter >	m_queryStatCounter

For internal use only
void	Initialize ()
void	IncrementPerformQueryStat (PerformQueryStat stat, QueryType queryType)
KyUInt32	GetPerformQueryStatCount (PerformQueryStat stat, QueryType queryType)
KyUInt32 &	GetPerformQueryCount (QueryType queryType)
static const char *	GetPerformQueryStatName (PerformQueryStat queryStat)

Member Function Documentation

static const char* Kaim::PerformQueryStatistics::GetPerformQueryStatName ( PerformQueryStat  queryStat )

static

Called by the Database.

void Kaim::PerformQueryStatistics::Report	(	StringBuffer *	report,
		QueryStatReportType	reportType = QueryStatReport_RelevantOnly
	)		const

The report will give the total number of calls per PerformQueryStat per QueryType (it is not reported per frame)

void Kaim::PerformQueryStatistics::ResetPerformQueryCounter

(

)

Call This to rest the counters.

Member Data Documentation

KyArray<KyUInt32> Kaim::PerformQueryStatistics::m_perQueryCounter

counter used to determine how many queries of a given QueryType were performed between two calls to ResetPerformQueryCounter()

KyArray<PerformQueryStatCounter> Kaim::PerformQueryStatistics::m_queryStatCounter

counter used to determine how many queries of a given QueryType associated to a specific Stat were performed between two calls to ResetPerformQueryCounter()

---

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

• gwnavruntime/database/querystatistics.h