IItemFamilySerializeStep.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* IItemFamilySerializeStep.h                                  (C) 2000-2025 */
/*                                                                           */
/* Interface for a step in the serialization of entity families.             */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_IITEMFAMILYSERIALIZESTEP_H
#define ARCANE_CORE_IITEMFAMILYSERIALIZESTEP_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/ArcaneTypes.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT IItemFamilySerializeStep
{
 public:

  enum ePhase
  {
    PH_Item,
    PH_Group,
    PH_Variable
  };

  enum class eAction
  {
    AC_BeginPrepareSend,
    AC_EndPrepareSend,
    AC_BeginReceive,
    AC_EndReceive,
  };
 
 public:
 
  class NotifyActionArgs
  {
   public:
 
    NotifyActionArgs(eAction aaction, Integer nb_message)
    : m_action(aaction)
    , m_nb_message(nb_message)
    {}
 
   public:
 
    eAction action() const { return m_action; }
    Integer nbMessage() const { return m_nb_message; }
 
   private:
 
    eAction m_action;
    Integer m_nb_message;
  };
 
 public:
 
  virtual ~IItemFamilySerializeStep() = default;
 
 public:

  virtual void initialize() = 0;

  virtual void notifyAction(const NotifyActionArgs& args) = 0;

  virtual void serialize(const ItemFamilySerializeArgs& args) = 0;

  virtual void finalize() = 0;

  virtual ePhase phase() const = 0;

  virtual IItemFamily* family() const = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT IItemFamilySerializeStepFactory
{
 public:
 
  virtual ~IItemFamilySerializeStepFactory() = default;
 
 public:

  virtual IItemFamilySerializeStep* createStep(IItemFamily* family) = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif