Arcane  v3.16.0.0
Documentation développeur
Chargement...
Recherche...
Aucune correspondance
ICaseOptionList.h
1// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
2//-----------------------------------------------------------------------------
3// Copyright 2000-2025 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/* ICaseOptionList.h (C) 2000-2025 */
9/* */
10/* Options du jeu de données. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_CORE_ICASEOPTIONLIST_H
13#define ARCANE_CORE_ICASEOPTIONLIST_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
19
20/*---------------------------------------------------------------------------*/
21/*---------------------------------------------------------------------------*/
22
23namespace Arcane
24{
25
26class XmlNode;
27class ICaseMng;
28class XmlNodeList;
30
31/*---------------------------------------------------------------------------*/
32/*---------------------------------------------------------------------------*/
37class ARCANE_CORE_EXPORT ICaseOptionList
38{
40
41 protected:
42
43 virtual ~ICaseOptionList() = default;
44
45 public:
46
53 virtual XmlNode rootElement() const =0;
55 virtual XmlNode parentElement() const =0;
57 virtual void addChild(ICaseOptions* co) =0;
59 virtual void removeChild(ICaseOptions* co) =0;
61 virtual ICaseMng* caseMng() const =0;
62
64 virtual void readChildren(bool is_phase1) =0;
66 virtual void printChildren(const String& lang,int indent) =0;
68 virtual String rootTagName() const =0;
72 virtual bool isPresent() const =0;
74 virtual bool isOptional() const =0;
76 virtual Integer minOccurs() const = 0;
78 virtual Integer maxOccurs() const = 0;
80 virtual void visit(ICaseDocumentVisitor* visitor) =0;
82 virtual String xpathFullName() const =0;
84 virtual MeshHandle meshHandle() const =0;
85
88
95 virtual void disable() = 0;
96
97 public:
98
100 ARCANE_DEPRECATED_REASON("Y2023: This method is internal to Arcane")
101 virtual void addConfig(CaseOptionBase* o,XmlNode parent) =0;
102
104 ARCANE_DEPRECATED_REASON("Y2023: This method is internal to Arcane")
105 virtual void setRootElementWithParent(XmlNode parent_element) =0;
106
108 ARCANE_DEPRECATED_REASON("Y2023: This method is internal to Arcane")
109 virtual void setRootElement(XmlNode root_element) =0;
110
112 ARCANE_DEPRECATED_REASON("Y2023: This method is internal to Arcane")
113 virtual void addInvalidChildren(XmlNodeList& nlist) =0;
114
115 public:
116
119};
120
121/*---------------------------------------------------------------------------*/
122/*---------------------------------------------------------------------------*/
123
124} // End namespace Arcane
125
126/*---------------------------------------------------------------------------*/
127/*---------------------------------------------------------------------------*/
128
129#endif
Déclarations des types généraux de Arcane.
Déclarations des types liés aux options du jeu de données.
#define ARCCORE_DECLARE_REFERENCE_COUNTED_INCLASS_METHODS()
Macro pour déclarer les méthodes virtuelles gérant les compteurs de référence.
Tableau d'items de types quelconques.
Classe de base d'une option du jeu de donnée.
Interface d'une partie d'un jeu de données.
Interface du visiteur pour une option du jeu de données.
Interface du gestionnaire de cas.
Definition ICaseMng.h:56
API Interne de l'interface d'une liste d'options du jeu de données.
Interface d'une liste d'options du jeu de données.
virtual Integer minOccurs() const =0
Nombre minimum d'occurences.
virtual void visit(ICaseDocumentVisitor *visitor)=0
Applique le visiteur visitor.
virtual XmlNode rootElement() const =0
Retourne l'élément lié à cette liste d'option.
virtual String xpathFullName() const =0
Nom complet au format XPath correspondant à rootElement()
virtual void addInvalidChildren(XmlNodeList &nlist)=0
Ajoute les éléments fils ne correspondants par à de options dans nlist.
virtual void setRootElement(XmlNode root_element)=0
Positionne l'élément racine de la liste. Si déjà positionné, lance une exception.
virtual void setRootElementWithParent(XmlNode parent_element)=0
Positionne l'élément racine de la liste, avec parent_element comme parent. Si déjà positionné,...
virtual String rootTagName() const =0
Retourne le nom de l'élément de cette liste.
virtual ICaseDocumentFragment * caseDocumentFragment() const =0
Document associé.
virtual void disable()=0
Désactive l'option comme si elle était absente.
virtual bool isOptional() const =0
Indique si l'option est optionnelle.
virtual void deepGetChildren(Array< CaseOptionBase * > &col)=0
Ajoute à la liste col tous les options filles.
virtual void readChildren(bool is_phase1)=0
Lis les valeurs des options à partir des éléments du DOM.
virtual void addChild(ICaseOptions *co)=0
Ajoute la liste co à la liste des fils.
virtual XmlNode parentElement() const =0
Retourne l'élément parent.
virtual Integer maxOccurs() const =0
Nombre maximum d'occurences.
virtual bool isPresent() const =0
Indique si l'option est présente dans le jeu de données.
virtual void printChildren(const String &lang, int indent)=0
Affiche la liste des options filles dans le langage lang et leur valeur.
virtual ICaseMng * caseMng() const =0
Retourne le gestionnaire du cas.
virtual MeshHandle meshHandle() const =0
Handle du maillage associé
virtual ICaseOptionListInternal * _internalApi()=0
API interne à Arcane.
virtual void removeChild(ICaseOptions *co)=0
Supprime co de la liste des fils.
virtual void addConfig(CaseOptionBase *o, XmlNode parent)=0
Ajoute l'option o avec le parent parent.
Interface d'une liste d'options du jeu de données.
Handle sur un maillage.
Definition MeshHandle.h:47
Chaîne de caractères unicode.
Liste de noeuds d'un arbre DOM.
Definition XmlNodeList.h:33
Noeud d'un arbre DOM.
Definition XmlNode.h:51
-*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
Int32 Integer
Type représentant un entier.