mlMemoryProfile.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2009, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
// Class for collecting memory profiling information.
 
#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(nullptr) { }
  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 = nullptr; }
 
private:
  MLProfilingMemoryType         _total;
  MLCurrentlyUsedMemoryTracker* _currentlyUsedMemoryTracker;
  std::string                   _description;
  std::string                   _shortDescription;
 
  friend class MLCurrentlyUsedMemoryTracker;
};
 
 
#endif // _ML_MEMORY_PROFILE_H_