You.i Engine
CYIProfileData Class Reference

Detailed Description

This class is used as a profiling or a measurement tool for recurring activities. By marking the beginning and the end of a particular activity, various statistics can be queried from this class.

Some of the basic statistics are the minimum, maximum and the average time it takes for the 'recurrent' activity.

#include <utility/YiProfileData.h>

Classes

class  Average
 

Public Types

enum  Accuracy {
  Accuracy::Seconds,
  Accuracy::Milliseconds,
  Accuracy::Microseconds
}
 

Public Member Functions

 CYIProfileData ()
 
void Reset ()
 
void Init (const CYIString &name)
 
void ConfigureAvgWindow (uint32_t window)
 
void MarkBegin ()
 
void MarkEnd ()
 
void MarkDelta (uint64_t delta)
 
uint64_t Min () const
 
uint64_t Max () const
 
float Avg () const
 
uint64_t Total () const
 
uint64_t GetLastSample () const
 
uint32_t GetSampleCnt () const
 
uint64_t GetLastPeriodLength () const
 
CYIString Report (Accuracy accuracy=Accuracy::Milliseconds) const
 
CYIString ReportXML (Accuracy accuracy=Accuracy::Milliseconds) const
 
float AvgDutyCycle () const
 
float AvgPeriod () const
 
float CalculateFPS () const
 

Member Enumeration Documentation

◆ Accuracy

Enumerator
Seconds 
Milliseconds 
Microseconds 

Constructor & Destructor Documentation

◆ CYIProfileData()

CYIProfileData::CYIProfileData ( )

Member Function Documentation

◆ Avg()

float CYIProfileData::Avg ( ) const
inline

◆ AvgDutyCycle()

float CYIProfileData::AvgDutyCycle ( ) const
inline

◆ AvgPeriod()

float CYIProfileData::AvgPeriod ( ) const
inline

◆ CalculateFPS()

float CYIProfileData::CalculateFPS ( ) const

◆ ConfigureAvgWindow()

void CYIProfileData::ConfigureAvgWindow ( uint32_t  window)

◆ GetLastPeriodLength()

uint64_t CYIProfileData::GetLastPeriodLength ( ) const
inline

◆ GetLastSample()

uint64_t CYIProfileData::GetLastSample ( ) const
inline

◆ GetSampleCnt()

uint32_t CYIProfileData::GetSampleCnt ( ) const
inline

◆ Init()

void CYIProfileData::Init ( const CYIString name)

◆ MarkBegin()

void CYIProfileData::MarkBegin ( )

◆ MarkDelta()

void CYIProfileData::MarkDelta ( uint64_t  delta)

◆ MarkEnd()

void CYIProfileData::MarkEnd ( )

◆ Max()

uint64_t CYIProfileData::Max ( ) const
inline

◆ Min()

uint64_t CYIProfileData::Min ( ) const
inline

◆ Report()

CYIString CYIProfileData::Report ( Accuracy  accuracy = Accuracy::Milliseconds) const

◆ ReportXML()

CYIString CYIProfileData::ReportXML ( Accuracy  accuracy = Accuracy::Milliseconds) const

◆ Reset()

void CYIProfileData::Reset ( )

Zeroes all the data stored for this profile

◆ Total()

uint64_t CYIProfileData::Total ( ) const
inline

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