ICaseOptions.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* ICaseOptions.h                                              (C) 2000-2025 */
/*                                                                           */
/* Data set options.                                                         */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_ICASEOPTIONS_H
#define ARCANE_CORE_ICASEOPTIONS_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/CaseOptionTypes.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT ICaseOptions
{
  ARCCORE_DECLARE_REFERENCE_COUNTED_INCLASS_METHODS();
 
 protected:
 
  virtual ~ICaseOptions() = default;
 
 public:

  virtual String rootTagTrueName() const = 0;

  virtual String rootTagName() const = 0;

  virtual String translatedName(const String& lang) const = 0;
 
  ARCCORE_DEPRECATED_2019("Use read(eCaseOptionReadPhase) instead")
  virtual void read(bool is_phase1) = 0;

  virtual void read(eCaseOptionReadPhase read_phase) = 0;
 
  virtual void addInvalidChildren(XmlNodeList&) = 0;
 
  virtual void printChildren(const String& lang, int indent) = 0;

  virtual IServiceInfo* caseServiceInfo() const = 0;

  virtual IModule* caseModule() const = 0;

  virtual void setCaseServiceInfo(IServiceInfo* m) = 0;

  virtual void setCaseModule(IModule* m) = 0;

  virtual void deepGetChildren(Array<CaseOptionBase*>& col) = 0;
 
  virtual ICaseOptionList* configList() = 0;
 
  virtual const ICaseOptionList* configList() const = 0;

  virtual ICaseFunction* activateFunction() = 0;

  virtual bool isPresent() const = 0;

  virtual void addAlternativeNodeName(const String& lang, const String& name) = 0;
 
  virtual ICaseMng* caseMng() const = 0;
  virtual ITraceMng* traceMng() const = 0;
  ARCCORE_DEPRECATED_2019("Do not use subDomain(). Try to get subDomain from an other way.")
  virtual ISubDomain* subDomain() const = 0;
  ARCCORE_DEPRECATED_2019("Use meshHandle().mesh() instead")
  virtual IMesh* mesh() const = 0;
  virtual MeshHandle meshHandle() const = 0;
  ARCANE_DEPRECATED_REASON("Y2023: use caseMng()->caseDocument() instead.")
  virtual ICaseDocument* caseDocument() const = 0;
  virtual ICaseDocumentFragment* caseDocumentFragment() const = 0;

  virtual void detach() = 0;

  virtual void visit(ICaseDocumentVisitor* visitor) const = 0;

  virtual String xpathFullName() const = 0;
 
 public:
 
  virtual Ref<ICaseOptions> toReference() = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
class ARCANE_CORE_EXPORT ICaseOptionsMulti
{
 public:
 
  virtual ~ICaseOptionsMulti() {}
 
 public:
 
  virtual void multiAllocate(const XmlNodeList&) = 0;
  virtual ICaseOptions* toCaseOptions() = 0;
  virtual void addChild(ICaseOptionList* v) = 0;
  virtual Integer nbChildren() const = 0;
  virtual ICaseOptionList* child(Integer index) const = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
extern "C++" ARCANE_CORE_EXPORT ISubDomain*
_arcaneDeprecatedGetSubDomain(ICaseOptions* opt);
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif