ICaseMng.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* ICaseMng.h                                                  (C) 2000-2025 */
/*                                                                           */
/* Interface for the class managing the dataset.                             */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_ICASEMNG_H
#define ARCANE_CORE_ICASEMNG_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/ArcaneTypes.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class ICaseMngInternal;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

enum class eCaseMngEventType
{
  BeginReadOptionsPhase1,
  BeginReadOptionsPhase2
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ICaseMng
{
  ARCCORE_DECLARE_REFERENCE_COUNTED_INCLASS_METHODS();
 
 public:
 
  // TODO: make private (start 2024)
  virtual ~ICaseMng() = default; 
 
 public:

  virtual IApplication* application() = 0;

  virtual ITraceMng* traceMng() = 0;

  virtual IMeshMng* meshMng() const = 0;

  virtual ISubDomain* subDomain() = 0;

  virtual ICaseDocument* caseDocument() = 0;

  virtual ICaseDocumentFragment* caseDocumentFragment() = 0;

  virtual IPhysicalUnitSystem* physicalUnitSystem() const = 0;

  virtual ICaseDocument* readCaseDocument(const String& filename, ByteConstArrayView bytes) = 0;

  virtual void readOptions(bool is_phase1) = 0;

  virtual void printOptions() = 0;

  virtual void readFunctions() = 0;
 
 public:

  virtual void registerOptions(ICaseOptions*) = 0;

  virtual void unregisterOptions(ICaseOptions*) = 0;

  virtual CaseOptionsCollection blocks() const = 0;
 
 public:

  virtual ICaseFunction* findFunction(const String& name) const = 0;

  virtual CaseFunctionCollection functions() = 0;

  ARCCORE_DEPRECATED_2019("Use removeFunction(ICaseFunction*) instead.")
  virtual void removeFunction(ICaseFunction* func, bool dofree) = 0;

  virtual void removeFunction(ICaseFunction* func) = 0;

  ARCCORE_DEPRECATED_2019("Use addFunction(Ref<ICaseFunction>) instead.")
  virtual void addFunction(ICaseFunction* func) = 0;

  virtual void addFunction(Ref<ICaseFunction> func) = 0;

  virtual void updateOptions(Real current_time, Real current_deltat, Integer current_iteration) = 0;

  virtual void setTreatWarningAsError(bool v) = 0;

  virtual bool isTreatWarningAsError() const = 0;

  virtual void setAllowUnkownRootElelement(bool v) = 0;

  virtual bool isAllowUnkownRootElelement() const = 0;

  virtual IObservable* observable(eCaseMngEventType type) = 0;
 
 public:
 
  virtual Ref<ICaseMng> toReference() = 0;
 
 public:

  virtual ICaseMngInternal* _internalImpl() = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif