IModuleFactory.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* IModuleFactory.h                                            (C) 2000-2019 */
/*                                                                           */
/* Module manufacturing interface.                                           */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_IMODULEFACTORY_H
#define ARCANE_IMODULEFACTORY_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arccore/base/ReferenceCounter.h"
#include "arcane/utils/ArcaneGlobal.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
class MeshHandle;
class IModuleFactory2;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT IModuleFactoryInfo
{
 protected:

  virtual ~IModuleFactoryInfo() {}
 
 public:
 
  virtual void addReference() = 0;
  virtual void removeReference() = 0;
  virtual bool isAutoload() const = 0;

  virtual void initializeModuleFactory(ISubDomain* sub_domain) = 0;

  virtual Ref<IModule> createModule(ISubDomain* parent, const MeshHandle& mesh_handle) = 0;

  virtual String moduleName() const = 0;

  virtual const IServiceInfo* serviceInfo() const = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT IModuleFactory2
{
 public:
 
  virtual ~IModuleFactory2() {}
 
 public:

  virtual Ref<IModule> createModuleInstance(ISubDomain* sd, const MeshHandle& mesh_handle) = 0;

  virtual void initializeModuleFactory(ISubDomain* sd) = 0;

  virtual String moduleName() const = 0;

  virtual const IServiceInfo* serviceInfo() const = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT ModuleFactoryReference
: ReferenceCounter<IModuleFactoryInfo>
{
 public:
 
  typedef ReferenceCounter<IModuleFactoryInfo> Base;
 
 public:
 
  explicit ModuleFactoryReference(IModuleFactoryInfo* f)
  : Base(f)
  {}
  ModuleFactoryReference(Ref<IModuleFactory2> factory, bool is_autoload);
 
 public:
 
  IModuleFactoryInfo* factory() const { return get(); }
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif