Source/Base/PerfMonitor/OSGPerfMonitorGuard.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-2006 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 _OSG_PERF_MONITOR_GUARD_
  40 #define _OSG_PERF_MONITOR_GUARD_
  41
  42 #include "OSGPerfMonitor.h"
  43
  44
  45 OSG_BEGIN_NAMESPACE
  46
  47 /*! \ingroup GrpBasePerfMon
  48  *  \nohierarchy
  49  * Helper class that uses the guard idiom to create and monitor performance.
  50  * To use, just create a PerfMonitorGuard with the name of the perf sample
  51  * point. It will automatically call enter on creation and exit on destruction.
  52  */
  53 class PerfMonitorGuard
  54 {
  55 public:
  56     PerfMonitorGuard(const std::string& name, const std::string& desc = "")
  57         : mName(name)
  58         , mDesc(desc)
  59     {
  60         PerfMonitor::the()->sample(OSG::PerfMonitorBase::ENTER, mName, 0.0,                                        mDesc);
  61      }
  62     ~PerfMonitorGuard()
  63     {
  64         PerfMonitor::the()->sample(OSG::PerfMonitorBase::EXIT, mName, 0.0,
  65                                    mDesc);
  66     }
  67
  68     std::string mName;         /**< The name of the sample point. */
  69     std::string mDesc;
  70 };
  71
  72
  73 OSG_END_NAMESPACE
  74
  75 #endif