AthenaMon.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
// ********************************************************************
//
// NAME:     AthenaMon.cxx
//
// AUTHOR:   Rob McPherson & Manuel Diaz
//       Manuel Diaz 01.04.2004  Changed interface access from 
//                   IAlgTool to IMonitorToolBase   
//
// ********************************************************************
 
#include "GaudiKernel/MsgStream.h"
#include "GaudiKernel/IToolSvc.h"
#include "GaudiKernel/StatusCode.h"
#include "GaudiKernel/TypeNameString.h"
 
#include "AthenaMon.h"
 
class ISvcLocator;
// class AlgFactory;
 
/*---------------------------------------------------------------*/
AthenaMon::AthenaMon(const std::string& name, ISvcLocator* pSvcLocator) :
  AthAlgorithm(name, pSvcLocator)
{   
  MsgStream log(msgSvc(), "AthenaMon");
  
  declareProperty("AthenaMonTools",m_monToolNames);
  declareProperty("CheckEveryNoEvents",m_everyNevents=-1);
  declareProperty("BookHistsinInitialize",m_bookHistsinInitialize=true);
  m_THistSvc_streamnameMapping.clear();
  declareProperty("THistSvc_OutPutStreamMapping",m_THistSvc_streamnameMapping);
}
 
/*---------------------------------------------------------------*/
AthenaMon::~AthenaMon()
{
}
 
/*---------------------------------------------------------------*/
StatusCode AthenaMon::initialize()
/*---------------------------------------------------------------*/
{
  MsgStream log(msgSvc(), name());
  log << MSG::INFO << "initialize AthenaMon algorithm" << endmsg;
 
  std::vector<std::string>::iterator it = m_monToolNames.begin();
  SmartIF<IToolSvc> p_toolSvc{service("ToolSvc")};
  ATH_CHECK( p_toolSvc.isValid() );
 
  for (; it < m_monToolNames.end(); ++it) {
 
    std::string toolname(*it);
    IMonitorToolBase* p_tool;
    
    Gaudi::Utils::TypeNameString mytool(toolname);
 
    StatusCode sc = p_toolSvc->retrieveTool(mytool.type(), mytool.name(), p_tool);
    if(sc.isFailure()) {
      log << MSG::FATAL << "Unable to create " << toolname
      << " AlgTool" << endmsg;
      return StatusCode::FAILURE;
    } else {
      
      log << MSG::INFO
      << "Tool Name = " << toolname
      << endmsg;
      
      sc = p_tool->setupOutputStreams(m_THistSvc_streamnameMapping);
      if(sc.isFailure()) {
    log << MSG::WARNING << "Unable to setup the OutPutStreams in "
        << toolname << endmsg;
      }
      
      // shall I book histograms now ?
      if(m_bookHistsinInitialize)
    {
      // Try to book the histograms now.  If the tool uses
      // dynamic booking, it should define bookHists as empty.
      sc = p_tool->bookHists();
      if(sc.isFailure()) {
        log << MSG::WARNING << "Unable to book in " << toolname << endmsg;
      }
    }
      m_monTools.push_back(p_tool);
    }
  } 
  m_eventCounter=m_everyNevents;
  return StatusCode::SUCCESS;
}
 
/*---------------------------------------------------------------*/
StatusCode AthenaMon::execute()
{
  MsgStream log(msgSvc(), name());
  
  log << MSG::DEBUG << "executing AthenaMon algorithm" << endmsg;
  
  //Invoke all declared alg monitoring tools to fill their histograms
  std::vector<IMonitorToolBase*>::iterator it = m_monTools.begin();
  
  for (; it < m_monTools.end(); ++it)  {
    if((*it)->preSelector())
      if((*it)->fillHists().isFailure())  {
    log << MSG::WARNING << "Error Filling Histograms" << endmsg;
    // return StatusCode::FAILURE;
      }
  }
  if(m_eventCounter==0) {
    //Invoke periodically all declared alg monitoring tools to check their histograms
    it = m_monTools.begin();
    
    for (; it < m_monTools.end(); ++it)  {
      log << MSG::INFO << "calling checkHists of tool " << endmsg;
      StatusCode sc = (*it)->checkHists(false);
      if(sc.isFailure())  {
    log << MSG::WARNING << "Can\'t call checkHists of tool." << endmsg;
    // return StatusCode::FAILURE;
      }
    }
    m_eventCounter=m_everyNevents;
  }
  if(m_eventCounter>0) m_eventCounter--;
  return StatusCode::SUCCESS;
}
 
/*---------------------------------------------------------------*/
StatusCode AthenaMon::finalize()
{
  MsgStream log(msgSvc(), name());
  
  log << MSG::INFO << "finalizing AthenaMon algorithm" << endmsg;
  
  //Invoke all declared alg monitoring tools to finalize their histograms
  std::vector<IMonitorToolBase*>::iterator it = m_monTools.begin();
  
  for (; it < m_monTools.end(); ++it)  {
    log << MSG::INFO << "finalizing tool " << endmsg;
    StatusCode sc = (*it)->finalHists();
    if(sc.isFailure())  {
      log << MSG::WARNING << "Can\'t finalize a tool." << endmsg;
      // return StatusCode::FAILURE;
    }
  }
  //Invoke all declared alg monitoring tools to check their histograms
  it = m_monTools.begin();
  
  for (; it < m_monTools.end(); ++it)  {
    log << MSG::INFO << "calling checkHists of tool " << endmsg;
    StatusCode sc = (*it)->checkHists(true);
    if(sc.isFailure())  {
      log << MSG::WARNING << "Can\'t call checkHists of tool." << endmsg;
      // return StatusCode::FAILURE;
    }
  }
 
  return StatusCode::SUCCESS;
}
 
/*---------------------------------------------------------------*/
StatusCode AthenaMon::start()
{
  MsgStream log(msgSvc(), name());
  log << MSG::INFO << "start()" << endmsg;
  
  // histograms already booked
  if(m_bookHistsinInitialize)
    return StatusCode::SUCCESS;
  
  std::vector<IMonitorToolBase*>::iterator it = m_monTools.begin();
  for (; it < m_monTools.end(); ++it)
    if((*it)->bookHists().isFailure())
      log << MSG::WARNING << "Error Filling Histograms" << endmsg;
  
  return StatusCode::SUCCESS;
}
 
/*---------------------------------------------------------------*/
StatusCode AthenaMon::stop()
{
  MsgStream log(msgSvc(), name());
  log << MSG::INFO << "stop()" << endmsg;
  
  std::vector<IMonitorToolBase*>::iterator it = m_monTools.begin();
  for (; it < m_monTools.end(); ++it)
    if((*it)->runStat().isFailure())
      log << MSG::WARNING << "Error calling runStat" << endmsg;
  
  return StatusCode::SUCCESS;
}