MeshHandle.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* MeshHandle.h                                                (C) 2000-2026 */
/*                                                                           */
/* Handle on a mesh.                                                         */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_MESHHANDLE_H
#define ARCANE_CORE_MESHHANDLE_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arccore/base/ReferenceCounterImpl.h"
#include "arccore/base/StringView.h"
#include "arccore/base/String.h"
#include "arccore/base/AutoRef2.h"
 
#include "arcane/utils/UtilsTypes.h"
#include "arcane/core/ArcaneTypes.h"
 
#include <atomic>
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
class ARCANE_CORE_EXPORT MeshHandle
{
 private:
 
  // Temporary: to access the constructor that uses ISubDomain.
  friend class MeshMng;
 
 private:
 
  class MeshHandleRef;
 
 public:
 
  MeshHandle();
  ~MeshHandle();
 
  MeshHandle(const MeshHandle&);
  MeshHandle& operator=(const MeshHandle&);
  MeshHandle(MeshHandle&&) noexcept;
  MeshHandle& operator=(MeshHandle&&) noexcept;
 
 private:
 
  // TODO make accessible only to classes implementing IMeshMng.
  MeshHandle(ISubDomain* sd, const String& name);
 
 public:

  IMesh* mesh() const;

  bool hasMesh() const;

  IMesh* meshOrNull() const;
 
 public:

  ARCCORE_DEPRECATED_2020("Do not use this method. Try to get ISubDomain from another way")
  ISubDomain* subDomain() const;
 
 public:

  IMeshMng* meshMng() const;

  ITraceMng* traceMng() const;

  IVariableMng* variableMng() const;

  IApplication* application() const;

  IUserDataList* meshUserDataList() const;
 
  String meshName() const;

  bool isNull() const;

  IObservable* onDestroyObservable() const;

  const void* reference() const { return m_ref.get(); }
 
 public:
 
  // TODO: Make these privates and add friend on them

  void _setMesh(IMesh* mesh);

  void _destroyMesh();

  IMesh* _internalMeshOrNull() const;
 
 private:
 
  AutoRef2<MeshHandleRef> m_ref;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
class ARCANE_CORE_EXPORT MeshHandleOrMesh
{
 public:
 
  // NOTE: The constructors must not be explicit
  // to allow conversions

  MeshHandleOrMesh(const MeshHandle& handle);

  MeshHandleOrMesh(IMesh* mesh);

  IMesh* mesh() const { return m_handle.meshOrNull(); }

  operator IMesh*() const { return mesh(); }

  const MeshHandle& handle() const { return m_handle; }
 
 private:
 
  MeshHandle m_handle;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif