ChronoStatSvc.h

Go to the documentation of this file.

#ifndef      GAUDISVC_CHRONOSTATSVC_H__
#define      GAUDISVC_CHRONOSTATSVC_H__
// ============================================================================
// include files
// ============================================================================
// STD & STL
// ============================================================================
#include <string>
#include <map>
#include <functional>
#include <fstream>
// ============================================================================
// GaudiKernel
// ============================================================================
#include "GaudiKernel/Kernel.h"
#include "GaudiKernel/Service.h"
#include "GaudiKernel/IChronoStatSvc.h"
#include "GaudiKernel/IIncidentListener.h"
// ============================================================================
// ============================================================================
class ISvcLocator  ;
class IMessageSvc  ;
// ============================================================================
class ChronoStatSvc: public extends<Service,
                                    IChronoStatSvc,
                                    IIncidentListener> {
public:
  // ============================================================================
  typedef std::map<IChronoStatSvc::ChronoTag,ChronoEntity>  ChronoMap ;
  typedef std::map<IChronoStatSvc::StatTag,StatEntity>      StatMap   ;
  // ============================================================================
public:
  // ============================================================================
  StatusCode initialize() override;
  StatusCode finalize() override;
  // ============================================================================
public:
  // ============================================================================
  virtual       ChronoEntity* chronoStart
  ( const IChronoStatSvc::ChronoTag& chronoTag ) override;
  // ============================================================================
  virtual const ChronoEntity* chronoStop
  ( const IChronoStatSvc::ChronoTag& chronoTag ) override;
  // ============================================================================
  virtual IChronoStatSvc::ChronoTime chronoDelta
  ( const IChronoStatSvc::ChronoTag& chronoTag,
    IChronoStatSvc::ChronoType theType ) override;
  // ============================================================================
  virtual void    chronoPrint
  ( const IChronoStatSvc::ChronoTag& chronoTag ) override;
  // ============================================================================
  virtual ChronoStatus  chronoStatus
  ( const IChronoStatSvc::ChronoTag& chronoTag ) override;
  // ============================================================================
  virtual void     stat
  ( const IChronoStatSvc::StatTag    &  statTag    ,
    const IChronoStatSvc::StatFlag   &  statFlag   )  override;
  // ============================================================================
  virtual void     statPrint
  (  const IChronoStatSvc::ChronoTag& statTag)  override;
  // ============================================================================
  virtual const ChronoEntity* chrono
  ( const IChronoStatSvc::ChronoTag& t ) const   override;
  // ============================================================================
  virtual const StatEntity*   stat
  ( const IChronoStatSvc::StatTag&   t ) const  override;
  // ============================================================================
  ChronoStatSvc ( const std::string& name, ISvcLocator* svcloc );
  void merge ( const ChronoStatSvc& css);
  ~ChronoStatSvc() override = default;
  // ============================================================================

public:
  void handle(const Incident& incident) override;


protected:
  // ============================================================================
  // print the "Stat" part of the ChronoStatSvc
  void printStats() ;
  // ============================================================================
private:
  // ============================================================================
  // default/copy constructor and assignment are disabled
  ChronoStatSvc() = delete;
  ChronoStatSvc( const  ChronoStatSvc& ) = delete;
  ChronoStatSvc& operator=( const  ChronoStatSvc& ) = delete;
  // ============================================================================
  void saveStats();
  // ============================================================================
private:
  // ============================================================================
  ChronoMap      m_chronoEntities;
  int            m_intChronoPrintLevel ;
  MSG::Level     m_chronoPrintLevel    = MSG::INFO ;
  bool           m_chronoTableFlag     ;
  bool           m_chronoCoutFlag      ;
  bool           m_chronoOrderFlag     ;
  bool           m_printUserTime       ;
  bool           m_printSystemTime     ;
  bool           m_printEllapsedTime   ;

  // property
  long m_numberOfSkippedEventsForMemStat ;

  StatMap        m_statEntities;

  int            m_intStatPrintLevel ;
  MSG::Level     m_statPrintLevel     = MSG::INFO;
  bool           m_statTableFlag     ;
  bool           m_statCoutFlag      ;
  bool           m_statOrderFlag     ;

  StringProperty m_statsOutFileName;

  // the header row
  std::string    m_header  ; 
  // format for regular statistical printout rows
  std::string    m_format1 ; 
  // format for "efficiency" statistical printout rows
  std::string    m_format2 ; 
  // flag to use the special "efficiency" format
  bool           m_useEffFormat = true ; 

  typedef std::map<ChronoTag, std::vector<IChronoSvc::ChronoTime> > TimeMap;
  TimeMap m_perEvtTime;
  std::string   m_perEventFile;
  std::ofstream m_ofd;

  // ============================================================================
};
// ============================================================================
// The END
// ============================================================================
#endif   //  GAUDISVC_CHRONOSTATSVC_H
// ============================================================================