IChronoSvc.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2024 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 GAUDIKERNEL_ICHRONOSVC_H
#define GAUDIKERNEL_ICHRONOSVC_H 1
// ============================================================================
// Include files
// ============================================================================
// STD&STL
// ============================================================================
#include <string>
// ============================================================================
// GaudiKernel
// ============================================================================
#include <GaudiKernel/IInterface.h>
// ============================================================================
// forward declaration
// ============================================================================
class ChronoEntity;
// ============================================================================
class GAUDI_API IChronoSvc : virtual public IInterface {
public:
  DeclareInterfaceID( IChronoSvc, 3, 0 );
  // ==========================================================================
  typedef std::string ChronoTag;
  typedef double ChronoTime;
  // ==========================================================================
public:
  // ==========================================================================
  // status of Chrono objects
  enum ChronoStatus { UNKNOWN = 0, RUNNING, STOPPED };
  // types of Chrono objects
  enum ChronoType { USER = 0, KERNEL, ELAPSED };
  // ==========================================================================
public:
  // ==========================================================================
  virtual ChronoEntity* chronoStart( const ChronoTag& t ) = 0;
  // ==========================================================================
  virtual const ChronoEntity* chronoStop( const ChronoTag& t ) = 0;
  // ==========================================================================
  virtual ChronoTime chronoDelta( const ChronoTag& t, ChronoType f ) = 0;
  // ==========================================================================
  virtual void chronoPrint( const ChronoTag& t ) = 0;
  // ==========================================================================
  virtual ChronoStatus chronoStatus( const ChronoTag& t ) = 0;
  // ==========================================================================
  virtual const ChronoEntity* chrono( const ChronoTag& t ) const = 0;
  // ==========================================================================
};
// ============================================================================
// The END
// ============================================================================
#endif // GAUDIKERNEL_ICHRONOSVC_H