MeVis/Foundation/Sources/MLProfilingManager/Include/mlMemoryProfile.h

Go to the documentation of this file.

// **InsertLicense** code
//----------------------------------------------------------------------------------
// Class for collecting memory profiling information.
//
// \file    mlMemoryProfile.h
// \author  Marcus Barann
// \date    7/2009
//
//----------------------------------------------------------------------------------
#ifndef _ML_MEMORY_PROFILE_H_
#define _ML_MEMORY_PROFILE_H_

#include "mlProfilingManagerDllExport.h"
#include <string>


typedef size_t MLProfilingMemoryType;


class MLMemoryProfile;


class MLPROFILINGMANAGER_EXPORT MLCurrentlyUsedMemoryTracker
{
public:
  MLCurrentlyUsedMemoryTracker() : _memoryProfile(NULL) { }
  virtual ~MLCurrentlyUsedMemoryTracker();
  virtual size_t getCurrentlyUsedMemory() const = 0;

private:
  MLMemoryProfile* _memoryProfile;

  friend class MLMemoryProfile;
};


class MLPROFILINGMANAGER_EXPORT MLMemoryProfile
{
public:
  MLMemoryProfile(MLCurrentlyUsedMemoryTracker* tracker, const std::string& shortDescription);
  ~MLMemoryProfile();
  void addMemory(MLProfilingMemoryType memory);
  MLProfilingMemoryType getMemory() const;
  MLProfilingMemoryType getCurrentlyUsedMemory() const;
  void reset();

  const std::string& shortDescription() const { return _shortDescription; }

  const std::string& description() const { return _description; }
  void setDescription(const std::string& description_) { _description = description_; }

private:
  void removeCurrentlyUsedMemoryTracker() { _currentlyUsedMemoryTracker = NULL; }

private:
  MLProfilingMemoryType         _total;
  MLCurrentlyUsedMemoryTracker* _currentlyUsedMemoryTracker;
  std::string                   _description;
  std::string                   _shortDescription;

  friend class MLCurrentlyUsedMemoryTracker;
};


#endif // _ML_MEMORY_PROFILE_H_