ITimeHistoryMng.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2024 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* ITimeHistoryMng.h                                           (C) 2000-2024 */
/*                                                                           */
/* Interface de la classe gérant un historique de valeurs.                   */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_ITIMEHISTORYMNG_H
#define ARCANE_ITIMEHISTORYMNG_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/ArcaneTypes.h"
#include "arcane/utils/UtilsTypes.h"
#include "arcane/utils/FatalErrorException.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class TimeHistoryAddValueArg
{
 public:

  TimeHistoryAddValueArg(const String& name, bool end_time, Integer local_proc_id)
  : m_name(name)
  , m_end_time(end_time)
  , m_local_proc_id(local_proc_id)
  {}

  TimeHistoryAddValueArg(const String& name, bool end_time)
  : TimeHistoryAddValueArg(name, end_time, NULL_SUB_DOMAIN_ID)
  {}

  explicit TimeHistoryAddValueArg(const String& name)
  : TimeHistoryAddValueArg(name, true)
  {}
 
 public:
 
  const String& name() const { return m_name; }
  bool endTime() const { return m_end_time; }
  bool isLocal() const { return m_local_proc_id != NULL_SUB_DOMAIN_ID; }
  Integer localProcId() const { return m_local_proc_id; }
 
 private:
 
  String m_name;
  bool m_end_time;
  Integer m_local_proc_id;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class ITimeHistoryCurveWriter;
class ITimeHistoryCurveWriter2;
class ITimeHistoryTransformer;
class ITimeHistoryMngInternal;
class ITimeHistoryAdder;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
class ITimeHistoryMng
{
 public:
 
  virtual ~ITimeHistoryMng() = default; 
 
 public:
 
  // TODO Deprecated
  virtual void addValue(const String& name, Real value, bool end_time = true, bool is_local = false) = 0;
  virtual void addValue(const String& name, Int32 value, bool end_time = true, bool is_local = false) = 0;
  virtual void addValue(const String& name, Int64 value, bool end_time = true, bool is_local = false) = 0;
  virtual void addValue(const String& name, RealConstArrayView value, bool end_time = true, bool is_local = false) = 0;
  virtual void addValue(const String& name, Int32ConstArrayView value, bool end_time = true, bool is_local = false) = 0;
  virtual void addValue(const String& name, Int64ConstArrayView value, bool end_time = true, bool is_local = false) = 0;
 
 public:
 
  virtual void timeHistoryBegin() = 0;
  virtual void timeHistoryEnd() = 0;
  virtual void timeHistoryInit() = 0;
  virtual void timeHistoryStartInit() = 0;
  virtual void timeHistoryContinueInit() = 0;
  virtual void timeHistoryRestore() = 0;
 
 public:

  virtual ARCANE_DEPRECATED void addCurveWriter(ITimeHistoryCurveWriter* writer)
  {
    ARCANE_UNUSED(writer);
    ARCANE_FATAL("No longer supported. Use 'ITimeHistoryCurveWriter2' interface");
  }

  virtual ARCANE_DEPRECATED void removeCurveWriter(ITimeHistoryCurveWriter* writer)
  {
    ARCANE_UNUSED(writer);
    ARCANE_FATAL("No longer supported. Use 'ITimeHistoryCurveWriter2' interface");
  }

  virtual void addCurveWriter(ITimeHistoryCurveWriter2* writer) = 0;

  virtual void removeCurveWriter(ITimeHistoryCurveWriter2* writer) = 0;

  virtual void removeCurveWriter(const String& name) = 0;
 
 public:

  virtual void dumpHistory(bool is_verbose) = 0;

  virtual void dumpCurves(ITimeHistoryCurveWriter2* writer) = 0;

  virtual bool active() const = 0;

  virtual void setActive(bool is_active) = 0;

  virtual void applyTransformation(ITimeHistoryTransformer* v) = 0;

  virtual bool isDumpActive() const = 0;

  virtual void setDumpActive(bool is_active) = 0;

  virtual bool isShrinkActive() const = 0;

  virtual void setShrinkActive(bool is_active) = 0;
 
 public:

  virtual ITimeHistoryMngInternal* _internalApi() { ARCANE_FATAL("Invalid usage"); };
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif