---

CdbBdbObjectProfilerImpl.hh

Go to the documentation of this file.

#ifndef CDBBDB_OBJECT_PROFILER_IMPL_HH
#define CDBBDB_OBJECT_PROFILER_IMPL_HH

// File and Version Information:
//      $Id: CdbBdbObjectProfilerImpl.hh,v 1.2 2004/10/21 20:35:50 gapon Exp $

#include "CdbBase/CdbCommon.hh"

#include <string>

#include <oo.h>         // Objectivity/DB core API
#include <ooas.h>       // Objectivity/DB Active Schema API

// Forward declarations

class CdbBdbObjectProfilerUserAction;
class CdbBdbObjectProfilerContext;

template< class T > class CdbBdbCache;

/// This class implements the "object profiling" facility for a graph of persistent objects.
/**
  * More details...
  */
class CdbBdbObjectProfilerImpl {

    friend class CdbBdbObjectProfiler;     // who is able to create and destroy me

private:

  /// Default constructor (NOT IMPLEMENTED)
  /**
    * Implements the contract of the corresponding method of the facade class.
    *
    * @see CdbBdbObjectProfiler::CdbBdbObjectProfiler()
    */
    CdbBdbObjectProfilerImpl( );

  /// Normal constructor
  /**
    * Implements the contract of the corresponding method of the facade class.
    *
    * @see CdbBdbObjectProfiler::CdbBdbObjectProfiler()
    */
    CdbBdbObjectProfilerImpl( CdbBdbObjectProfilerUserAction* theUserAction,
                                                       bool verboseMode,
                                                       bool debugMode );

  /// Destructor
  /**
    * Implements the contract of the corresponding method of the facade class.
    *
    * @see CdbBdbObjectProfiler::~CdbBdbObjectProfiler()
    */
    virtual ~CdbBdbObjectProfilerImpl( );

  /// Profile the specified object
  /**
    * Implements the contract of the corresponding method of the facade class.
    *
    * @see CdbBdbObjectProfiler::profile()
    */
    virtual bool profile( const ooHandle(ooObj)& theInputH );

  /// Set user action
  /**
    * Implements the contract of the corresponding method of the facade class.
    *
    * @see CdbBdbObjectProfiler::setUserAction()
    */
    CdbBdbObjectProfilerUserAction* setUserAction( CdbBdbObjectProfilerUserAction* theUserAction );

  /// Get current size
  /**
    * Implements the contract of the corresponding method of the facade class.
    *
    * @see CdbBdbObjectProfiler::getSize()
    */
    uint64 getSize( ) const;

  /// Get current number of top-level objects
  /**
    * Implements the contract of the corresponding method of the facade class.
    *
    * @see CdbBdbObjectProfiler::getTopObjects()
    */
    uint64 getTopObjects( ) const;

private:

    /// An automatic prefix class
    /**
      * This internal helper class is meant to help with forming a proper prefix
      * string depending on the current "level" in a profileded graph.
      */
    class Prefix {

    private:

      /// Default constructor (NOT IMPLEMENTED)
      /**
        * The object's default does not make any sense at all.
        */
        Prefix( );

      /// Copy constructor (NOT IMPLEMENTED)
      /**
        * Copying of these objects does not make any sense at all.
        */
        Prefix( const Prefix& );

      /// Assignment operator (NOT IMPLEMENTED)
      /**
        * Copying of these objects does not make any sense at all.
        */
        Prefix& operator=( const Prefix& );

    public:

      /// Normal constructor
      /**
        * Decrement the current level at the caller's context.
        * Set up the current prefix string at the current context.
        */
        Prefix(               int& theLevel,        /**< a reference onto the caller's context */
                const std::string& theStep = "  "   /**< the step between levels */
              );

      /// Destructor
      /**
        * Decrement the current level at the caller's context.
        */
        ~Prefix( );

      /// An explicit type conversion operator
      /**
        * Will return a pointer onto the current prefix string.
        *
        * NONE: The returned string is bound to the local object's context.
        */
        const char* c_str( ) const;

    private:

               int& _level;   // a reference onto the caller's context
        std::string _str;     // the current prefix
    };

  // Helper methods

    bool profileObject( const ooHandle(ooObj)& theH );

    bool profileObjectContents( const ooas::Class_Object& theClassObject,
                                            const Prefix& thePrefix );

    static uint64 sizeOfNumericValue( const Numeric_Value& theNumericValue );

    static uint64 sizeOfStringValue( String_Value theStringValue );

    static uint64 sizeOfReference( );

private:

  // Current context

    bool _verboseMode;
    bool   _debugMode;

    CdbBdbObjectProfilerUserAction* _userAction;

  // A set to mark OID-s of input objects which were already profiled.
  // The set is used for the following reasons:
  //
  // - to avoid prifiling objects which have already been prifiled
  // - to escape from the cyclic graph problem

    CdbBdbCache< ooRef(ooObj) >* _dictionary;

  // Supplementary data structures

    int _level;     // the current level in a prifiled graph (begins with 0 for the initial object)

  // Profiler's statistics

    uint64 _size;       // The amount of data (in bytes) measured by the profiler
    uint64 _topObjects; // The number of unique "top-level" objects measured by the profiler
};

#endif  // CDBBDB_OBJECT_PROFILER_IMPL_HH

---