Timer.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* Timer.h                                                     (C) 2000-2025 */
/*                                                                           */
/* Management of a timer.                                                    */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_TIMER_H
#define ARCANE_CORE_TIMER_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/String.h"
 
#include "arcane/core/ArcaneTypes.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class ITimerMng;
class ITimeStats;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT Timer
{
 public:

  enum eTimerType
  {
    TimerVirtual,
    TimerReal
  };
 
 public:

  class ARCANE_CORE_EXPORT Sentry
  {
   public:

    Sentry(Timer* t)
    : m_timer(t)
    {
      m_timer->start();
    }

    ~Sentry()
    {
      m_timer->stop();
    }
 
   private:
 
    Timer* m_timer; 
  };

  class ARCANE_CORE_EXPORT Action
  {
   public:
 
    Action(ISubDomain* sub_domain, const String& action_name, bool print_time = false);
    Action(ITimeStats* stats, const String& action_name, bool print_time = false);
    ~Action();
 
   public:
   private:
 
    ITimeStats* m_stats;
    String m_action_name;
    bool m_print_time;
 
   private:
 
    void _init();
  };

  class ARCANE_CORE_EXPORT Phase
  {
   public:
   public:
 
    Phase(ISubDomain* sub_domain, eTimePhase pt);
    Phase(ITimeStats* stats, eTimePhase pt);
    ~Phase();
 
   public:
   private:
 
    ITimeStats* m_stats; 
    eTimePhase m_phase_type;
 
   private:
 
    void _init();
  };

  class ARCANE_CORE_EXPORT SimplePrinter
  {
   public:
 
    SimplePrinter(ITraceMng* tm, const String& msg);
    SimplePrinter(ITraceMng* tm, const String& msg, bool is_active);
    ~SimplePrinter();
 
   private:
 
    ITraceMng* m_trace_mng;
    Real m_begin_time;
    bool m_is_active;
    String m_message;
 
   private:
 
    void _init();
  };
 
 public:

  Timer(ISubDomain* sd, const String& name, eTimerType type);

  Timer(ITimerMng* tm, const String& name, eTimerType type);
 
  ~Timer(); 
 
 public:

  void start();

  Real stop();

  bool isActivated() const { return m_is_activated; }

  const String& name() const { return m_name; }

  Real totalTime() const { return m_total_time; }

  Real lastActivationTime() const { return m_activation_time; }

  Integer nbActivated() const { return m_nb_activated; }

  eTimerType type() const { return m_type; }

  void reset();

  ITimerMng* timerMng() const { return m_timer_mng; }
 
 public:
 
  static TimeMetricAction phaseAction(ITimeStats* s, eTimePhase phase);
 
 public:

  void _setStartTime(Real t) { m_start_time = t; }
  Real _startTime() const { return m_start_time; }
 
 private:
 
  ITimerMng* m_timer_mng; 
  eTimerType m_type; 
  Integer m_nb_activated; 
  bool m_is_activated; 
  Real m_activation_time; 
  Real m_total_time; 
  String m_name; 
  Real m_start_time; 
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif