mlMetaProfile.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 to combine count, memory, and time profiles.
 
#ifndef ML_META_PROFILE_H
#define ML_META_PROFILE_H
 
#include "mlProfilingManagerDllExport.h"
#include "mlCountProfile.h"
#include "mlMemoryProfile.h"
#include "mlTimeProfile.h"
 
#include <map>
#include <vector>
 
class MLMetaProfilePtr;
 
typedef std::map<std::string, MLCountProfile*>  MLCountProfileMap;
typedef std::map<std::string, MLMemoryProfile*> MLMemoryProfileMap;
 
 
typedef void MLMetaProfileIsDestroyedCB(void);
 
 
class MLPROFILINGMANAGER_EXPORT MLMetaProfile
{
public:
  typedef enum {
    MLCall = 0,
    PythonCall = 1,
    FieldNotificationCall = 2,
    CppCall = 3,
    GLRenderCall = 4,
    PythonQtCall = 5,
    MLWEMCall = 6,
    MDLCommandCall = 7,
    MainFunctionCall = 8,
    CallTypeCount = 9
  } MLProfilingFunctionType;
 
  static const char* functionTypeToString(MLProfilingFunctionType type);
 
  const std::vector<MLMetaProfile*>& getSubMetaProfiles() const { return _subMetaProfiles; }
 
  void addSubMetaProfile(MLMetaProfile* subMetaProfile) { _subMetaProfiles.push_back(subMetaProfile); subMetaProfile->_superProfile = this; }
 
  /* @ingroup CountProfiling
   * @{
   */
  MLCountProfile* createCountProfile(const std::string& key);
 
  MLCountProfile* getCountProfile(const std::string& key) const;
 
  bool incrementCountValue(const std::string& key);
 
  MLProfilingCountType getCountValue(const std::string& key, bool* ok = nullptr) const;
 
  const MLCountProfileMap& getCountProfileMap() const { return _countProfileMap; }
 
  void setCountProfileDescription(const std::string& key, const std::string& description);
  /* @}
   */
 
  /* @ingroup MemoryProfiling
   * @{
   */
  MLMemoryProfile* createMemoryProfile(const std::string& key,
                                       MLCurrentlyUsedMemoryTracker* tracker);
 
  MLMemoryProfile* getMemoryProfile(const std::string& key) const;
 
  bool addMemory(const std::string& key, MLProfilingMemoryType memory);
 
  MLProfilingMemoryType getMemory(const std::string& key, bool* ok = nullptr) const;
 
  MLProfilingMemoryType getAllMemory() const;
 
  MLProfilingMemoryType getCurrentlyUsedMemory(const std::string& key, bool* ok = nullptr) const;
 
  MLProfilingMemoryType getAllCurrentlyUsedMemory() const;
 
  const MLMemoryProfileMap& getMemoryProfileMap() const { return _memoryProfileMap; }
 
  void setMemoryProfileDescription(const std::string& key, const std::string& description);
  /* @}
   */
 
  /* @ingroup TimeProfiling
   * @{
   */
  MLTimeProfileHandle startMeasuring(const std::string& function,
                                     int userId,
                                     void* userData=nullptr,
                                     const std::string& filename="",
                                     int linenumber=-1,
                                     const std::string& nodeInfo="")
  {
    return _timeProfile->startMeasuring(function, userId, userData, filename, linenumber, nodeInfo);
  }
 
  void stopMeasuring(MLTimeProfileHandle& handle, bool ignoreIfEmpty = false)  { return _timeProfile->stopMeasuring(handle, ignoreIfEmpty); }
 
  MLTimeProfile* getTimeProfile() const { return _timeProfile; }
  /* @}
   */
 
  void setDescription(const std::string& description_) { _description = description_; }
  const std::string& description() const { return _description; }
 
  ~MLMetaProfile();
 
private:
  MLMetaProfile(const std::string& description, MLMetaProfilePtr* metaProfilePtr);
  // Disallow copying of the metaprofile.
  MLMetaProfile(const MLMetaProfile&);
 
private:
  MLCountProfileMap     _countProfileMap;
  MLMemoryProfileMap    _memoryProfileMap;
  MLTimeProfile*        _timeProfile;
 
  std::vector<MLMetaProfile*> _subMetaProfiles;
 
  std::string _description;
 
  MLMetaProfilePtr* _metaProfilePtr;
 
  MLMetaProfile* _superProfile;
 
  friend class MLMetaProfilePtr;
  friend class MLProfilingManager;
};
 
 
#endif // _ML_META_PROFILE_H_