SoPerfCounterManager Class Reference

Performance Counter Manager. More...

#include <Inventor/stats/SoPerfCounterManager.h>

Public Member Functions
void	resetAll ()
	Resets all counters.
void	removeDisabledCounters () const
	Removes disabled counters.
SoPerfCounter *	getCounter (SbName name)
	Get the instance of a specific counter.
void	setInterval (const SbTime &intvl)
	Sets the refresh counter rate.
SbTime	getInterval ()
	Gets the refresh counter rate.
void	log ()
	Logs counter in an output file.
void	update ()
	Logs counter in defined output and reset counters.

Static Public Member Functions
static SoPerfCounterManager *	getInstance ()
	Returns the existing instance.
static SbBool	isEnabled ()
	Returns TRUE if performance counting is activated.
static SbBool	registerCounter (SoPerfCounter *)
	Register a new SoPerfCounter to the performance counter manager.
static SoPerfCounter *	disableCounter (SbName name)
	Disable a SoPerfCounter from logging by the performance counter manager.

Detailed Description

Performance Counter Manager.

Manage a set of predefined and user defined performance counters (SoPerfCounter).

SEE ALSO

SoPerfCounter

Definition at line 47 of file SoPerfCounterManager.h.

Member Function Documentation

disableCounter()

static SoPerfCounter * SoPerfCounterManager::disableCounter ( SbName  name )

static

Disable a SoPerfCounter from logging by the performance counter manager.

Returns NULL if the counter is not existing (by name).

getCounter()

SoPerfCounter * SoPerfCounterManager::getCounter

(

SbName

name

)

Get the instance of a specific counter.

Returns NULL if the counter has not been registered.

getInstance()

static SoPerfCounterManager * SoPerfCounterManager::getInstance ( )

static

Returns the existing instance.

getInterval()

SbTime SoPerfCounterManager::getInterval

(

)

Gets the refresh counter rate.

A 0 (zero) value means the embedded performance schedule reporting is disabled.

isEnabled()

static SbBool SoPerfCounterManager::isEnabled ( )

static

Returns TRUE if performance counting is activated.

see OIV_PERFCOUNTER_ENABLE SoPreferences variables to activate it.

log()

void SoPerfCounterManager::log

(

)

Logs counter in an output file.

registerCounter()

static SbBool SoPerfCounterManager::registerCounter ( SoPerfCounter *  )

static

Register a new SoPerfCounter to the performance counter manager.

Adding an existing counter (by name), the perf counter registering fails. Calling this method doesn't imply the manager is working with the counter: to start to work with this counter you have to call the getCounter() method. Passed SoPerfCounter pointer must be allocated using new() operator. If the given coutner alreday exists it will be deleted when registerCounter returns.

removeDisabledCounters()

void SoPerfCounterManager::removeDisabledCounters

(

)

const

Removes disabled counters.

Since Open Inventor 8.1

resetAll()

void SoPerfCounterManager::resetAll

(

)

Resets all counters.

setInterval()

void SoPerfCounterManager::setInterval

(

const SbTime &

intvl

)

Sets the refresh counter rate.

Passing SbTime(0) disables the embedded performance schedule reporting.

update()

void SoPerfCounterManager::update

(

)

Logs counter in defined output and reset counters.

---

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

• Inventor/stats/SoPerfCounterManager.h