Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | List of all members
SoPerfCounter Class Referenceabstract
Inventor » General

Abstract base class for Performance Counter. More...

#include <Inventor/stats/SoPerfCounter.h>

+ Inheritance diagram for SoPerfCounter:

Public Types

enum  LevelEnum {
  LOW = 0 ,
  MEDIUM = 1 ,
  HIGH = 2
}
 Various levels for a counter. More...
 
typedef double SoPerfCounterValue
 

Public Member Functions

virtual void reset ()=0
 Reset the counter.
 
virtual SoType getTypeId () const
 Returns the type of current instance.
 
const char * getName ()
 Returns the name of current counter;.
 
SoNONUNICODE const char * getDescription ()
 Returns the description of current counter;.
 
SbString getStringDescription ()
 Returns the description of current counter;.
 
SoPerfCounterValue getValue ()
 Returns the value of the counter.
 
virtual void setValue (SoPerfCounterValue value)
 Set the counter value.
 
void setScale (SoPerfCounterValue scale)
 Sets the scale factor.
 
SoPerfCounterValue getScale () const
 Returns the scale factor.
 
SbString getType () const
 Returns the type of the counter.
 
SbString getModule () const
 Returns the module of the counter.
 
SbString getStringLevel () const
 Returns the level of the counter.
 
int getLevel () const
 Returns the level of the counter.
 
bool isCustom () const
 Returns TRUE if the counter results of an operation between other counters.
 
SbName getFirstParent () const
 Returns the name of the first parent.
 
SbName getSecondParent () const
 Returns the name of the second parent.
 
void setFirstParent (SbName firstParent)
 Sets the name of the first parent.
 
void setSecondParent (SbName secondParent)
 Sets the name of the second parent.
 
SbString getOperation () const
 Returns the operation made between the two parents.
 
void setOperation (SbString operation)
 Sets the operation made between the two parents.
 
virtual void increment (SoPerfCounterValue value)
 Increments/Decrements counter value by 'value'.
 
virtual void decrement (SoPerfCounterValue value)
 
void setID (int id)
 Sets/Gets counter id.
 
int getID ()
 
void setEnable (bool e)
 Sets/Gets the use state.
 
bool isEnabled ()
 

Static Public Member Functions

static SoType getClassTypeId ()
 Returns the Type of current class.
 

Detailed Description

Abstract base class for Performance Counter.

Defines the basic methods to define a performance counter.

SEE ALSO

SoPerfCounterManager

Definition at line 43 of file SoPerfCounter.h.

Member Typedef Documentation

◆ SoPerfCounterValue

typedef double SoPerfCounter::SoPerfCounterValue

Definition at line 47 of file SoPerfCounter.h.

Member Enumeration Documentation

◆ LevelEnum

enum SoPerfCounter::LevelEnum

Various levels for a counter.

Since Open Inventor 8.1

Enumerator
LOW 
MEDIUM 
HIGH 

Definition at line 191 of file SoPerfCounter.h.

Member Function Documentation

◆ decrement()

virtual void SoPerfCounter::decrement ( SoPerfCounterValue  value)
inlinevirtual

Definition at line 173 of file SoPerfCounter.h.

◆ getClassTypeId()

static SoType SoPerfCounter::getClassTypeId ( )
static

Returns the Type of current class.

◆ getDescription()

SoNONUNICODE const char * SoPerfCounter::getDescription ( )
inline

Returns the description of current counter;.

Non Unicode: This function should not be used in a Unicode application.

Definition at line 74 of file SoPerfCounter.h.

◆ getFirstParent()

SbName SoPerfCounter::getFirstParent ( ) const
inline

Returns the name of the first parent.

Since Open Inventor 8.1

Definition at line 137 of file SoPerfCounter.h.

◆ getID()

int SoPerfCounter::getID ( )
inline

Definition at line 179 of file SoPerfCounter.h.

◆ getLevel()

int SoPerfCounter::getLevel ( ) const
inline

Returns the level of the counter.

