CaseOptionBase.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* CaseOptionBase.h                                            (C) 2000-2025 */
/*                                                                           */
/* Base class for a data set option.                                         */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CASEOPTIONBASE_H
#define ARCANE_CASEOPTIONBASE_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/String.h"
 
#include "arcane/core/XmlNode.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class CaseOptionBuildInfo;
class ICaseDocument;
class ICaseDocumentFragment;
class ICaseMng;
class ICaseOptionList;
class ISubDomain;
class ICaseFunction;
class CaseOptionBasePrivate;
class ICaseDocumentVisitor;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT CaseOptionBase
{
 protected:
 
  CaseOptionBase(const CaseOptionBuildInfo& cob);
 
 public:
 
  virtual ~CaseOptionBase();
 
 public:

  String trueName() const;

  String name() const;

  String translatedName(const String& lang) const;

  void search(bool is_phase1);

  virtual void print(const String& lang, std::ostream& o) const = 0;

  ICaseMng* caseMng() const;

  ICaseOptionList* parentOptionList() const;

  ITraceMng* traceMng() const;

  ARCCORE_DEPRECATED_2019("Do not use subDomain(). Try to get subDomain from an other way.")
  ISubDomain* subDomain() const;

  ARCANE_DEPRECATED_REASON("Y2023: use caseMng()->caseDocument() instead.")
  ICaseDocument* caseDocument() const;

  ICaseDocumentFragment* caseDocumentFragment() const;

  void setRootElement(const XmlNode& root_element);

  XmlNode rootElement() const;

  virtual ICaseFunction* function() const = 0;

  Integer minOccurs() const;

  Integer maxOccurs() const;

  bool isOptional() const;

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

  void addAlternativeNodeName(const String& lang, const String& name);

  void addDefaultValue(const String& category, const String& value);

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

  void checkIsInitialized() const { _checkIsInitialized(); }
 
 protected:

  String _defaultValue() const;
 
  void _setDefaultValue(const String& def_value);
 
 protected:
 
  virtual void _search(bool is_phase1) = 0;
  void _setIsInitialized();
  bool _isInitialized() const;
  void _checkIsInitialized() const;
  void _checkMinMaxOccurs(Integer nb_occur);
  String _xpathFullName() const;
 
 private:
 
  CaseOptionBasePrivate* m_p; 
 
 private:
 
  void _setTranslatedName();
  void _setCategoryDefaultValue();
  CaseOptionBase(const CaseOptionBase& from) = delete;
  CaseOptionBase& operator=(const CaseOptionBase& from) = delete;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif