AbstractModule.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* AbstractModule.h                                            (C) 2000-2025 */
/*                                                                           */
/* Abstract base class of a module.                                          */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_ABSTRACTMODULE_H
#define ARCANE_CORE_ABSTRACTMODULE_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/String.h"
#include "arcane/utils/VersionInfo.h"
#include "arcane/utils/TraceAccessor.h"
 
#include "arcane/core/ArcaneTypes.h"
#include "arcane/core/IModule.h"
#include "arcane/core/ModuleBuildInfo.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class ModuleBuildInfo;
typedef ModuleBuildInfo ModuleBuilder;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT AbstractModule
: public TraceAccessor
, public IModule
{
 public:

  AbstractModule(const ModuleBuildInfo&);
 
 public:

  virtual ~AbstractModule();
 
 public:

  VersionInfo versionInfo() const override { return m_version_info; }
 
 public:

  static void staticInitialize(ISubDomain* sd) { ARCANE_UNUSED(sd); }
 
 public:

  String name() const override { return m_name; }
  ISession* session() const override { return m_session; }
  ISubDomain* subDomain() const override { return m_sub_domain; }
  IMesh* defaultMesh() const override { return m_default_mesh_handle.mesh(); }
  MeshHandle defaultMeshHandle() const override { return m_default_mesh_handle; }
  IParallelMng* parallelMng() const override;
  IAcceleratorMng* acceleratorMng() const override;
  ITraceMng* traceMng() const override;
  void setUsed(bool v) override { m_used = v; }
  bool used() const override { return m_used; }
  void setDisabled(bool v) override { m_disabled = v; }
  bool disabled() const override { return m_disabled; }

  bool isGarbageCollected() const override { return false; }
 
 protected:
 
  void _setVersionInfo(const VersionInfo& vi)
  {
    m_version_info = vi;
  }
 
 private:
 
  ISession* m_session; 
  ISubDomain* m_sub_domain; 
  MeshHandle m_default_mesh_handle; 
  String m_name; 
  bool m_used; 
  bool m_disabled; 
  VersionInfo m_version_info; 
  IAcceleratorMng* m_accelerator_mng; 
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif