Arcane  v3.16.0.0
Documentation développeur
Chargement...
Recherche...
Aucune correspondance
CaseOptionEnum.h
1// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
2//-----------------------------------------------------------------------------
3// Copyright 2000-2023 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
4// See the top-level COPYRIGHT file for details.
5// SPDX-License-Identifier: Apache-2.0
6//-----------------------------------------------------------------------------
7/*---------------------------------------------------------------------------*/
8/* CaseOptionEnum.h (C) 2000-2023 */
9/* */
10/* Option du jeu de données de type énuméré. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_CASEOPTIONENUM_H
13#define ARCANE_CASEOPTIONENUM_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
17#include "arcane/core/CaseOptionSimple.h"
18
19/*---------------------------------------------------------------------------*/
20/*---------------------------------------------------------------------------*/
21
22namespace Arcane
23{
24
25/*---------------------------------------------------------------------------*/
26/*---------------------------------------------------------------------------*/
33class ARCANE_CORE_EXPORT CaseOptionName
34{
35 public:
36
38 CaseOptionName(const String& true_name);
42 virtual ~CaseOptionName();
43
44 public:
45
50 String name(const String& lang) const;
52 String trueName() const { return m_true_name; }
61 void addAlternativeNodeName(const String& lang, const String& tname);
62
63 private:
64
67};
68
69/*---------------------------------------------------------------------------*/
70/*---------------------------------------------------------------------------*/
75class ARCANE_CORE_EXPORT CaseOptionEnumValue
76: public CaseOptionName
77{
78 public:
79
80 CaseOptionEnumValue(const String& name, int value);
82 CaseOptionEnumValue(const CaseOptionEnumValue& rhs);
83 ~CaseOptionEnumValue();
84
85 public:
86
87 int value() const { return m_value; }
88
89 private:
90
91 int m_value;
92};
93
94/*---------------------------------------------------------------------------*/
95/*---------------------------------------------------------------------------*/
100class ARCANE_CORE_EXPORT CaseOptionEnumValues
101{
102 public:
103
106
107 public:
108
112
113 public:
114
121 void addEnumValue(CaseOptionEnumValue* value, bool do_clone);
122
124 Integer nbEnumValue() const;
125
128
138 bool valueOfName(const String& name, const String& lang, int& value) const;
139
141 String nameOfValue(int value, const String& lang) const;
142
146 void getValidNames(const String& lang, StringArray& names) const;
147
148 private:
149
151};
152
153/*---------------------------------------------------------------------------*/
154/*---------------------------------------------------------------------------*/
159class ARCANE_CORE_EXPORT CaseOptionEnum
160: public CaseOptionSimple
161{
162 public:
163
164 CaseOptionEnum(const CaseOptionBuildInfo& cob, const String& type_name);
165 ~CaseOptionEnum();
166
167 public:
168
169 virtual void print(const String& lang, std::ostream& o) const;
170 virtual void updateFromFunction(Real current_time, Integer current_iteration)
171 {
172 _updateFromFunction(current_time, current_iteration);
173 }
174
175 void addEnumValue(CaseOptionEnumValue* value, bool do_clone)
176 {
177 m_enum_values->addEnumValue(value, do_clone);
178 }
179 CaseOptionEnumValues* enumValues() const { return m_enum_values; }
180
181 virtual void visit(ICaseDocumentVisitor* visitor) const;
182
183 int enumValueAsInt() const { return _optionValue(); }
184
185 public:
186 protected:
187
188 virtual void _search(bool is_phase1);
189 virtual bool _allowPhysicalUnit() { return false; }
190
192 virtual void _setOptionValue(int v) = 0;
194 virtual int _optionValue() const = 0;
195
196 protected:
197
198 void _setEnumDefaultValue(int def_value);
199
200 private:
201
203 CaseOptionEnumValues* m_enum_values;
204 void _updateFromFunction(Real current_time, Integer current_iteration);
205};
206
207/*---------------------------------------------------------------------------*/
208/*---------------------------------------------------------------------------*/
215template <class EnumType>
216class CaseOptionEnumT
217: public CaseOptionEnum
218{
219 public:
220
221 CaseOptionEnumT(const CaseOptionBuildInfo& cob, const String& type_name)
222 : CaseOptionEnum(cob, type_name)
223 , m_value(EnumType())
224 {}
225
226 public:
227
229 EnumType value() const
230 {
231 ARCANE_CASEOPTION_CHECK_IS_INITIALIZED;
232 return m_value;
233 }
234
236 operator EnumType() const { return value(); }
237
239 EnumType operator()() const { return value(); }
240
247 void setDefaultValue(EnumType def_value)
248 {
249 _setEnumDefaultValue(static_cast<int>(def_value));
250 }
251
253 EnumType valueIfPresentOrArgument(EnumType arg_value)
254 {
255 ARCANE_CASEOPTION_CHECK_IS_INITIALIZED;
256 return isPresent() ? m_value : arg_value;
257 }
258
259 private:
260
261 EnumType m_value;
262
263 public:
264 protected:
265
266 virtual void _setOptionValue(int i)
267 {
268 m_value = static_cast<EnumType>(i);
269 }
270 virtual int _optionValue() const
271 {
272 return static_cast<int>(m_value);
273 }
274};
275
276/*---------------------------------------------------------------------------*/
277/*---------------------------------------------------------------------------*/
282class ARCANE_CORE_EXPORT CaseOptionMultiEnum
283: public CaseOptionBase
284{
285 public:
286 public:
287
288 CaseOptionMultiEnum(const CaseOptionBuildInfo& cob, const String& type_name);
289 ~CaseOptionMultiEnum();
290
291 public:
292
293 virtual void print(const String& lang, std::ostream& o) const;
294 virtual ICaseFunction* function() const { return 0; }
295 virtual void updateFromFunction(Real /*current_time*/, Integer /*current_iteration*/) {}
296
297 void addEnumValue(CaseOptionEnumValue* value, bool do_clone)
298 {
299 m_enum_values->addEnumValue(value, do_clone);
300 }
301
302 CaseOptionEnumValues* enumValues() const { return m_enum_values; }
303
304 virtual void visit(ICaseDocumentVisitor* visitor) const;
305
306 protected:
307
308 virtual void _search(bool is_phase1);
309 virtual bool _allowPhysicalUnit() { return false; }
310
312 virtual void _allocate(Integer size) = 0;
314 virtual Integer _nbElem() const = 0;
318 virtual void _setOptionValue(Integer index, int v) = 0;
320 virtual int _optionValue(Integer index) const = 0;
321
322 private:
323
325 CaseOptionEnumValues* m_enum_values;
326};
327
328/*---------------------------------------------------------------------------*/
329/*---------------------------------------------------------------------------*/
334template <class T>
335class CaseOptionMultiEnumT
336: public CaseOptionMultiEnum
337, public ArrayView<T>
338{
339 public:
340
341 typedef T Type;
342
343 public:
344
345 CaseOptionMultiEnumT(const CaseOptionBuildInfo& cob, const String type_name)
346 : CaseOptionMultiEnum(cob, type_name)
347 {}
348
349 protected:
350
351 virtual void _allocate(Integer size)
352 {
353 m_values.resize(size);
354 ArrayView<T>* view = this;
355 *view = m_values.view();
356 }
357 virtual Integer _nbElem() const
358 {
359 return this->size();
360 }
361 virtual void _setOptionValue(Integer index, int v)
362 {
363 (*this)[index] = static_cast<T>(v);
364 }
365 virtual int _optionValue(Integer index) const
366 {
367 return static_cast<int>((*this)[index]);
368 }
369
370 private:
371
372 UniqueArray<T> m_values;
373};
374
375/*---------------------------------------------------------------------------*/
376/*---------------------------------------------------------------------------*/
377
378} // End namespace Arcane
379
380/*---------------------------------------------------------------------------*/
381/*---------------------------------------------------------------------------*/
382
383#endif
constexpr ArrayView() noexcept
Construit une vue vide.
constexpr Integer size() const noexcept
Retourne la taille du tableau.
Informations pour construire une option de jeu de données.
EnumType value() const
Valeur de l'option.
EnumType operator()() const
Valeur de l'option.
void setDefaultValue(EnumType def_value)
Positionne la valeur par défaut de l'option.
EnumType m_value
Valeur de l'option.
virtual void _setOptionValue(int i)
Positionne à v la valeur de l'option.
EnumType valueIfPresentOrArgument(EnumType arg_value)
Retourne la valeur de l'option si isPresent()==true ou sinon arg_value.
virtual int _optionValue() const
Retourne la valeur de l'option.
Nom et valeur d'une énumération du jeu de données.
Ensemble des valeurs d'une énumération.
String nameOfValue(int value, const String &lang) const
Retourne le nom de correspondant à la valeur value pour le langage lang.
CaseOptionEnumValues()
Contruit l'instance.
UniqueArray< CaseOptionEnumValue * > EnumValueList
Type de la liste des valeurs.
void getValidNames(const String &lang, StringArray &names) const
Remplit names avec les noms valides pour la langue lang.
EnumValueList * m_enum_values
Valeurs de l'énumération.
bool valueOfName(const String &name, const String &lang, int &value) const
Retourne la valeur de l'énumération ayant le nom name.
Integer nbEnumValue() const
Retourne le nombre de valeurs de l'énumération.
CaseOptionEnumValue * enumValue(Integer index) const
Retourne la ième valeur.
void addEnumValue(CaseOptionEnumValue *value, bool do_clone)
Ajoute la valeur d'énumération value. L'instance devient propriétaire de value qui est détruite lorsq...
virtual void print(const String &lang, std::ostream &o) const
Imprime la valeur de l'option dans le langage lang,sur le flot o.
virtual void _setOptionValue(int v)=0
Positionne à v la valeur de l'option.
virtual void updateFromFunction(Real current_time, Integer current_iteration)
Met à jour la valeur de l'option à partir d'une fonction.
virtual int _optionValue() const =0
Retourne la valeur de l'option.
String m_type_name
Nom de l'énumération.
virtual void _setOptionValue(Integer index, int v)
virtual Integer _nbElem() const
Retourne le nombre d'éléments du tableau.
virtual int _optionValue(Integer index) const
Retourne la valeur de l'énumération pour l'indice index.
virtual void _allocate(Integer size)
Alloue un tableau pour size éléments.
virtual Integer _nbElem() const =0
Retourne le nombre d'éléments du tableau.
String m_type_name
Nom de l'énumération.
virtual void print(const String &lang, std::ostream &o) const
Imprime la valeur de l'option dans le langage lang,sur le flot o.
virtual void _allocate(Integer size)=0
Alloue un tableau pour size éléments.
virtual ICaseFunction * function() const
Retourne la fonction liée à cette option ou nullptr s'il n'y en a pas.
virtual void updateFromFunction(Real, Integer)
Met à jour la valeur de l'option à partir d'une fonction.
virtual int _optionValue(Integer index) const =0
Retourne la valeur de l'énumération pour l'indice index.
virtual void _setOptionValue(Integer index, int v)=0
String name(const String &lang) const
retourne le nom de l'option dans le langage lang. Si aucune traduction n'est disponible dans le langa...
CaseOptionName(const String &true_name)
Construit une option de nom true_name.
String trueName() const
Retourne le vrai nom (non traduit) de l'option.
StringDictionary * m_translations
Traductions.
String m_true_name
Nom de l'option.
bool isPresent() const
Retourne true si l'option est présente.
Interface d'une fonction du jeu de données.
Dictionnaire de chaînes unicode.
Chaîne de caractères unicode.
Vecteur 1D de données avec sémantique par valeur (style STL).
-*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
Array< String > StringArray
Tableau dynamique à une dimension de chaînes de caractères.
Definition UtilsTypes.h:232
Int32 Integer
Type représentant un entier.
double Real
Type représentant un réel.