ISequencerTimerTool.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2019 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#ifndef ISEQUENCERTIMERTOOL_H
#define ISEQUENCERTIMERTOOL_H 1
 
// from Gaudi
#include "GaudiKernel/IAlgTool.h"
 
class GAUDI_API ISequencerTimerTool : public virtual IAlgTool {
 
public:
  using IAlgTool::name;
  using IAlgTool::start;
  using IAlgTool::stop;
 
public:
  DeclareInterfaceID( ISequencerTimerTool, 3, 0 );
 
  virtual int addTimer( const std::string& name ) = 0;
 
  virtual void increaseIndent() = 0;
 
  virtual void decreaseIndent() = 0;
 
  virtual void start( int index ) = 0;
 
  virtual double stop( int index ) = 0;
 
  virtual const std::string& name( int index ) = 0;
 
  virtual double lastTime( int index ) = 0;
 
  virtual int indexByName( const std::string& name ) = 0;
 
  virtual bool globalTiming() = 0;
 
  virtual void saveHistograms() = 0;
 
  [[nodiscard]] auto scopedTimer( int index, bool enable = true ) {
    class Ret {
      ISequencerTimerTool* tool;
      int                  index;
 
    public:
      Ret( ISequencerTimerTool* tool, int index ) : tool{ tool }, index{ index } {
        if ( tool ) tool->start( index );
      }
      ~Ret() { reset(); }
      void reset() {
        if ( tool ) tool->stop( index );
      }
    };
    return Ret{ enable ? this : nullptr, index };
  }
};
 
#endif // ISEQUENCERTIMERTOOL_H