omegalib  13.1
omega::Stat Class Reference

#include <StatsManager.h>

Public Member Functions

 Stat (StatsManager *owner)
 
virtual ~Stat ()
 
const StringgetName ()
 
bool isValid ()
 
void startTiming ()
 Starts timing this statistic. Valid only for Time type stats. More...
 
void stopTiming ()
 Stops timing this statistic and adds a sample of the elapsed time (since startTiming was called) in milliseconds. More...
 
void addSample (double sample)
 
StatsManager::StatType getType ()
 
int getNumSamples ()
 
float getCur ()
 
float getMin ()
 
float getMax ()
 
float getAvg ()
 
float getTotal ()
 
void setMask (uint m)
 
uint getMask ()
 
void setColor (const Color &color)
 
const ColorgetColor ()
 
- Public Member Functions inherited from omicron::ReferenceType
 ReferenceType ()
 
virtual ~ReferenceType ()
 
void ref ()
 
void unref ()
 
long refCount ()
 

Static Public Member Functions

static Statcreate (const String &name, StatsManager::StatType type)
 Creation method, for consistency with python API. More...
 
static Statfind (const String &name)
 Additional 'creation' method used to find an existing Stat object. More...
 
- Static Public Member Functions inherited from omicron::ReferenceType
static void printObjCounts ()
 

Friends

class StatsManager
 

Additional Inherited Members

- Static Protected Attributes inherited from omicron::ReferenceType
static List< ReferenceType * > mysObjList
 
+ Inheritance diagram for omega::Stat:

Constructor & Destructor Documentation

omega::Stat::Stat ( StatsManager owner)
inline
omega::Stat::~Stat ( )
inlinevirtual

Member Function Documentation

void omega::Stat::addSample ( double  sample)
inline
static Stat* omega::Stat::create ( const String name,
StatsManager::StatType  type 
)
static

Creation method, for consistency with python API.

static Stat* omega::Stat::find ( const String name)
static

Additional 'creation' method used to find an existing Stat object.

Put in the Stat class for ease-of-use from python scripts.

float omega::Stat::getAvg ( )
inline
const Color& omega::Stat::getColor ( )
inline
float omega::Stat::getCur ( )
inline
uint omega::Stat::getMask ( )
inline
float omega::Stat::getMax ( )
inline
float omega::Stat::getMin ( )
inline
const String & omega::Stat::getName ( )
inline
int omega::Stat::getNumSamples ( )
inline
float omega::Stat::getTotal ( )
inline
StatsManager::StatType omega::Stat::getType ( )
inline
bool omega::Stat::isValid ( )
inline
void omega::Stat::setColor ( const Color color)
inline
void omega::Stat::setMask ( uint  m)
inline
void omega::Stat::startTiming ( )
inline

Starts timing this statistic. Valid only for Time type stats.

void omega::Stat::stopTiming ( )
inline

Stops timing this statistic and adds a sample of the elapsed time (since startTiming was called) in milliseconds.

Valid only for Time type stats.

Friends And Related Function Documentation

friend class StatsManager
friend

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