CaseOptionEnum.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* CaseOptionEnum.h                                            (C) 2000-2023 */
/*                                                                           */
/* Enumerated data set option.                                               */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CASEOPTIONENUM_H
#define ARCANE_CASEOPTIONENUM_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/CaseOptionSimple.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT CaseOptionName
{
 public:

  CaseOptionName(const String& true_name);
  CaseOptionName(const CaseOptionName& rhs);
  virtual ~CaseOptionName();
 
 public:

  String name(const String& lang) const;
  String trueName() const { return m_true_name; }
  void addAlternativeNodeName(const String& lang, const String& tname);
 
 private:
 
  String m_true_name; 
  StringDictionary* m_translations; 
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT CaseOptionEnumValue
: public CaseOptionName
{
 public:
 
  CaseOptionEnumValue(const String& name, int value);
  CaseOptionEnumValue(const CaseOptionEnumValue& rhs);
  ~CaseOptionEnumValue();
 
 public:
 
  int value() const { return m_value; }
 
 private:
 
  int m_value;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT CaseOptionEnumValues
{
 public:

  typedef UniqueArray<CaseOptionEnumValue*> EnumValueList;
 
 public:

  CaseOptionEnumValues();
  ~CaseOptionEnumValues(); 
 
 public:

  void addEnumValue(CaseOptionEnumValue* value, bool do_clone);

  Integer nbEnumValue() const;

  CaseOptionEnumValue* enumValue(Integer index) const;

  bool valueOfName(const String& name, const String& lang, int& value) const;

  String nameOfValue(int value, const String& lang) const;

  void getValidNames(const String& lang, StringArray& names) const;
 
 private:
 
  EnumValueList* m_enum_values; 
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT CaseOptionEnum
: public CaseOptionSimple
{
 public:
 
  CaseOptionEnum(const CaseOptionBuildInfo& cob, const String& type_name);
  ~CaseOptionEnum();
 
 public:
 
  virtual void print(const String& lang, std::ostream& o) const;
  virtual void updateFromFunction(Real current_time, Integer current_iteration)
  {
    _updateFromFunction(current_time, current_iteration);
  }
 
  void addEnumValue(CaseOptionEnumValue* value, bool do_clone)
  {
    m_enum_values->addEnumValue(value, do_clone);
  }
  CaseOptionEnumValues* enumValues() const { return m_enum_values; }
 
  virtual void visit(ICaseDocumentVisitor* visitor) const;
 
  int enumValueAsInt() const { return _optionValue(); }
 
 public:
 protected:
 
  virtual void _search(bool is_phase1);
  virtual bool _allowPhysicalUnit() { return false; }

  virtual void _setOptionValue(int v) = 0;
  virtual int _optionValue() const = 0;
 
 protected:
 
  void _setEnumDefaultValue(int def_value);
 
 private:
 
  String m_type_name; 
  CaseOptionEnumValues* m_enum_values;
  void _updateFromFunction(Real current_time, Integer current_iteration);
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

template <class EnumType>
class CaseOptionEnumT
: public CaseOptionEnum
{
 public:
 
  CaseOptionEnumT(const CaseOptionBuildInfo& cob, const String& type_name)
  : CaseOptionEnum(cob, type_name)
  , m_value(EnumType())
  {}
 
 public:

  EnumType value() const
  {
    ARCANE_CASEOPTION_CHECK_IS_INITIALIZED;
    return m_value;
  }

  operator EnumType() const { return value(); }

  EnumType operator()() const { return value(); }

  void setDefaultValue(EnumType def_value)
  {
    _setEnumDefaultValue(static_cast<int>(def_value));
  }

  EnumType valueIfPresentOrArgument(EnumType arg_value)
  {
    ARCANE_CASEOPTION_CHECK_IS_INITIALIZED;
    return isPresent() ? m_value : arg_value;
  }
 
 private:
 
  EnumType m_value; 
 
 public:
 protected:
 
  virtual void _setOptionValue(int i)
  {
    m_value = static_cast<EnumType>(i);
  }
  virtual int _optionValue() const
  {
    return static_cast<int>(m_value);
  }
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT CaseOptionMultiEnum
: public CaseOptionBase
{
 public:
 public:
 
  CaseOptionMultiEnum(const CaseOptionBuildInfo& cob, const String& type_name);
  ~CaseOptionMultiEnum();
 
 public:
 
  virtual void print(const String& lang, std::ostream& o) const;
  virtual ICaseFunction* function() const { return 0; }
  virtual void updateFromFunction(Real /*current_time*/, Integer /*current_iteration*/) {}
 
  void addEnumValue(CaseOptionEnumValue* value, bool do_clone)
  {
    m_enum_values->addEnumValue(value, do_clone);
  }
 
  CaseOptionEnumValues* enumValues() const { return m_enum_values; }
 
  virtual void visit(ICaseDocumentVisitor* visitor) const;
 
 protected:
 
  virtual void _search(bool is_phase1);
  virtual bool _allowPhysicalUnit() { return false; }

  virtual void _allocate(Integer size) = 0;
  virtual Integer _nbElem() const = 0;
  virtual void _setOptionValue(Integer index, int v) = 0;
  virtual int _optionValue(Integer index) const = 0;
 
 private:
 
  String m_type_name; 
  CaseOptionEnumValues* m_enum_values;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

template <class T>
class CaseOptionMultiEnumT
: public CaseOptionMultiEnum
, public ArrayView<T>
{
 public:
 
  typedef T Type; 
 
 public:
 
  CaseOptionMultiEnumT(const CaseOptionBuildInfo& cob, const String type_name)
  : CaseOptionMultiEnum(cob, type_name)
  {}
 
 protected:
 
  virtual void _allocate(Integer size)
  {
    m_values.resize(size);
    ArrayView<T>* view = this;
    *view = m_values.view();
  }
  virtual Integer _nbElem() const
  {
    return this->size();
  }
  virtual void _setOptionValue(Integer index, int v)
  {
    (*this)[index] = static_cast<T>(v);
  }
  virtual int _optionValue(Integer index) const
  {
    return static_cast<int>((*this)[index]);
  }
 
 private:
 
  UniqueArray<T> m_values;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif