Source/Base/Statistics/OSGStatElem.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *             Copyright (C) 2000-2002 by the OpenSG Forum                   *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
  10  *                                                                           *
  11 \*---------------------------------------------------------------------------*/
  12 /*---------------------------------------------------------------------------*\
  13  *                                License                                    *
  14  *                                                                           *
  15  * This library is free software; you can redistribute it and/or modify it   *
  16  * under the terms of the GNU Library General Public License as published    *
  17  * by the Free Software Foundation, version 2.                               *
  18  *                                                                           *
  19  * This library is distributed in the hope that it will be useful, but       *
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  22  * Library General Public License for more details.                          *
  23  *                                                                           *
  24  * You should have received a copy of the GNU Library General Public         *
  25  * License along with this library; if not, write to the Free Software       *
  26  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  27  *                                                                           *
  28 \*---------------------------------------------------------------------------*/
  29 /*---------------------------------------------------------------------------*\
  30  *                                Changes                                    *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35  *                                                                           *
  36  *                                                                           *
  37 \*---------------------------------------------------------------------------*/
  38
  39
  40 #ifndef _OSGSTATELEM_H_
  41 #define _OSGSTATELEM_H_
  42 #ifdef __sgi
  43 #pragma once
  44 #endif
  45
  46 #include "OSGBaseTypes.h"
  47
  48 #include <string>
  49
  50 OSG_BEGIN_NAMESPACE
  51
  52 class StatElemDescBase;
  53
  54 /*! \brief Single Statistics element, see \ref PageSystemStatistics for
  55            details.
  56     \ingroup GrpBaseStatistics
  57     \ingroup GrpLibOSGBase
  58  */
  59
  60 class OSG_BASE_DLLMAPPING StatElem
  61 {
  62     /*==========================  PUBLIC  =================================*/
  63
  64   public:
  65
  66     /*---------------------------------------------------------------------*/
  67     /*! \name                     Instance                                 */
  68     /*! \{                                                                 */
  69
  70     bool              isOn   (void   ) const;
  71     void              setOn  (bool on);
  72
  73     StatElemDescBase *getDesc(void   ) const;
  74
  75     /*! \}                                                                 */
  76     /*---------------------------------------------------------------------*/
  77     /*! \name                   Destructor                                */
  78     /*! \{                                                                 */
  79
  80     virtual void   putToString   (      std::string &str,
  81                                   const std::string &format = std::string()) const = 0;
  82
  83     virtual bool   getFromCString(const Char8      *&inVal        )       = 0;
  84
  85     virtual Real64 getValue      (void                            ) const = 0;
  86
  87     virtual void   reset         (void                            )       = 0;
  88
  89     /*! \}                                                                 */
  90     /*---------------------------------------------------------------------*/
  91     /*! \name                   Destructor                                */
  92     /*! \{                                                                 */
  93
  94     virtual ~StatElem(void);
  95
  96     /*! \}                                                                 */
  97     /*---------------------------------------------------------------------*/
  98     /*! \name                  Comparison                                  */
  99     /*! \{                                                                 */
 100
 101      bool operator <  (const StatElem &other) const;
 102
 103     /*! \}                                                                 */
 104     /*---------------------------------------------------------------------*/
 105     /*! \name                   Creation                                   */
 106     /*! \{                                                                 */
 107
 108     virtual StatElem *clone(void) const = 0;
 109
 110     /*! \}                                                                 */
 111     /*---------------------------------------------------------------------*/
 112     /*! \name                     Operators                                */
 113     /*! \{                                                                 */
 114
 115     virtual StatElem &operator += (const StatElem &other) = 0;
 116
 117     /*! \}                                                                 */
 118     /*=========================  PROTECTED  ===============================*/
 119
 120   protected:
 121
 122     StatElem (StatElemDescBase *desc);
 123
 124     /*==========================  PRIVATE  ================================*/
 125
 126   private:
 127
 128     bool              _on;
 129     StatElemDescBase *_desc;
 130
 131     // prohibit default functions (move to 'public' if you need one)
 132
 133     StatElem            (const StatElem &source);
 134     StatElem& operator =(const StatElem &source);
 135 };
 136
 137 typedef StatElem *StatElemP;
 138
 139 OSG_END_NAMESPACE
 140
 141 #include "OSGStatElem.inl"
 142
 143 #endif /* _OSGSTATELEM_H_ */