Référence de la classe Arcane::Properties

Liste de propriétés. Plus de détails...

#include <arcane/core/Properties.h>

Graphe de collaboration de Arcane::Properties:

Fonctions membres publiques
	Properties (IPropertyMng *pm, const String &name)
	Créé ou récupère une liste de propriétés de nom name.
	Properties (const Properties &parent_property, const String &name)
	Créé ou récupère une liste de propriétés de nom name et fille de parent_property.
	Properties (const Properties &rhs)
	Constructeur par recopie.
const Properties &	operator= (const Properties &rhs)
	Opérateur de recopie.
virtual	~Properties ()
	Détruit la référence à cette propriété
void	setBool (const String &name, bool value)
	Positionne une propriété de type bool de nom name et de valeur value.
void	set (const String &name, bool value)
	Positionne une propriété de type bool de nom name et de valeur value.
bool	getBool (const String &name) const
	Valeur de la propriété de nom name.
bool	getBoolWithDefault (const String &name, bool default_value) 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.
void	setInt32 (const String &name, Int32 value)
	Positionne une propriété de type Int32 de nom name et de valeur value.
void	set (const String &name, Int32 value)
	Positionne une propriété de type Int32 de nom name et de valeur value.
Int32	getInt32 (const String &name) const
	Valeur de la propriété de nom name.
Int32	getInt32WithDefault (const String &name, Int32 default_value) const
	Valeur de la propriété de nom name.
bool	get (const String &name, Int32 &value) const
	Valeur de la propriété de nom name.
void	setInt64 (const String &name, Int64 value)
	Positionne une propriété de type Int64 de nom name et de valeur value.
void	set (const String &name, Int64 value)
	Positionne une propriété de type Int64 de nom name et de valeur value.
Int64	getInt64 (const String &name) const
	Valeur de la propriété de nom name.
Int64	getInt64WithDefault (const String &name, Int64 default_value) const
	Valeur de la propriété de nom name.
bool	get (const String &name, Int64 &value) 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.
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.
void	setReal (const String &name, Real value)
	Positionne une propriété de type Real de nom name et de valeur value.
void	set (const String &name, Real value)
	Positionne une propriété de type Real de nom name et de valeur value.
Real	getReal (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.
bool	get (const String &name, Real &value) const
	Valeur de la propriété de nom name.
void	setString (const String &name, const String &value)
	Positionne une propriété de type String de nom name et de valeur value.
void	set (const String &name, const String &value)
	Positionne une propriété de type String de nom name et de valeur value.
String	getString (const String &name) const
	Valeur de la propriété de nom name.
String	getStringWithDefault (const String &name, const String &default_value) const
	Valeur de la propriété de nom name.
bool	get (const String &name, String &value) const
	Valeur de la propriété de nom name.
void	set (const String &name, BoolConstArrayView value)
	Positionne une propriété de type BoolUniqueArray de nom name et de valeur value.
void	get (const String &name, BoolArray &value) const
	Valeur de la propriété de nom name.
void	set (const String &name, Int32ConstArrayView value)
	Positionne une propriété de type Int32UniqueArray de nom name et de valeur value.
void	get (const String &name, Int32Array &value) const
	Valeur de la propriété de nom name.
void	set (const String &name, Int64ConstArrayView value)
	Positionne une propriété de type Int64UniqueArray de nom name et de valeur value.
void	get (const String &name, Int64Array &value) const
	Valeur de la propriété de nom name.
void	set (const String &name, RealConstArrayView value)
	Positionne une propriété de type RealUniqueArray de nom name et de valeur value.
void	get (const String &name, RealArray &value) const
	Valeur de la propriété de nom name.
void	set (const String &name, StringConstArrayView value)
	Positionne une propriété de type StringUniqueArray de nom name et de valeur value.
void	get (const String &name, StringArray &value) const
	Valeur de la propriété de nom name.
void	print (std::ostream &o) const
	Sort les propriétés et leurs valeurs sur le flot o.
void	serialize (ISerializer *serializer)
	Effectue la sérialisation des propriétés.
const String &	name () const
	Nom de la propriété.
const String &	fullName () const
	Nom complet de la propriété.
IPropertyMng *	propertyMng () const
void	destroy ()
	Supprime les valeurs associées des propriétés associées à cette référence.
PropertiesImpl *	impl () const
PropertiesImplBase *	baseImpl () const

Description détaillée

Liste de propriétés.

Cette classe gère une liste de propriétés. Une propriété est caractérisée par un nom et une valeur d'un type donnée. Le nom ne doit pas contenir le caractère '.' qui sert de délimiteur pour les hiérarchies de propriétés.

Les fonctions set*() permettent de positionner une propriété. Les fonctions get*() permettent de récupérer la valeur.

Pour les propriétés scalaires, il existe trois manière de récupérer une valeur. Ces trois méthodes sont équivalentes sauf si la propriété n'a pas été positionnée.

• via une surcharge de la méthode get(). Dans le cas où la propriété n'est pas positionnée, la valeur passée en argument est inchangée et la méthode retourne false.
• via un appel explicite (par exemple getBool()). Dans le cas où la propriété n'est pas positionnée, c'est la valeur obtenue avec le constructeur par défaut pour le type concerné qui est utilisée.
• via un appel explicite avec valeur par défaut possible (par exemple getBoolWithDefault()). Dans le cas où la propriété n'est pas positionnée, c'est la valeur par défaut passée en argument qui est utilisée.

Définition à la ligne 63 du fichier Properties.h.

Documentation des constructeurs et destructeur

Properties() [1/3]

Arcane::Properties::Properties	(	IPropertyMng *	pm,
		const String &	name
	)

Créé ou récupère une liste de propriétés de nom name.

Définition à la ligne 709 du fichier Properties.cc.

Properties() [2/3]

Arcane::Properties::Properties	(	const Properties &	parent_property,
		const String &	name
	)

Créé ou récupère une liste de propriétés de nom name et fille de parent_property.

Définition à la ligne 729 du fichier Properties.cc.

Références fullName().

Properties() [3/3]

Arcane::Properties::Properties

(

const Properties &

rhs

)

Constructeur par recopie.

Définition à la ligne 768 du fichier Properties.cc.

~Properties()

Arcane::Properties::~Properties ( )

virtual

Détruit la référence à cette propriété

Définition à la ligne 760 du fichier Properties.cc.

Documentation des fonctions membres

baseImpl()

PropertiesImplBase * Arcane::Properties::baseImpl ( ) const

inline

Définition à la ligne 221 du fichier Properties.h.

destroy()

void Arcane::Properties::destroy

(

)

Supprime les valeurs associées des propriétés associées à cette référence.

Définition à la ligne 1083 du fichier Properties.cc.

Références Arcane::IPropertyMng::destroyProperties().

fullName()

const String & Arcane::Properties::fullName

(

)

const

Nom complet de la propriété.

Définition à la ligne 1065 du fichier Properties.cc.

Référencé par Properties().

get() [1/10]

bool Arcane::Properties::get	(	const String &	name,
		bool &	value
	)		const

Valeur de la propriété de nom name.

Définition à la ligne 813 du fichier Properties.cc.

Référencé par getBoolWithDefault(), et Arcane::Parallel::Stat::mergeValues().

get() [2/10]

void Arcane::Properties::get	(	const String &	name,
		BoolArray &	value
	)		const

Valeur de la propriété de nom name.

Définition à la ligne 973 du fichier Properties.cc.

get() [3/10]

bool Arcane::Properties::get	(	const String &	name,
		Int32 &	value
	)		const

Valeur de la propriété de nom name.

Définition à la ligne 844 du fichier Properties.cc.

Références name().

get() [4/10]

void Arcane::Properties::get	(	const String &	name,
		Int32Array &	value
	)		const

Valeur de la propriété de nom name.

Définition à la ligne 987 du fichier Properties.cc.

get() [5/10]

bool Arcane::Properties::get	(	const String &	name,
		Int64 &	value
	)		const

Valeur de la propriété de nom name.

Définition à la ligne 876 du fichier Properties.cc.

get() [6/10]

void Arcane::Properties::get	(	const String &	name,
		Int64Array &	value
	)		const

Valeur de la propriété de nom name.

Définition à la ligne 1001 du fichier Properties.cc.

get() [7/10]

bool Arcane::Properties::get	(	const String &	name,
		Real &	value
	)		const

Valeur de la propriété de nom name.

Définition à la ligne 928 du fichier Properties.cc.

get() [8/10]

void Arcane::Properties::get	(	const String &	name,
		RealArray &	value
	)		const

Valeur de la propriété de nom name.

Définition à la ligne 1015 du fichier Properties.cc.

get() [9/10]

bool Arcane::Properties::get	(	const String &	name,
		String &	value
	)		const

Valeur de la propriété de nom name.

Définition à la ligne 959 du fichier Properties.cc.

get() [10/10]

void Arcane::Properties::get	(	const String &	name,
		StringArray &	value
	)		const

Valeur de la propriété de nom name.

Définition à la ligne 1029 du fichier Properties.cc.

getBool()

bool Arcane::Properties::getBool

(

const String &

name

)

const

Valeur de la propriété de nom name.

Définition à la ligne 808 du fichier Properties.cc.

Références getBoolWithDefault().

getBoolWithDefault()

bool Arcane::Properties::getBoolWithDefault	(	const String &	name,
		bool	default_value
	)		const

Valeur de la propriété de nom name.

Définition à la ligne 801 du fichier Properties.cc.

Références get().

Référencé par Arcane::ItemItemGroupComputeFunctor< ItemType >::executeFunctor(), et getBool().

getInt32()

Int32 Arcane::Properties::getInt32

(

const String &

name

)

const

Valeur de la propriété de nom name.

Définition à la ligne 839 du fichier Properties.cc.

Références getInt32WithDefault(), et name().

getInt32WithDefault()

Int32 Arcane::Properties::getInt32WithDefault	(	const String &	name,
		Int32	default_value
	)		const

Valeur de la propriété de nom name.

Définition à la ligne 832 du fichier Properties.cc.

Références name().

Référencé par getInt32(), et Arcane::Parallel::Stat::mergeValues().

getInt64()

Int64 Arcane::Properties::getInt64

(

const String &

name

)

const

Valeur de la propriété de nom name.

Définition à la ligne 871 du fichier Properties.cc.

Références getInt64WithDefault().

getInt64WithDefault()

Int64 Arcane::Properties::getInt64WithDefault	(	const String &	name,
		Int64	default_value
	)		const

Valeur de la propriété de nom name.

Définition à la ligne 864 du fichier Properties.cc.

Référencé par getInt64().

getInteger()

Integer Arcane::Properties::getInteger

(

const String &

name

)

const

Valeur de la propriété de nom name.

Définition à la ligne 897 du fichier Properties.cc.

Références getIntegerWithDefault(), et name().

getIntegerWithDefault()

Integer Arcane::Properties::getIntegerWithDefault	(	const String &	name,
		Integer	default_value
	)		const

Valeur de la propriété de nom name.

Définition à la ligne 890 du fichier Properties.cc.

Référencé par getInteger().

getReal()

Real Arcane::Properties::getReal

(

const String &

name

)

const

Valeur de la propriété de nom name.

Définition à la ligne 923 du fichier Properties.cc.

Références getRealWithDefault().

getRealWithDefault()

Real Arcane::Properties::getRealWithDefault	(	const String &	name,
		Real	default_value
	)		const

Valeur de la propriété de nom name.

Définition à la ligne 916 du fichier Properties.cc.

Référencé par getReal().

getString()

String Arcane::Properties::getString

(

const String &

name

)

const

Valeur de la propriété de nom name.

Définition à la ligne 954 du fichier Properties.cc.

Références getStringWithDefault().

getStringWithDefault()

String Arcane::Properties::getStringWithDefault	(	const String &	name,
		const String &	default_value
	)		const

Valeur de la propriété de nom name.

Définition à la ligne 947 du fichier Properties.cc.

Référencé par getString().

impl()

PropertiesImpl * Arcane::Properties::impl ( ) const

inline

Définition à la ligne 218 du fichier Properties.h.

name()

const String & Arcane::Properties::name

(

)

const

Nom de la propriété.

Définition à la ligne 1056 du fichier Properties.cc.

Référencé par get(), getInt32(), getInt32WithDefault(), et getInteger().

operator=()

const Properties & Arcane::Properties::operator=

(

const Properties &

rhs

)

Opérateur de recopie.

Définition à la ligne 778 du fichier Properties.cc.

print()

void Arcane::Properties::print

(

std::ostream &

o

)

const

Sort les propriétés et leurs valeurs sur le flot o.

Définition à la ligne 1038 du fichier Properties.cc.

propertyMng()

IPropertyMng * Arcane::Properties::propertyMng

(

)

const

Définition à la ligne 1074 du fichier Properties.cc.

serialize()

void Arcane::Properties::serialize

(

ISerializer *

serializer

)

Effectue la sérialisation des propriétés.

Définition à la ligne 1047 du fichier Properties.cc.

set() [1/10]

void Arcane::Properties::set	(	const String &	name,
		bool	value
	)

Positionne une propriété de type bool de nom name et de valeur value.

Définition à la ligne 796 du fichier Properties.cc.

Références setBool().

Référencé par Arcane::Parallel::Stat::saveValues(), et setInteger().

set() [2/10]

void Arcane::Properties::set	(	const String &	name,
		BoolConstArrayView	value
	)

Positionne une propriété de type BoolUniqueArray de nom name et de valeur value.

Définition à la ligne 968 du fichier Properties.cc.

set() [3/10]

void Arcane::Properties::set	(	const String &	name,
		const String &	value
	)

Positionne une propriété de type String de nom name et de valeur value.

Définition à la ligne 942 du fichier Properties.cc.

Références setString().

set() [4/10]

void Arcane::Properties::set	(	const String &	name,
		Int32	value
	)

Positionne une propriété de type Int32 de nom name et de valeur value.

Définition à la ligne 827 du fichier Properties.cc.

Références setInt32().

set() [5/10]

void Arcane::Properties::set	(	const String &	name,
		Int32ConstArrayView	value
	)

Positionne une propriété de type Int32UniqueArray de nom name et de valeur value.

Définition à la ligne 982 du fichier Properties.cc.

set() [6/10]

void Arcane::Properties::set	(	const String &	name,
		Int64	value
	)

Positionne une propriété de type Int64 de nom name et de valeur value.

Définition à la ligne 859 du fichier Properties.cc.

Références setInt64().

set() [7/10]

void Arcane::Properties::set	(	const String &	name,
		Int64ConstArrayView	value
	)

Positionne une propriété de type Int64UniqueArray de nom name et de valeur value.

Définition à la ligne 996 du fichier Properties.cc.

set() [8/10]

void Arcane::Properties::set	(	const String &	name,
		Real	value
	)

Positionne une propriété de type Real de nom name et de valeur value.

Définition à la ligne 911 du fichier Properties.cc.

Références setReal().

set() [9/10]

void Arcane::Properties::set	(	const String &	name,
		RealConstArrayView	value
	)

Positionne une propriété de type RealUniqueArray de nom name et de valeur value.

Définition à la ligne 1010 du fichier Properties.cc.

set() [10/10]

void Arcane::Properties::set	(	const String &	name,
		StringConstArrayView	value
	)

Positionne une propriété de type StringUniqueArray de nom name et de valeur value.

Définition à la ligne 1024 du fichier Properties.cc.

setBool()

void Arcane::Properties::setBool	(	const String &	name,
		bool	value
	)

Positionne une propriété de type bool de nom name et de valeur value.

Définition à la ligne 791 du fichier Properties.cc.

Référencé par Arcane::MeshReaderMng::readMesh(), et set().

setInt32()

void Arcane::Properties::setInt32	(	const String &	name,
		Int32	value
	)

Positionne une propriété de type Int32 de nom name et de valeur value.

Définition à la ligne 822 du fichier Properties.cc.

Référencé par set().

setInt64()

void Arcane::Properties::setInt64	(	const String &	name,
		Int64	value
	)

Positionne une propriété de type Int64 de nom name et de valeur value.

Définition à la ligne 854 du fichier Properties.cc.

Référencé par set().

setInteger()

void Arcane::Properties::setInteger	(	const String &	name,
		Integer	value
	)

Positionne une propriété de type Integer de nom name et de valeur value.

Définition à la ligne 885 du fichier Properties.cc.

Références set().

setReal()

void Arcane::Properties::setReal	(	const String &	name,
		Real	value
	)

Positionne une propriété de type Real de nom name et de valeur value.

Définition à la ligne 906 du fichier Properties.cc.

Référencé par set().

setString()

void Arcane::Properties::setString	(	const String &	name,
		const String &	value
	)

Positionne une propriété de type String de nom name et de valeur value.

Définition à la ligne 937 du fichier Properties.cc.

Référencé par set().

---

La documentation de cette classe a été générée à partir des fichiers suivants :

• Properties.h
• Properties.cc