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 {   SECONDS,   MILLISECONDS,   MICROSECONDS }

Public Member Functions
	CYIProfileData ()
void	Reset ()
void	Init (const CYIString &name)
void	ConfigureAvgWindow (uint32_t uWindow)
void	MarkBegin ()
void	MarkEnd ()
void	MarkDelta (uint64_t uDelta)
uint64_t	Min () const
uint64_t	Max () const
float	Avg () const
uint64_t	Total () const
uint64_t	GetLastSample () const
uint32_t	GetSampleCnt () const
CYIString	Report (ACCURACY eAccuracy=MILLISECONDS) const
CYIString	ReportXML (ACCURACY eAccuracy=MILLISECONDS) const
float	AvgDutyCycle () const
float	AvgPeriod () const
float	CalculateFPS () const

Member Enumeration Documentation

enum CYIProfileData::ACCURACY

Enumerator
SECONDS
MILLISECONDS
MICROSECONDS

Constructor & Destructor Documentation

CYIProfileData::CYIProfileData

(

)

Member Function Documentation

float CYIProfileData::Avg ( ) const

inline

float CYIProfileData::AvgDutyCycle ( ) const

inline

float CYIProfileData::AvgPeriod ( ) const

inline

float CYIProfileData::CalculateFPS

(

)

const

void CYIProfileData::ConfigureAvgWindow

(

uint32_t

uWindow

)

uint64_t CYIProfileData::GetLastSample ( ) const

inline

uint32_t CYIProfileData::GetSampleCnt ( ) const

inline

void CYIProfileData::Init

(

const CYIString &

name

)

void CYIProfileData::MarkBegin

(

)

void CYIProfileData::MarkDelta

(

uint64_t

uDelta

)

void CYIProfileData::MarkEnd

(

)

uint64_t CYIProfileData::Max ( ) const

inline

uint64_t CYIProfileData::Min ( ) const

inline

CYIString CYIProfileData::Report

(

ACCURACY

eAccuracy = MILLISECONDS

)

const

CYIString CYIProfileData::ReportXML

(

ACCURACY

eAccuracy = MILLISECONDS

)

const

void CYIProfileData::Reset

(

)

Zeroes all the data stored for this profile

uint64_t CYIProfileData::Total ( ) const

inline

---

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

• utility/YiProfileData.h