MemoryMonitoringTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/

// MemoryMonitoringTool.h, (c) ATLAS Detector software
 
#ifndef ISF_TOOLS_MEMORYMONITORINGTOOL_H
#define ISF_TOOLS_MEMORYMONITORINGTOOL_H 1
 
// Gaudi & Athena basics
#include "AthenaBaseComps/AthAlgTool.h"
 
// ISF includes
#include "ISF_Interfaces/IMonitoringTool.h"
 
 
// stl includes
#include <utility>
#include <vector>
 
namespace ISF {

  typedef std::pair <const char* , int>   InfoUsagePair;
  typedef std::vector <InfoUsagePair*>    InfoUsagePairVector;
 

  class MemoryMonitoringTool : public extends<AthAlgTool, IMonitoringTool> {
      
    public: 
     MemoryMonitoringTool( const std::string& t, const std::string& n, const IInterface* p );

     ~MemoryMonitoringTool();
 
     // Athena algtool's Hooks
     StatusCode  initialize();
     StatusCode  finalize();

     virtual double getCurrent() const;

     virtual void dumpCurrent(const char *infoStr,
                              bool considerInSummary);

     virtual void recordCurrent(const char *infoStr);

     virtual void dumpSummary(const char *dumpCallDescr) const;
 
      private:
     int computeCurMemoryUsage() const;

     unsigned int                   m_numCalls; 
     unsigned int                   m_prevCallMemUsage;
     double                         m_accumulatedCallMemory;
     double                         m_accumulatedIncrMemory;

     InfoUsagePairVector            m_table;
 
  }; 
  
}
 
 
#endif //> !ISF_TOOLS_MEMORYMONITORINGTOOL_H