Arcane  v3.16.0.0
Documentation développeur
Chargement...
Recherche...
Aucune correspondance
ICaseMng.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/* ICaseMng.h (C) 2000-2023 */
9/* */
10/* Interface de la classe gérant le jeu de données. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_ICASEMNG_H
13#define ARCANE_ICASEMNG_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
17#include "arcane/ArcaneTypes.h"
18
19/*---------------------------------------------------------------------------*/
20/*---------------------------------------------------------------------------*/
21
22namespace Arcane
23{
24
25/*---------------------------------------------------------------------------*/
26/*---------------------------------------------------------------------------*/
27
29
30/*---------------------------------------------------------------------------*/
31/*---------------------------------------------------------------------------*/
45
46/*---------------------------------------------------------------------------*/
47/*---------------------------------------------------------------------------*/
56{
57 ARCCORE_DECLARE_REFERENCE_COUNTED_INCLASS_METHODS();
58
59 public:
60
61 // TODO: rendre privé (début 2024)
62 virtual ~ICaseMng() = default;
63
64 public:
65
67 virtual IApplication* application() = 0;
68
70 virtual ITraceMng* traceMng() = 0;
71
73 virtual IMeshMng* meshMng() const = 0;
74
76 virtual ISubDomain* subDomain() = 0;
77
80
83
86
88 virtual ICaseDocument* readCaseDocument(const String& filename, ByteConstArrayView bytes) = 0;
89
91 virtual void readOptions(bool is_phase1) = 0;
92
94 virtual void printOptions() = 0;
95
97 virtual void readFunctions() = 0;
98
99 public:
100
102 virtual void registerOptions(ICaseOptions*) = 0;
103
105 virtual void unregisterOptions(ICaseOptions*) = 0;
106
108 virtual CaseOptionsCollection blocks() const = 0;
109
110 public:
111
113 virtual ICaseFunction* findFunction(const String& name) const = 0;
114
120 virtual CaseFunctionCollection functions() = 0;
121
129 ARCCORE_DEPRECATED_2019("Use removeFunction(ICaseFunction*) instead.")
130 virtual void removeFunction(ICaseFunction* func, bool dofree) = 0;
131
138 virtual void removeFunction(ICaseFunction* func) = 0;
139
146 ARCCORE_DEPRECATED_2019("Use addFunction(Ref<ICaseFunction>) instead.")
147 virtual void addFunction(ICaseFunction* func) = 0;
148
154 virtual void addFunction(Ref<ICaseFunction> func) = 0;
155
170 virtual void updateOptions(Real current_time, Real current_deltat, Integer current_iteration) = 0;
171
176 virtual void setTreatWarningAsError(bool v) = 0;
177
182 virtual bool isTreatWarningAsError() const = 0;
183
185 virtual void setAllowUnkownRootElelement(bool v) = 0;
186
188 virtual bool isAllowUnkownRootElelement() const = 0;
189
196
197 public:
198
199 virtual Ref<ICaseMng> toReference() = 0;
200
201 public:
202
205};
206
207/*---------------------------------------------------------------------------*/
208/*---------------------------------------------------------------------------*/
209
210} // End namespace Arcane
211
212/*---------------------------------------------------------------------------*/
213/*---------------------------------------------------------------------------*/
214
215#endif
Interface de l'application.
Interface d'une partie d'un jeu de données.
Interface d'une classe gérant un document XML du jeu de données.
Interface d'une fonction du jeu de données.
Partie interne de ICaseMng.
Interface du gestionnaire de cas.
Definition ICaseMng.h:56
virtual void addFunction(ICaseFunction *func)=0
Ajoute la fonction func.
virtual IPhysicalUnitSystem * physicalUnitSystem() const =0
Système d'unité associé.
virtual ~ICaseMng()=default
Libère les ressources.
virtual ICaseMngInternal * _internalImpl()=0
Implémentation interne.
virtual IMeshMng * meshMng() const =0
Gestionnaire de maillage associé
virtual ITraceMng * traceMng()=0
Gestionnaire de traces.
virtual void setTreatWarningAsError(bool v)=0
Positionne la manière de traiter les avertissements.
virtual bool isTreatWarningAsError() const =0
Indique si les avertissements dans le jeu de données doivent être traités comme des erreurs et provoq...
virtual void printOptions()=0
Affiche les valeurs des options.
virtual void removeFunction(ICaseFunction *func, bool dofree)=0
Supprime une fonction.
virtual void readFunctions()=0
Lit les tables du jeu de donnée.
virtual ISubDomain * subDomain()=0
Gestionnaire de sous-domaine.
virtual ICaseDocument * readCaseDocument(const String &filename, ByteConstArrayView bytes)=0
Lit le document XML du jeu de données.
virtual IApplication * application()=0
Application associée.
virtual IObservable * observable(eCaseMngEventType type)=0
Observable sur l'instance.
virtual CaseOptionsCollection blocks() const =0
Collection des blocs d'options.
virtual ICaseDocumentFragment * caseDocumentFragment()=0
Fragment du Document XML associé au jeu de données (peut être nul si pas de jeu de donneés)
virtual void readOptions(bool is_phase1)=0
Lit les options du jeu de donnée correspondant aux modules utilisés.
virtual void unregisterOptions(ICaseOptions *)=0
Déseregistre une liste d'options du jeu de donnée.
virtual CaseFunctionCollection functions()=0
Retourne la liste des tables.
virtual void setAllowUnkownRootElelement(bool v)=0
Positionne l'autorisation des éléments inconnus à la racine du document.
virtual void updateOptions(Real current_time, Real current_deltat, Integer current_iteration)=0
Met à jour les options basée sur une table de marche en temps.
virtual bool isAllowUnkownRootElelement() const =0
Indique si les éléments inconnus à la racine du document sont autorisés.
virtual ICaseDocument * caseDocument()=0
Document XML du jeu de données (peut être nul si pas de jeu de donneés)
virtual ICaseFunction * findFunction(const String &name) const =0
Retourne la fonction de nom name ou nullptr s'il n'y en a pas.
virtual void registerOptions(ICaseOptions *)=0
Enregistre une liste d'options du jeu de donnée.
Interface d'une liste d'options du jeu de données.
Interface du gestionnaire des maillages.
Definition IMeshMng.h:40
Interface d'un observable.
Interface d'un système d'unité.
Interface du gestionnaire d'un sous-domaine.
Definition ISubDomain.h:74
Interface du gestionnaire de traces.
Référence à une instance.
Chaîne de caractères unicode.
-*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
eCaseMngEventType
Types des évènements supportés par ICaseMng.
Definition ICaseMng.h:39
@ BeginReadOptionsPhase2
Évènement généré avant de lire les options dans la phase 2.
Definition ICaseMng.h:43
@ BeginReadOptionsPhase1
Évènement généré avant de lire les options dans la phase 1.
Definition ICaseMng.h:41
Int32 Integer
Type représentant un entier.
Collection< ICaseOptions * > CaseOptionsCollection
Collection d'options du jeu de données.
double Real
Type représentant un réel.
ConstArrayView< Byte > ByteConstArrayView
Equivalent C d'un tableau à une dimension de caractères.
Definition UtilsTypes.h:563