DDD_PerformanceMonitor.h

Go to the documentation of this file.

/*! \file DDD_PerformanceMonitor.h
  
  \brief classes for  measuring application performance

  \par Copyright Information

  Copyright (c) 2012 The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBLITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/

#ifndef _DDD_PerformanceMonitor_h_
#define _DDD_PerformanceMonitor_h_


#include "DDD_Include.h"
#include "dynamic_ptr_array.h"
#include "timer.h"
#include <string>

namespace disti
{

/** \brief  Performance monitor class; profiles an individual task. */
class DDD_EXPORT DDD_PerformanceMonitor
{
    friend class DDD_PerformanceMonitorSystem;
protected:
    Timer       _timer;   /**< Timer used to track performance */
    std::string _name;    /**< Friendly name for display purposes.  Must be unique */
    INT_64      _sample;  /**< The most recent performance sample.  */
    bool        _started; /**< True if measurement has been started (i.e. timer is counting */

    /** Constructor
      * \param name  The name of the performance monitor to create. Must be unique.
      */
    DDD_PerformanceMonitor(std::string &name);
public:

    /** \return Returns the name of this performance monitor */
    std::string &Name() { return _name; }

    /** Start measuring performance.  Call this immediately before the code you want to profile */
    void StartMeasurement();

    /** Stop measuring performance.  Call this immediately after the code you want to profile */
    void FinishMeasurement();

    /** \return Returns the last performance sample, i.e. the amount of time that elapsed between 
      *         the most recent two calls to StartMeasurement and FinishMeasurement
      */
    INT_64 LastPerformanceSample();
};

/** \brief  A collection of DDD_PerformanceMonitors.  A singleton. */
class DDD_EXPORT DDD_PerformanceMonitorSystem : public DynamicPtrArray<DDD_PerformanceMonitor *>
{
protected:

    /** Constructor.  Protected because this is a singleton */
    DDD_PerformanceMonitorSystem();

    /** Destructor.  Protected because this is a singleton */
    ~DDD_PerformanceMonitorSystem();
public:

    /** Public interface to the singleton 
      * \return Returns a pointer to the singleton instance 
      */
    static DDD_PerformanceMonitorSystem *Instance();

    /** Register a new performance monitor
      * \param name  The name of the new performance monitor.  Must be unique.
      * \return A pointer to the new performance monitor.  For efficiency the caller 
      *         should cache this value.  Returns NULL if there was already a monitor
      *         registered with 'name'
      */
    DDD_PerformanceMonitor *RegisterPerformanceMonitor(std::string name);

    /** \return Returns a pointer to the performance monitor with the given name
      *         or NULL if none was found
      * \param name  The name of the monitor to find
      */
    DDD_PerformanceMonitor *FindMonitor(std::string name);
};

} // end of namespace disti

#endif