RixStats::SimpleStat Class Reference

Add a generic statistic via a subclass of the SimpleStat class interface. More...

#include <RixInterfaces.h>

Public Types
enum	Fmt {   k_fmtAsTimeInterval, k_fmtAsMemory, k_fmtAsUInt, k_fmtAsInt,   k_fmtAsFloat }

Public Member Functions
virtual	~SimpleStat ()
virtual void	Reset ()=0
virtual const char *	GetName ()=0
virtual const char *	GetDescription ()=0
virtual void	GetResults (uint64_t *result, Fmt *fmt)=0

Detailed Description

Add a generic statistic via a subclass of the SimpleStat class interface.

Rix takes ownership of the SimpleStat object and may destroy the object when the Rix session changes state. A duplicate call with the same name as a previously added statistic is ignored and will be deleted. We use uint64_t as the information exchange since it is both portable and can hold large numbers. AddSimpleStat returns 0 on success, non-zero on failure.

Member Enumeration Documentation

Fmt

enum RixStats::SimpleStat::Fmt

Enumerator
k_fmtAsTimeInterval
k_fmtAsMemory
k_fmtAsUInt
k_fmtAsInt
k_fmtAsFloat

Constructor & Destructor Documentation

~SimpleStat()

virtual RixStats::SimpleStat::~SimpleStat ( )

inlinevirtual

Member Function Documentation

GetDescription()

virtual const char* RixStats::SimpleStat::GetDescription ( )

pure virtual

GetName()

virtual const char* RixStats::SimpleStat::GetName ( )

pure virtual

GetResults()

virtual void RixStats::SimpleStat::GetResults ( uint64_t *  result, Fmt *  fmt  )

pure virtual

Reset()

virtual void RixStats::SimpleStat::Reset ( )

pure virtual

---

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

• RixInterfaces.h