Since Open Inventor 8.1

Definition at line 125 of file SoPerfCounter.h.

◆ getModule()

SbString SoPerfCounter::getModule ( ) const
inline

Returns the module of the counter.

Since Open Inventor 8.1

Definition at line 113 of file SoPerfCounter.h.

◆ getName()

const char * SoPerfCounter::getName ( )
inline

Returns the name of current counter;.

Definition at line 67 of file SoPerfCounter.h.

◆ getOperation()

SbString SoPerfCounter::getOperation ( ) const
inline

Returns the operation made between the two parents.

Since Open Inventor 8.1

Definition at line 161 of file SoPerfCounter.h.

◆ getScale()

SoPerfCounterValue SoPerfCounter::getScale ( ) const
inline

Returns the scale factor.

Since Open Inventor 8.1

Definition at line 101 of file SoPerfCounter.h.

◆ getSecondParent()

SbName SoPerfCounter::getSecondParent ( ) const
inline

Returns the name of the second parent.

Since Open Inventor 8.1

Definition at line 143 of file SoPerfCounter.h.

◆ getStringDescription()

SbString SoPerfCounter::getStringDescription ( )
inline

Returns the description of current counter;.

Definition at line 79 of file SoPerfCounter.h.

◆ getStringLevel()

SbString SoPerfCounter::getStringLevel ( ) const

Returns the level of the counter.

Since Open Inventor 8.1

◆ getType()

SbString SoPerfCounter::getType ( ) const
inline

Returns the type of the counter.

Since Open Inventor 8.1

Definition at line 107 of file SoPerfCounter.h.

◆ getTypeId()

virtual SoType SoPerfCounter::getTypeId ( ) const
virtual

Returns the type of current instance.

◆ getValue()

SoPerfCounterValue SoPerfCounter::getValue ( )

Returns the value of the counter.

◆ increment()

virtual void SoPerfCounter::increment ( SoPerfCounterValue  value)
inlinevirtual

Increments/Decrements counter value by 'value'.

Definition at line 172 of file SoPerfCounter.h.

◆ isCustom()

bool SoPerfCounter::isCustom ( ) const
inline

Returns TRUE if the counter results of an operation between other counters.

Since Open Inventor 8.1

Definition at line 131 of file SoPerfCounter.h.

◆ isEnabled()

bool SoPerfCounter::isEnabled ( )
inline

Definition at line 185 of file SoPerfCounter.h.

◆ reset()

virtual void SoPerfCounter::reset ( )
pure virtual

Reset the counter.

Implemented in SoPerfAccumCounter, and SoPerfStateCounter.

◆ setEnable()

void SoPerfCounter::setEnable ( bool  e)
inline

Sets/Gets the use state.

Definition at line 184 of file SoPerfCounter.h.

◆ setFirstParent()

void SoPerfCounter::setFirstParent ( SbName  firstParent)
inline

Sets the name of the first parent.

Since Open Inventor 8.1

Definition at line 149 of file SoPerfCounter.h.

◆ setID()

void SoPerfCounter::setID ( int  id)
inline

Sets/Gets counter id.

Definition at line 178 of file SoPerfCounter.h.

◆ setOperation()

void SoPerfCounter::setOperation ( SbString  operation)
inline

Sets the operation made between the two parents.

Since Open Inventor 8.1

Definition at line 167 of file SoPerfCounter.h.

◆ setScale()

void SoPerfCounter::setScale ( SoPerfCounterValue  scale)
inline

Sets the scale factor.

Since Open Inventor 8.1

Definition at line 95 of file SoPerfCounter.h.

◆ setSecondParent()

void SoPerfCounter::setSecondParent ( SbName  secondParent)
inline

Sets the name of the second parent.

Since Open Inventor 8.1

Definition at line 155 of file SoPerfCounter.h.

◆ setValue()

virtual void SoPerfCounter::setValue ( SoPerfCounterValue  value)
inlinevirtual

Set the counter value.

Definition at line 89 of file SoPerfCounter.h.

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