IEntryPoint.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* IEntryPoint.h                                               (C) 2000-2025 */
/*                                                                           */
/* Interface of a module entry point.                                        */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_IENTRYPOINT_H
#define ARCANE_CORE_IENTRYPOINT_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/ArcaneTypes.h"
#include "arcane/core/Timer.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
class IModule;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT IEntryPoint
{
 public:


  static const char* const WComputeLoop;
  static const char* const WBuild;
  static const char* const WInit;
  static const char* const WContinueInit;
  static const char* const WStartInit;
  static const char* const WRestore;
  static const char* const WOnMeshChanged;
  static const char* const WOnMeshRefinement;
  static const char* const WExit;

  enum
  {
    PNone = 0, 
    PAutoLoadBegin = 1,
    PAutoLoadEnd = 2
  };
 
 public:
 
  virtual ~IEntryPoint() = default; 
 
 public:

  virtual String name() const = 0;

  virtual String fullName() const = 0;
 
 public:

  ARCANE_DEPRECATED_REASON("Y2022: Do not use this method. Try to get 'ISubDomain' from another way")
  virtual ISubDomain* subDomain() const = 0;

  virtual IModule* module() const = 0;

  virtual void executeEntryPoint() = 0;

  virtual Real totalCPUTime() const = 0;

  virtual Real lastCPUTime() const = 0;

  virtual Real totalElapsedTime() const = 0;

  virtual Real lastElapsedTime() const = 0;

  ARCANE_DEPRECATED_REASON("Y2022: Use totalElapsedTime() instead")
  virtual Real totalTime(Timer::eTimerType) const = 0;

  ARCANE_DEPRECATED_REASON("Y2022: Use lastElapsedTime() instead")
  virtual Real lastTime(Timer::eTimerType) const = 0;

  virtual Integer nbCall() const = 0;

  virtual String where() const = 0;

  virtual int property() const = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif