Arcane  v3.16.0.0
Documentation développeur
Chargement...
Recherche...
Aucune correspondance
Properties.h
1// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
2//-----------------------------------------------------------------------------
3// Copyright 2000-2022 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/* Properties.h (C) 2000-2022 */
9/* */
10/* Liste de propriétés. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_PROPERTIES_H
13#define ARCANE_PROPERTIES_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
18#include "arcane/utils/AutoRef.h"
19#include "arcane/SharedReference.h"
20#include "arcane/ArcaneTypes.h"
21
22/*---------------------------------------------------------------------------*/
23/*---------------------------------------------------------------------------*/
24
25namespace Arcane
26{
27
28/*---------------------------------------------------------------------------*/
29/*---------------------------------------------------------------------------*/
30
31class PropertiesImpl;
32class IPropertyMng;
33
35: public SharedReference
36{
37};
38
39/*---------------------------------------------------------------------------*/
40/*---------------------------------------------------------------------------*/
63class ARCANE_CORE_EXPORT Properties
64{
65 public:
66
69
71 Properties(const Properties& parent_property,const String& name);
72
74 Properties(const Properties& rhs);
76 const Properties& operator=(const Properties& rhs);
78 virtual ~Properties();
79
80 public:
81
83 void setBool(const String& name,bool value);
84
86 void set(const String& name,bool value);
87
89 bool getBool(const String& name) const;
90
92 bool getBoolWithDefault(const String& name,bool default_value) const;
93
95 bool get(const String& name,bool& value) const;
96
98 void setInt32(const String& name,Int32 value);
99
101 void set(const String& name,Int32 value);
102
104 Int32 getInt32(const String& name) const;
105
107 Int32 getInt32WithDefault(const String& name,Int32 default_value) const;
108
110 bool get(const String& name,Int32& value) const;
111
113 void setInt64(const String& name,Int64 value);
114
116 void set(const String& name,Int64 value);
117
119 Int64 getInt64(const String& name) const;
120
122 Int64 getInt64WithDefault(const String& name,Int64 default_value) const;
123
125 bool get(const String& name,Int64& value) const;
126
128 void setInteger(const String& name,Integer value);
129
131 Integer getInteger(const String& name) const;
132
134 Integer getIntegerWithDefault(const String& name,Integer default_value) const;
135
137 void setReal(const String& name,Real value);
138
140 void set(const String& name,Real value);
141
143 Real getReal(const String& name) const;
144
146 Real getRealWithDefault(const String& name,Real default_value) const;
147
149 bool get(const String& name,Real& value) const;
150
152 void setString(const String& name,const String& value);
153
155 void set(const String& name,const String& value);
156
158 String getString(const String& name) const;
159
161 String getStringWithDefault(const String& name,const String& default_value) const;
162
164 bool get(const String& name,String& value) const;
165
167 void set(const String& name,BoolConstArrayView value);
168
170 void get(const String& name,BoolArray& value) const;
171
173 void set(const String& name,Int32ConstArrayView value);
174
176 void get(const String& name,Int32Array& value) const;
177
179 void set(const String& name,Int64ConstArrayView value);
180
182 void get(const String& name,Int64Array& value) const;
183
185 void set(const String& name,RealConstArrayView value);
186
188 void get(const String& name,RealArray& value) const;
189
191 void set(const String& name,StringConstArrayView value);
192
194 void get(const String& name,StringArray& value) const;
195
196 public:
197
199 void print(std::ostream& o) const;
200
202 void serialize(ISerializer* serializer);
203
205 const String& name() const;
206
208 const String& fullName() const;
209
210 IPropertyMng* propertyMng() const;
211
215 void destroy();
216
218 PropertiesImpl* impl() const { return m_p; }
219
221 PropertiesImplBase* baseImpl() const { return m_ref.get(); }
222
223 private:
224
225 PropertiesImpl* m_p;
227
228 private:
229
231};
232
233/*---------------------------------------------------------------------------*/
234/*---------------------------------------------------------------------------*/
235
236} // End namespace Arcane
237
238/*---------------------------------------------------------------------------*/
239/*---------------------------------------------------------------------------*/
240
241#endif
242
Déclarations des types utilisés dans Arcane.
Encapsulation d'un pointeur avec compteur de référence.
Definition AutoRef.h:41
Interface du gestionnaire des propriétés.
Liste de propriétés.
Definition Properties.h:64
Int64 getInt64(const String &name) const
Valeur de la propriété de nom name.
bool get(const String &name, bool &value) const
Valeur de la propriété de nom name.
PropertiesImplBase * baseImpl() const
Definition Properties.h:221
bool getBoolWithDefault(const String &name, bool default_value) const
Valeur de la propriété de nom name.
const String & name() const
Nom de la propriété.
Int32 getInt32WithDefault(const String &name, Int32 default_value) const
Valeur de la propriété de nom name.
Int32 getInt32(const String &name) const
Valeur de la propriété de nom name.
Integer getInteger(const String &name) const
Valeur de la propriété de nom name.
Integer getIntegerWithDefault(const String &name, Integer default_value) const
Valeur de la propriété de nom name.
bool getBool(const String &name) const
Valeur de la propriété de nom name.
void setInteger(const String &name, Integer value)
Positionne une propriété de type Integer de nom name et de valeur value.
void setInt64(const String &name, Int64 value)
Positionne une propriété de type Int64 de nom name et de valeur value.
void destroy()
Supprime les valeurs associées des propriétés associées à cette référence.
PropertiesImpl * impl() const
Definition Properties.h:218
Real getReal(const String &name) const
Valeur de la propriété de nom name.
void setInt32(const String &name, Int32 value)
Positionne une propriété de type Int32 de nom name et de valeur value.
Int64 getInt64WithDefault(const String &name, Int64 default_value) const
Valeur de la propriété de nom name.
void set(const String &name, bool value)
Positionne une propriété de type bool de nom name et de valeur value.
String getString(const String &name) const
Valeur de la propriété de nom name.
Real getRealWithDefault(const String &name, Real default_value) const
Valeur de la propriété de nom name.
const Properties & operator=(const Properties &rhs)
Opérateur de recopie.
String getStringWithDefault(const String &name, const String &default_value) const
Valeur de la propriété de nom name.
void serialize(ISerializer *serializer)
Effectue la sérialisation des propriétés.
Properties(IPropertyMng *pm, const String &name)
Créé ou récupère une liste de propriétés de nom name.
void setBool(const String &name, bool value)
Positionne une propriété de type bool de nom name et de valeur value.
void setString(const String &name, const String &value)
Positionne une propriété de type String de nom name et de valeur value.
const String & fullName() const
Nom complet de la propriété.
void print(std::ostream &o) const
Sort les propriétés et leurs valeurs sur le flot o.
void setReal(const String &name, Real value)
Positionne une propriété de type Real de nom name et de valeur value.
Chaîne de caractères unicode.
-*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
Array< Int64 > Int64Array
Tableau dynamique à une dimension d'entiers 64 bits.
Definition UtilsTypes.h:212
ConstArrayView< String > StringConstArrayView
Equivalent C d'un tableau à une dimension de chaînes de caractères.
Definition UtilsTypes.h:579
Array< String > StringArray
Tableau dynamique à une dimension de chaînes de caractères.
Definition UtilsTypes.h:232
Array< bool > BoolArray
Tableau dynamique à une dimension de booléens.
Definition UtilsTypes.h:230
std::int64_t Int64
Type entier signé sur 64 bits.
Int32 Integer
Type représentant un entier.
ConstArrayView< Int32 > Int32ConstArrayView
Equivalent C d'un tableau à une dimension d'entiers 32 bits.
Definition UtilsTypes.h:569
ConstArrayView< bool > BoolConstArrayView
Equivalent C d'un tableau à une dimension de booléens.
Definition UtilsTypes.h:577
ConstArrayView< Int64 > Int64ConstArrayView
Equivalent C d'un tableau à une dimension d'entiers 64 bits.
Definition UtilsTypes.h:567
double Real
Type représentant un réel.
Array< Int32 > Int32Array
Tableau dynamique à une dimension d'entiers 32 bits.
Definition UtilsTypes.h:214
Array< Real > RealArray
Tableau dynamique à une dimension de réels.
Definition UtilsTypes.h:222
std::int32_t Int32
Type entier signé sur 32 bits.
ConstArrayView< Real > RealConstArrayView
Equivalent C d'un tableau à une dimension de réels.
Definition UtilsTypes.h:575