Source/Base/Statistics/OSGStatRealElem.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 #ifndef _OSGSTATREALELEM_H_
  40 #define _OSGSTATREALELEM_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGStatElem.h"
  46
  47 #include <string>
  48
  49 OSG_BEGIN_NAMESPACE
  50
  51 class StatElemDescBase;
  52
  53 /*! \brief Real32 Statistics element, see \ref PageSystemStatistics for
  54            details.
  55     \ingroup GrpBaseStatistics
  56     \ingroup GrpLibOSGBase
  57  */
  58
  59 class OSG_BASE_DLLMAPPING StatRealElem : public StatElem
  60 {
  61     /*==========================  PUBLIC  =================================*/
  62
  63   public:
  64
  65     /*---------------------------------------------------------------------*/
  66     /*! \name                    your_category                             */
  67     /*! \{                                                                 */
  68
  69     static StatElem *create(StatElemDescBase *desc);
  70
  71     /*! \}                                                                 */
  72     /*---------------------------------------------------------------------*/
  73     /*! \name                    instance                                  */
  74     /*! \{                                                                 */
  75
  76             void   set  (Real32 value);
  77             Real32 get  (void        ) const;
  78
  79             void   add  (Real32 v    );
  80             void   sub  (Real32 v    );
  81
  82     virtual void   reset(void        );
  83
  84     /*! \}                                                                 */
  85     /*---------------------------------------------------------------------*/
  86     /*! \name                    instance                                  */
  87     /*! \{                                                                 */
  88
  89     virtual void   putToString   (      std::string  &str,
  90                                   const std::string &format = std::string()) const;
  91
  92     virtual bool   getFromCString(const Char8       *&inVal        );
  93
  94     virtual Real64 getValue      (      void                       ) const;
  95
  96     /*! \}                                                                 */
  97     /*---------------------------------------------------------------------*/
  98     /*! \name                    comparison                                */
  99     /*! \{                                                                 */
 100
 101     bool operator < (const StatRealElem &other) const;
 102
 103     /*! \}                                                                 */
 104     /*---------------------------------------------------------------------*/
 105     /*! \name                   Creation                                   */
 106     /*! \{                                                                 */
 107
 108     virtual StatElem *clone(void) const;
 109
 110     /*! \}                                                                 */
 111     /*---------------------------------------------------------------------*/
 112     /*! \name                     Operators                                */
 113     /*! \{                                                                 */
 114
 115     virtual StatElem &operator += (const StatElem &other);
 116
 117     /*! \}                                                                 */
 118     /*=========================  PROTECTED  ===============================*/
 119
 120   protected:
 121
 122     /*---------------------------------------------------------------------*/
 123     /*! \name                   Constructors                               */
 124     /*! \{                                                                 */
 125
 126     StatRealElem(StatElemDescBase *desc);
 127
 128     virtual ~StatRealElem(void);
 129
 130     /*! \}                                                                 */
 131     /*=========================  PRIVATE    ===============================*/
 132
 133   private:
 134
 135     typedef StatElem Inherited;
 136
 137     Real32 _value;
 138
 139     // prohibit default functions (move to 'public' if you need one)
 140     StatRealElem(const StatRealElem &source);
 141     StatRealElem& operator =(const StatRealElem &source);
 142 };
 143
 144 //---------------------------------------------------------------------------
 145 //   Exported Types
 146 //---------------------------------------------------------------------------
 147
 148 typedef StatRealElem *StatRealElemP;
 149
 150 OSG_END_NAMESPACE
 151
 152 #include "OSGStatRealElem.inl"
 153
 154 #endif /* _OSGSTATREALELEM_H_ */