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