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