IIncrementalItemConnectivity.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* IIncrementalItemConnectivity.h                              (C) 2000-2024 */
/*                                                                           */
/* Incremental entity connectivity interface.                                */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_IINCREMENTALITEMCONNECTIVITY_H
#define ARCANE_CORE_IINCREMENTALITEMCONNECTIVITY_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/ArrayView.h"
 
#include "arcane/core/ItemTypes.h"
#include "arcane/core/IItemConnectivityAccessor.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane::mesh
{
class ItemFamily;
}
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT IIncrementalItemSourceConnectivity
{
  ARCCORE_DECLARE_REFERENCE_COUNTED_INCLASS_METHODS();

  friend class mesh::ItemFamily;
 
 protected:
 
  virtual ~IIncrementalItemSourceConnectivity() = default;
 
 public:

  virtual IItemFamily* sourceFamily() const = 0;
 
  //TODO: use an event-based mechanism.
  virtual void notifySourceFamilyLocalIdChanged(Int32ConstArrayView new_to_old_ids) = 0;

  virtual void notifySourceItemAdded(ItemLocalId item) = 0;

  virtual void reserveMemoryForNbSourceItems(Int32 n, bool pre_alloc_connectivity);

  virtual void notifyReadFromDump() = 0;

  virtual Ref<IIncrementalItemSourceConnectivity> toSourceReference() = 0;
 
 private:
 
  // Interfaces reserved to Arcane

  virtual void _internalNotifySourceItemsAdded(Int32ConstArrayView items);
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT IIncrementalItemTargetConnectivity
{
  ARCCORE_DECLARE_REFERENCE_COUNTED_INCLASS_METHODS();
 
 protected:
 
  virtual ~IIncrementalItemTargetConnectivity() = default;
 
 public:
 
  //TODO: use an event-based mechanism.
  virtual void notifyTargetFamilyLocalIdChanged(Int32ConstArrayView old_to_new_ids) = 0;

  virtual Ref<IIncrementalItemTargetConnectivity> toTargetReference() = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT IIncrementalItemConnectivity
: public IItemConnectivityAccessor
, public IIncrementalItemSourceConnectivity
, public IIncrementalItemTargetConnectivity
{
  ARCCORE_DECLARE_REFERENCE_COUNTED_INCLASS_METHODS();
 
 public:
 
  //TODO make 'protected' once everyone uses the reference counter
  ~IIncrementalItemConnectivity() = default;
 
 public:

  virtual String name() const = 0;

  virtual ConstArrayView<IItemFamily*> families() const = 0;

  virtual IItemFamily* targetFamily() const = 0;

  virtual void addConnectedItem(ItemLocalId source_item, ItemLocalId target_local_id) = 0;

  virtual void setConnectedItems(ItemLocalId source_item, Int32ConstArrayView target_local_ids);

  virtual void removeConnectedItem(ItemLocalId source_item, ItemLocalId target_local_id) = 0;

  virtual void removeConnectedItems(ItemLocalId source_item) = 0;

  virtual void replaceConnectedItem(ItemLocalId source_item, Integer index, ItemLocalId target_local_id) = 0;

  virtual void replaceConnectedItems(ItemLocalId source_item, Int32ConstArrayView target_local_ids) = 0;

  virtual bool hasConnectedItem(ItemLocalId source_item, ItemLocalId target_local_id) const = 0;

  virtual Int32 maxNbConnectedItem() const = 0;

  virtual Integer preAllocatedSize() const = 0;

  virtual void setPreAllocatedSize(Integer value) = 0;

  virtual void dumpStats(std::ostream& out) const = 0;

  virtual IIncrementalItemConnectivityInternal* _internalApi() = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif