IPerfMonSvc.h

Go to the documentation of this file.

 
/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
 
// IPerfMonSvc.h 
// Header file for class IPerfMonSvc
// Author: S.Binet<binet@cern.ch>
#ifndef PERFMONKERNEL_IPERFMONSVC_H 
#define PERFMONKERNEL_IPERFMONSVC_H 1
 
// STL includes
#include <utility> // std::pair
#include <string>
#include <vector>
 
// FrameWork includes
#include "GaudiKernel/IMonitorSvc.h"
#include "GaudiKernel/INamedInterface.h"
#include "GaudiKernel/StatEntity.h"
 
// PerfMonKernel includes
#include "PerfMonKernel/PerfMonDefs.h"
 
// forward declaration
namespace AIDA { class IBaseHistogram; }
namespace PerfMon { struct Component; }
namespace PerfMon { struct IoContainer; }
 
class IPerfMonSvc : virtual public IMonitorSvc
{ 
  // Public methods: 
 public: 
 
  virtual ~IPerfMonSvc();
 
  // Const methods: 
 
  PerfMon::State::Type monState() const 
  { return m_monState; }
 
  const std::string& monStateName() const 
  { return PerfMon::Steps[m_monState]; }
 
  std::vector<std::string>
  components(PerfMon::State::Type step) const
  { return this->components(PerfMon::Steps[step]); }
 
  virtual
  std::vector<std::string>
  components(const std::string& stepName) const = 0;
 
  virtual
  std::vector<std::string>
  io_components() const = 0;
 
  const PerfMon::Component*
  component(PerfMon::State::Type step,
        const std::string& compName) const
  { return this->component(PerfMon::Steps[step], compName); }
 
  virtual
  const PerfMon::Component*
  component(const std::string& stepName,
        const std::string& compName) const = 0;
 
  virtual
  const PerfMon::IoContainer*
  io_component(const std::string& compName) const = 0;
 
  virtual
  void
  domain(const std::string& compName, std::string& domain) const = 0;
 
  // Non-const methods: 
 
  static const InterfaceID& interfaceID();
 
  virtual void declareInfo( const std::string& name, 
                const bool& var, 
                const std::string& desc, 
                const IInterface* owner ) = 0;
  virtual void declareInfo( const std::string& name, 
                const int& var, 
                const std::string& desc,  
                const IInterface* owner ) = 0;
  virtual void declareInfo( const std::string& name, 
                const long& var, 
                const std::string& desc, 
                const IInterface* owner ) = 0;
  virtual void declareInfo( const std::string& name, 
                const double& var, 
                const std::string& desc, 
                const IInterface* owner ) = 0;
  virtual void declareInfo( const std::string& name, 
                const std::string& var, 
                const std::string& desc, 
                const IInterface* owner ) = 0;
  virtual void declareInfo( const std::string& name, 
                const std::pair<double,double>& var, 
                const std::string& desc, 
                const IInterface* owner ) = 0;
  virtual void declareInfo( const std::string& name, 
                const AIDA::IBaseHistogram* var, 
                const  std::string& desc, 
                const IInterface* owner ) = 0;
  virtual void declareInfo( const std::string& name, 
                const std::string& format, 
                const void * var, int size, 
                const std::string& desc, 
                const IInterface* owner ) = 0;
  virtual void declareInfo(const std::string& name, 
                           const StatEntity& var, 
                           const std::string& desc, 
                           const IInterface* owner) = 0;
 
  virtual void undeclareInfo( const std::string& name, 
                  const IInterface* owner ) = 0;
  virtual void undeclareAll( const IInterface* owner ) = 0;
 
  virtual std::set<std::string>* getInfos(const IInterface* owner = 0) = 0;
 
  virtual void startAud( const std::string& stepName,
             const std::string& compName = "PerfMonSlice" ) = 0;
 
  virtual void stopAud( const std::string& stepName,
            const std::string& compName = "PerfMonSlice" ) = 0;
 
  // Protected methods: 
 protected: 
 
  void setMonState( PerfMon::State::Type step )
  { m_monState = step; }
 
  // Private methods: 
 private: 
 
  PerfMon::State::Type m_monState;
}; 
 
 
// Inline methods: 
inline const InterfaceID& IPerfMonSvc::interfaceID() 
{ 
  static const InterfaceID IID_IPerfMonSvc("IPerfMonSvc", 1, 0);
  return IID_IPerfMonSvc; 
}
 
#endif //> PERFMONKERNEL_IPERFMONSVC_H