SoPerfCounter Class Reference

Abstract base class for Performance Counter. More...

#include <Inventor/stats/SoPerfCounter.h>

Inheritance diagram for SoPerfCounter:
SoPerfAccumCounter SoPerfStateCounter

List of all members.

Public Types

enum  LevelEnum {
  LOW = 0,
  MEDIUM = 1,
  HIGH = 2
}
typedef double SoPerfCounterValue

Public Member Functions

virtual void reset ()=0
virtual SoType getTypeId () const
const char * getName ()
SoNONUNICODE const char * getDescription ()
SbString getStringDescription ()
SoPerfCounterValue getValue ()
virtual void setValue (SoPerfCounterValue value)
void setScale (SoPerfCounterValue scale)
SoPerfCounterValue getScale () const
SbString getType () const
SbString getModule () const
SbString getStringLevel () const
int getLevel () const
bool isCustom () const
SbName getFirstParent () const
SbName getSecondParent () const
void setFirstParent (SbName firstParent)
void setSecondParent (SbName secondParent)
SbString getOperation () const
void setOperation (SbString operation)
virtual void increment (SoPerfCounterValue value)
virtual void decrement (SoPerfCounterValue value)
void setID (int id)
int getID ()
void setEnable (bool e)
bool isEnabled ()

Static Public Member Functions

static SoType getClassTypeId ()

Detailed Description

Abstract base class for Performance Counter.

Defines the basic methods to define a performance counter.

SEE ALSO

SoPerfCounterManager


Member Typedef Documentation


Member Enumeration Documentation

Various levels for a counter. Since Open Inventor 8.1

Enumerator:
LOW 
MEDIUM 
HIGH 

Member Function Documentation

virtual void SoPerfCounter::decrement ( SoPerfCounterValue  value  )  [inline, virtual]
static SoType SoPerfCounter::getClassTypeId (  )  [static]

Returns the Type of current class.

SoNONUNICODE const char* SoPerfCounter::getDescription (  )  [inline]

Returns the description of current counter;.

Non Unicode List:
This function should not be used in a Unicode application.
SbName SoPerfCounter::getFirstParent (  )  const [inline]

Returns the name of the first parent. Since Open Inventor 8.1

int SoPerfCounter::getID (  )  [inline]
int SoPerfCounter::getLevel (  )  const [inline]

Returns the level of the counter. Since Open Inventor 8.1

SbString SoPerfCounter::getModule (  )  const [inline]

Returns the module of the counter. Since Open Inventor 8.1

const char* SoPerfCounter::getName (  )  [inline]

Returns the name of current counter;.

SbString SoPerfCounter::getOperation (  )  const [inline]

Returns the operation made between the two parents. Since Open Inventor 8.1

SoPerfCounterValue SoPerfCounter::getScale (  )  const [inline]

Returns the scale factor. Since Open Inventor 8.1

SbName SoPerfCounter::getSecondParent (  )  const [inline]

Returns the name of the second parent. Since Open Inventor 8.1

SbString SoPerfCounter::getStringDescription (  )  [inline]

Returns the description of current counter;.

SbString SoPerfCounter::getStringLevel (  )  const

Returns the level of the counter. Since Open Inventor 8.1

SbString SoPerfCounter::getType (  )  const [inline]

Returns the type of the counter. Since Open Inventor 8.1

virtual SoType SoPerfCounter::getTypeId (  )  const [virtual]

Returns the type of current instance.

SoPerfCounterValue SoPerfCounter::getValue (  ) 

Returns the value of the counter.

virtual void SoPerfCounter::increment ( SoPerfCounterValue  value  )  [inline, virtual]

Increments/Decrements counter value by 'value'.

bool SoPerfCounter::isCustom (  )  const [inline]

Returns TRUE if the counter results of an operation between other counters. Since Open Inventor 8.1

bool SoPerfCounter::isEnabled (  )  [inline]
virtual void SoPerfCounter::reset (  )  [pure virtual]

Reset the counter.

Implemented in SoPerfAccumCounter, and SoPerfStateCounter.

void SoPerfCounter::setEnable ( bool  e  )  [inline]

Sets/Gets the use state.

void SoPerfCounter::setFirstParent ( SbName  firstParent  )  [inline]

Sets the name of the first parent. Since Open Inventor 8.1

void SoPerfCounter::setID ( int  id  )  [inline]

Sets/Gets counter id.

void SoPerfCounter::setOperation ( SbString  operation  )  [inline]

Sets the operation made between the two parents. Since Open Inventor 8.1

void SoPerfCounter::setScale ( SoPerfCounterValue  scale  )  [inline]

Sets the scale factor. Since Open Inventor 8.1

void SoPerfCounter::setSecondParent ( SbName  secondParent  )  [inline]

Sets the name of the second parent. Since Open Inventor 8.1

virtual void SoPerfCounter::setValue ( SoPerfCounterValue  value  )  [inline, virtual]

Set the counter value.


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

Open Inventor Toolkit reference manual, generated on 15 Mar 2023
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/