Source/Base/Statistics/OSGStatElemDesc.cpp

   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  * This library is distributed in the hope that it will be useful, but       *
  19  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  21  * Library General Public License for more details.                          *
  22  *                                                                           *
  23  * You should have received a copy of the GNU Library General Public         *
  24  * License along with this library; if not, write to the Free Software       *
  25  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  26  *                                                                           *
  27 \*---------------------------------------------------------------------------*/
  28 /*---------------------------------------------------------------------------*\
  29  *                                Changes                                    *
  30  *                                                                           *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35  *                                                                           *
  36 \*---------------------------------------------------------------------------*/
  37
  38 //---------------------------------------------------------------------------
  39 //  Includes
  40 //---------------------------------------------------------------------------
  41
  42 #include <cstdlib>
  43 #include <cstdio>
  44
  45 #include "OSGConfig.h"
  46
  47 #include "OSGStatElemDesc.h"
  48
  49 #include "OSGLog.h"
  50 #include "OSGBaseInitFunctions.h"
  51 #include "OSGStringUtils.h"
  52
  53 OSG_USING_NAMESPACE
  54
  55 /***************************************************************************\
  56  *                               Types                                     *
  57 \***************************************************************************/
  58
  59 /***************************************************************************\
  60  *                           Class variables                               *
  61 \***************************************************************************/
  62
  63 StatElemDescBase::DescStorage *StatElemDescBase::_descVec = NULL;
  64
  65 /***************************************************************************\
  66  *                           Class methods                                 *
  67 \***************************************************************************/
  68
  69
  70
  71 /*-------------------------------------------------------------------------*\
  72  -  public                                                                 -
  73 \*-------------------------------------------------------------------------*/
  74
  75 /*! Returns the descriptor with the given \a name, or NULL if no such
  76     descriptor is found.
  77
  78     \param[in] name Name of the descriptor to return.
  79     \return Descriptor with the given name, or NULL if it is not found.
  80  */
  81 StatElemDescBase *StatElemDescBase::findDescByName(const Char8 *name)
  82 {
  83     SizeT             n    = _descVec ? _descVec->size() : 0;
  84     StatElemDescBase *desc = 0;
  85
  86     if(name && *name && n)
  87     {
  88         for(SizeT i = 0; i < n; ++i)
  89         {
  90             if (!osgStringCmp(name, (*_descVec)[i]->_name.c_str()))
  91             {
  92                 desc = (*_descVec)[i];
  93                 break;
  94             }
  95         }
  96     }
  97
  98     return desc;
  99 }
 100
 101 /*-------------------------------------------------------------------------*\
 102  -  protected                                                              -
 103 \*-------------------------------------------------------------------------*/
 104
 105 /*-------------------------------------------------------------------------*\
 106  -  private                                                                -
 107 \*-------------------------------------------------------------------------*/
 108
 109
 110 /***************************************************************************\
 111  *                           Instance methods                              *
 112 \***************************************************************************/
 113
 114 /*-------------------------------------------------------------------------*\
 115  -  public                                                                 -
 116 \*-------------------------------------------------------------------------*/
 117
 118 /*------------- constructors & destructors --------------------------------*/
 119
 120 /*! \brief Constructor.
 121     Creates a descriptor with the given name and description. The descriptor
 122     is assigned a unique id, that can be obtained with getId().
 123     It is an error to create two descriptors with the same name.
 124
 125     \param[in] name Name for the descriptor; must be unique.
 126     \param[in] description Description of the purpose of the StatElem, this
 127         descriptor belongs to.
 128     \param[in] reset
 129  */
 130 StatElemDescBase::StatElemDescBase(const Char8     *name,
 131                                    const Char8     *description,
 132                                          ResetMode  reset) :
 133     _id         (         -1),
 134     _name       (       name),
 135     _description(description),
 136     _resetMode  (reset)
 137 {
 138     StatElemDescBase *desc = 0;
 139
 140     if(_descVec)
 141     {
 142         desc = findDescByName(name);
 143     }
 144     else
 145     {
 146         _descVec = new DescStorage;
 147
 148         addPostFactoryExitFunction(&StatElemDescBase::terminate);
 149     }
 150
 151     if(desc)
 152     {
 153         FFATAL(("Attempt to register the StatElemDescBase name %s a second "
 154                 "time\n", name));
 155     }
 156     else
 157     {
 158         _id = Int32(_descVec->size());
 159         _descVec->push_back(this);
 160     }
 161 }
 162
 163 /*! \brief Destructor.
 164     It destroys the descriptor object, but the name and id are still reserved,
 165     so you still can not create a new descriptor with the same name.
 166  */
 167 StatElemDescBase::~StatElemDescBase(void)
 168 {
 169 }
 170
 171 /*! Prints information about all registered descriptors, by calling their
 172     print() method.
 173  */
 174 void StatElemDescBase::printAll(void)
 175 {
 176     SizeT n = _descVec ? _descVec->size() : 0;
 177
 178     for(SizeT i = 0; i < n; i++)
 179         (*_descVec)[i]->print();
 180 }
 181
 182 /*! Print information about this descriptor, i.e. its id, name and description.
 183  */
 184 void StatElemDescBase::print(void)
 185 {
 186     FLOG(( "StatElemDescBase: ID/Name/Description: %d/%s/%s\n",
 187            _id,
 188            _name.c_str(),
 189            _description.c_str()));
 190 }
 191
 192 /*------------------------------ access -----------------------------------*/
 193
 194 /*---------------------------- properties ---------------------------------*/
 195
 196 /*-------------------------- your_category---------------------------------*/
 197
 198 /*! Destroys the storage for the registered descriptors.
 199     \warning This is and should only be called during system shutdown.
 200  */
 201 bool StatElemDescBase::terminate(void)
 202 {
 203     delete _descVec;
 204
 205     return true;
 206 }
 207
 208 /*-------------------------- assignment -----------------------------------*/
 209
 210 /*! \brief Assignment.
 211     This is a no-op.
 212  */
 213 StatElemDescBase& StatElemDescBase::operator = (const StatElemDescBase &source)
 214 {
 215     if (this == &source)
 216         return *this;
 217
 218     return *this;
 219 }
 220
 221 /*-------------------------- comparison -----------------------------------*/
 222
 223 /*! \brief Less comparison.
 224     Compares the address of this agains \a other.
 225  */
 226 bool StatElemDescBase::operator < (const StatElemDescBase &other) const
 227 {
 228     return this < &other;
 229 }
 230