SoPerfCounter.h

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2024 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : David BEILLOIN (Oct 2005)
**=======================================================================*/
 
 
#ifndef _SO_PERF_COUNTER_H_
#define _SO_PERF_COUNTER_H_
 
#include <Inventor/stats/SoSubPerfCounter.h>
#include <Inventor/threads/SbThreadMutex.h>
 
class  SoPerfCounter {
 
public:
 
  typedef double SoPerfCounterValue;
 
  virtual void reset() = 0;
 
  static SoType getClassTypeId();
 
  virtual SoType getTypeId() const;
 
  const char* getName() { return m_name.getString(); }
 
  SoNONUNICODE const char* getDescription() { return m_description.toLatin1(); }
 
   SbString getStringDescription() { return m_description; }
 
  SoPerfCounterValue getValue();
 
  virtual void setValue( SoPerfCounterValue value )  { m_mutex->lock(); m_value = value;  m_mutex->unlock(); }
 
  void setScale( SoPerfCounterValue scale ) { m_scale = scale; }
 
  SoPerfCounterValue getScale() const { return m_scale; }
 
  SbString getType() const { return m_type; }
 
  SbString getModule() const { return m_module; }
 
  SbString getStringLevel() const;
 
  int getLevel() const { return m_level; }
 
  bool isCustom() const { return m_isCustom; }
 
  SbName getFirstParent() const { return m_firstParent; }
 
  SbName getSecondParent() const { return m_secondParent; }
 
  void setFirstParent( SbName firstParent ) { m_firstParent = firstParent; }
 
  void setSecondParent( SbName secondParent ) { m_secondParent = secondParent; }
 
  SbString getOperation() const { return m_operation; }
 
  void setOperation( SbString operation ) { m_operation = operation; }
  
  virtual void increment( SoPerfCounterValue value ) { m_mutex->lock(); m_value += value; m_mutex->unlock(); }
  virtual void decrement( SoPerfCounterValue value ) { m_mutex->lock(); m_value -= value; m_mutex->unlock(); }
 
  void setID( int id ) { m_id = id; }
  int getID() { return m_id; }
 
  void setEnable( bool e ) { m_enable = e; }
  bool isEnabled() { return m_enable; }
 
  enum LevelEnum
  {
    LOW = 0,
    MEDIUM = 1,
    HIGH = 2
  };
 
private:
 
  static void initClass();
 
  static void exitClass();
 
  virtual ~SoPerfCounter();
 
private:
 
  SoPerfCounter( const SbString& name, const SbString& description,
                 const SbString& module = "no module", const LevelEnum level = MEDIUM, bool custom = false );
 
  SbString m_type;
 
  SbName m_name;
 
  SbString m_description;
 
  SoPerfCounterValue m_value;
 
  SoPerfCounterValue m_scale;
 
  enum LevelEnum m_level;
 
  SbString m_module;
 
  bool m_isCustom;
 
  SbName m_firstParent;
 
  SbName m_secondParent;
 
  SbString m_operation;
 
  SbThreadMutex* m_mutex;
 
private:
 
  void init();
 
  static bool m_isInitialized;
  static SoType m_classTypeId;
  int m_id;
  bool m_enable;
 
};
 
#endif // _SO_PERF_COUNTER_H_