Source/Base/Statistics/OSGStatCollector.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 _OSGSTATCOLLECTOR_H_
  41 #define _OSGSTATCOLLECTOR_H_
  42 #ifdef __sgi
  43 #pragma once
  44 #endif
  45
  46
  47 #include "OSGBaseTypes.h"
  48 #include "OSGFieldTraits.h"
  49 #include "OSGDataType.h"
  50
  51 #include "OSGSField.h"
  52
  53 #include "OSGStatElemDesc.h"
  54 #include "OSGMemoryObject.h"
  55
  56 OSG_BEGIN_NAMESPACE
  57
  58 class StatElem;
  59 class StatElemDescBase;
  60
  61 /*! \brief Manager for Stat elements, see \guide{Statistics} for details.
  62     \ingroup GrpBaseStatistics
  63     \ingroup GrpLibOSGBase
  64 */
  65
  66 class OSG_BASE_DLLMAPPING StatCollector : public MemoryObject
  67 {
  68
  69     /*==========================  PUBLIC  =================================*/
  70
  71   public:
  72
  73     typedef MemoryObject  Inherited;
  74     typedef StatCollector Self;
  75
  76     OSG_GEN_INTERNAL_MEMOBJPTR(StatCollector);
  77
  78     /*---------------------------------------------------------------------*/
  79     /*! \name                     Instance                                 */
  80     /*! \{                                                                 */
  81
  82     UInt32 getNumOfElems(void        ) const;
  83     void   refitElemNum (void        );
  84     void   clearElems   (void        );
  85     bool   isValidID    (Int32 elemId) const;
  86     void   reset        (StatElemDescBase::ResetMode mode =
  87                                 StatElemDescBase::RESET_DRAW);
  88
  89     /*! \}                                                                 */
  90     /*---------------------------------------------------------------------*/
  91     /*! \name                  Constructor                                 */
  92     /*! \{                                                                 */
  93
  94     StatElem *getElem(Int32             elemId         ) const;
  95
  96     StatElem *getElem(Int32             elemId,
  97                       bool              doCreate = true);
  98
  99     StatElem *getElem(StatElemDescBase &desc,
 100                       bool              docreate = true);
 101
 102     template <class T>
 103     T        *getElem(StatElemDesc<T>  &desc,
 104                       bool              doCreate = true);
 105
 106     /*! \}                                                                 */
 107     /*---------------------------------------------------------------------*/
 108     /*! \name                  Constructor                                 */
 109     /*! \{                                                                 */
 110
 111     void putToString   (      std::string  &outVal) const;
 112     bool getFromCString(const Char8       *&inVal );
 113     bool getValue      (      std::string  &name,
 114                               Real64       &val   );
 115
 116     /*! \}                                                                 */
 117     /*---------------------------------------------------------------------*/
 118     /*! \name                  Constructor                                 */
 119     /*! \{                                                                 */
 120
 121     StatCollector(void);
 122     StatCollector(const StatCollector &source);
 123
 124     /*---------------------------------------------------------------------*/
 125     /*! \name                   Destructor                                 */
 126     /*! \{                                                                 */
 127
 128     virtual ~StatCollector(void);
 129
 130     /*! \}                                                                 */
 131     /*---------------------------------------------------------------------*/
 132     /*! \name                     Operators                                */
 133     /*! \{                                                                 */
 134
 135     const StatCollector &operator =(const StatCollector &source);
 136
 137     /*! \}                                                                 */
 138     /*---------------------------------------------------------------------*/
 139     /*! \name                    Create                                    */
 140     /*! \{                                                                 */
 141
 142     static StatCollector *create(void);
 143
 144     /*! \}                                                                 */
 145     /*---------------------------------------------------------------------*/
 146     /*! \name                  Comparison                                  */
 147     /*! \{                                                                 */
 148
 149     bool operator == (const StatCollector &rhs  ) const;
 150     bool operator <  (const StatCollector &other) const;
 151
 152     /*! \}                                                                 */
 153     /*---------------------------------------------------------------------*/
 154     /*! \name                     Operators                                */
 155     /*! \{                                                                 */
 156
 157     StatCollector  operator +  (const StatCollector &other);
 158     StatCollector &operator += (const StatCollector &other);
 159
 160     /*! \}                                                                 */
 161     /*=========================  PROTECTED  ===============================*/
 162
 163   protected:
 164
 165     /*==========================  PRIVATE  ================================*/
 166
 167   private:
 168
 169     typedef std::vector<StatElem*>        StatElemStore;
 170     typedef StatElemStore::iterator       StatElemStoreIt;
 171     typedef StatElemStore::const_iterator StatElemStoreConstIt;
 172
 173     StatElemStore _elemVec;
 174 };
 175
 176 typedef StatCollector *       StatCollectorP;
 177 typedef StatCollector * const StatCollectorPConst;
 178 typedef StatCollector * const StatCollectorPConstArg;
 179
 180 OSG_GEN_MEMOBJPTR(StatCollector);
 181
 182
 183 #if !defined(OSG_DO_DOC) || (OSG_DOC_LEVEL >= 3)
 184
 185 /*! \brief Single Statistics element, see \ref PageSystemStatistics for
 186            details.
 187     \ingroup GrpBaseStatistics
 188     \ingroup GrpBaseFieldTraits
 189     \ingroup GrpLibOSGBase
 190  */
 191
 192 template <>
 193 struct FieldTraits<StatCollectorP> :
 194     public FieldTraitsTemplateBase<StatCollectorP>
 195 {
 196     static  DataType                    _type;
 197     typedef FieldTraits<StatCollectorP>  Self;
 198
 199     enum                  { Convertible = Self::ToStringConvertible  |
 200                                           Self::FromStringConvertible };
 201
 202     static OSG_BASE_DLLMAPPING
 203     DataType &getType      (void);
 204
 205     static const Char8    *getSName     (void) { return "SFStatCollectorP"; }
 206     static const Char8    *getMName     (void) { return "MFStatCollectorP"; }
 207
 208     static StatCollectorP  getDefault   (void) { return new StatCollector(); }
 209
 210     static bool            getFromCString(      StatCollectorP  &outVal,
 211                                           const Char8          *&inVal)
 212     {
 213         if(outVal != NULL)
 214             return outVal->getFromCString(inVal);
 215         else
 216             return true;
 217     }
 218
 219     static void            putToString   (const StatCollectorP &inVal,
 220                                                 std::string    &outVal)
 221     {
 222         if(inVal != NULL)
 223             inVal->putToString(outVal);
 224     }
 225
 226
 227     static UInt32 getBinSize(const StatCollectorP &)
 228     {
 229         return 0;
 230     }
 231
 232     static void copyToBin(      BinaryDataHandler & OSG_CHECK_ARG(pMem),
 233                           const StatCollectorP    & OSG_CHECK_ARG(oObject))
 234     {
 235     }
 236
 237     static void copyToBin(      BinaryDataHandler & OSG_CHECK_ARG(pMem),
 238                           const StatCollectorP    * OSG_CHECK_ARG(pObjectStore),
 239                                 UInt32              OSG_CHECK_ARG(uiNumObjects))
 240     {
 241     }
 242
 243     static void copyFromBin(BinaryDataHandler & OSG_CHECK_ARG(pMem),
 244                             StatCollectorP    & OSG_CHECK_ARG(oObject))
 245     {
 246     }
 247
 248     static void copyFromBin(BinaryDataHandler & OSG_CHECK_ARG(pMem),
 249                             StatCollectorP    * OSG_CHECK_ARG(pObjectStore),
 250                             UInt32              OSG_CHECK_ARG(uiNumObjects))
 251     {
 252     }
 253 };
 254
 255 #endif // !defined(OSG_DO_DOC) || (OSG_DOC_LEVEL >= 3)
 256
 257
 258 #ifndef DOXYGEN_SHOULD_SKIP_THIS
 259
 260 /*! \ingroup GrpBaseFieldSingle
 261  */
 262 typedef SField<StatCollectorP> SFStatCollectorP;
 263
 264 #else // these are the doxygen hacks
 265
 266 /*! \ingroup GrpBaseFieldSingle
 267     \ingroup GrpBaseStatistics
 268     \ingroup GrpLibOSGBase
 269  */
 270 struct SFStatCollectorP : public SField<StatCollectorP> {};
 271
 272 #endif // these are the doxygen hacks
 273
 274 OSG_END_NAMESPACE
 275
 276 #include "OSGStatCollector.inl"
 277
 278 #endif /* _OSGSTATCOLLECTOR_H_ */