Stat.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* Stat.h                                                      (C) 2000-2025 */
/*                                                                           */
/* Statistics on parallelism.                                                */
/*---------------------------------------------------------------------------*/
#ifndef ARCCORE_MESSAGEPASSING_STAT_H
#define ARCCORE_MESSAGEPASSING_STAT_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arccore/message_passing/IStat.h"
 
#include "arccore/base/String.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane::MessagePassing
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
/*!
 * \internal
 * \brief Statistical data set for profiling.
 *
 * This class is internal to Arccore.
 */
class ARCCORE_MESSAGEPASSING_EXPORT StatData
{
  //! DEPRECATED
  using OneStatMap = std::map<String, OneStat*>;
 
 public:
 
  StatData() = default;
 
  ARCCORE_DEPRECATED_REASON("Y2023: use mergeData() for each OneStat instead")
  explicit StatData(const OneStatMap& os_map);
 
  const StatCollection& stats() const { return m_stat_col; }
 
  void resetCurrentStat();
 
  void mergeData(OneStat one_stat);
  void mergeAllData(const StatData& all_stat);
 
  ARCCORE_DEPRECATED_REASON("Y2023: Use mergeAllData(const StatData&) instead")
  void mergeAllData(const OneStatMap& all_stat);
 
 private:
 
  StatCollection m_stat_col;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
/*!
 * \internal
 * \brief Statistics manager for parallelism.
 *
 * This class is internal to Arccore.
 */
class ARCCORE_MESSAGEPASSING_EXPORT Stat
: public IStat
{
 public:
 
  //! DEPRECATED
  using OneStatMap = std::map<String, OneStat*>;
 
 public:
 
  typedef std::pair<String, OneStat*> OneStatValue;
 
 public:
 
  //! Releases resources.
  ~Stat() override;
 
 public:
 
  void add(const String& name, double elapsed_time, Int64 msg_size) override;
  void enable(bool is_enabled) override { m_is_enabled = is_enabled; }
 
  void print(std::ostream& o);
 
  ARCCORE_DEPRECATED_2019("Use statList() instead")
  const OneStatMap& stats() const override { return m_list; }
 
  ARCCORE_DEPRECATED_REASON("Y2023: Use statList() instead")
  const StatData& getData() const { return m_data; }
 
  const StatCollection& statList() const override;
 
  void resetCurrentStat() override;
 
 private:
 
  bool m_is_enabled = true;
  OneStatMap m_list;
  StatData m_data;
 
 private:
 
  OneStat* _find(const String& name);
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Arcane::MessagePassing
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif