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

Dictionnaire de chaînes unicode. Plus de détails...

#include <arcane/utils/StringDictionary.h>

Graphe de collaboration de Arcane::StringDictionary:

Classes
class	Impl
	Implémentation du dictionnaire de chaîne unicode. Plus de détails...

Fonctions membres publiques
	StringDictionary ()
	Implémentation.
	StringDictionary (const StringDictionary &rhs)
	Construit un dictionnaire.
	~StringDictionary ()
	Libère les ressources.
void	add (const String &key, const String &value)
	Ajoute le couple (key,value) au dictionnaire.
String	remove (const String &key)
	Supprime la valeur associée à key.
String	find (const String &key, bool throw_exception=false) const
	Retourne la valeur associée à key.
void	fill (StringList &param_names, StringList &values) const
	Remplit keys et values avec les valeurs correspondantes du dictionnaire.
	StringDictionary ()
	Implémentation.
	StringDictionary (const StringDictionary &rhs)
	Construit un dictionnaire.
	~StringDictionary ()
	Libère les ressources.
void	add (const String &key, const String &value)
	Ajoute le couple (key,value) au dictionnaire.
String	remove (const String &key)
	Supprime la valeur associée à key.
String	find (const String &key, bool throw_exception=false) const
	Retourne la valeur associée à key.
void	fill (StringList &param_names, StringList &values) const
	Remplit keys et values avec les valeurs correspondantes du dictionnaire.

Attributs privés
Impl *	m_p
	Implémentation.

Description détaillée

Dictionnaire de chaînes unicode.

Maintient une liste des couples (clé,valeur) permettant d'associer une chaîne de caractère à une autre. Ce type de dictionnaire est utilisé par exemple pour les traductions, auquel cas la clé est le langage et la valeur la traduction correspondante.

Définition à la ligne 36 du fichier arcane/src/arcane/utils/StringDictionary.h.

Documentation des constructeurs et destructeur

StringDictionary() [1/3]

Arcane::StringDictionary::StringDictionary

(

)

Implémentation.

Construit un dictionnaire

Définition à la ligne 62 du fichier StringDictionary.cc.

Références m_p.

Référencé par StringDictionary().

Voici le graphe des appelants de cette fonction :

StringDictionary() [2/3]

Arcane::StringDictionary::StringDictionary

(

const StringDictionary &

rhs

)

Construit un dictionnaire.

Définition à la ligne 71 du fichier StringDictionary.cc.

Références m_p, et StringDictionary().

Voici le graphe d'appel pour cette fonction :

~StringDictionary()

Arcane::StringDictionary::~StringDictionary

(

)

Libère les ressources.

Définition à la ligne 80 du fichier StringDictionary.cc.

Références m_p.

StringDictionary() [3/3]

Arcane::StringDictionary::StringDictionary

(

)

Implémentation.

Construit un dictionnaire

Documentation des fonctions membres

add() [1/2]

void Arcane::StringDictionary::add	(	const String &	key,
		const String &	value )

Ajoute le couple (key,value) au dictionnaire.

Si une valeur existe déjà pour key, elle est remplacée par la nouvelle.

Définition à la ligne 89 du fichier StringDictionary.cc.

Références m_p.

add() [2/2]

void Arcane::StringDictionary::add	(	const String &	key,
		const String &	value )

Ajoute le couple (key,value) au dictionnaire.

Si une valeur existe déjà pour key, elle est remplacée par la nouvelle.

fill()

void Arcane::StringDictionary::fill	(	StringList &	param_names,
		StringList &	values ) const

Remplit keys et values avec les valeurs correspondantes du dictionnaire.

Définition à la ligne 128 du fichier StringDictionary.cc.

Références Arcane::CollectionBase::clear(), et m_p.

Voici le graphe d'appel pour cette fonction :

find() [1/2]

String Arcane::StringDictionary::find	(	const String &	key,
		bool	throw_exception = false ) const

Retourne la valeur associée à key.

Si aucune valeur n'est associée à key, la chaîne nulle est retournée. Il n'est pas possible de faire la différence entre une valeur correspondant à la chaîne nulle et une valeur non trouvée sauf si throw_exception est vrai, auquel cas une exception est renvoyée s'il n'existe pas de valeur correspondant à key.

Définition à la ligne 113 du fichier StringDictionary.cc.

Références m_p.

find() [2/2]

String Arcane::StringDictionary::find	(	const String &	key,
		bool	throw_exception = false ) const

Retourne la valeur associée à key.

Si aucune valeur n'est associée à key, la chaîne nulle est retournée. Il n'est pas possible de faire la différence entre une valeur correspondant à la chaîne nulle et une valeur non trouvée sauf si throw_exception est vrai, auquel cas une exception est renvoyée s'il n'existe pas de valeur correspondant à key.

remove() [1/2]

String Arcane::StringDictionary::remove

(

const String &

key

)

Supprime la valeur associée à key.

Si aucune valeur n'était associée à key, rien ne se passe.

Renvoie

la valeur supprimée s'il y en a une.

Définition à la ligne 98 du fichier StringDictionary.cc.

Références m_p.

remove() [2/2]

String Arcane::StringDictionary::remove

(

const String &

key

)

Supprime la valeur associée à key.

Si aucune valeur n'était associée à key, rien ne se passe.

Renvoie

la valeur supprimée s'il y en a une.

Documentation des données membres

m_p

Impl * Arcane::StringDictionary::m_p

private

Implémentation.

Définition à la ligne 77 du fichier arcane/src/arcane/utils/StringDictionary.h.

Référencé par add(), fill(), find(), remove(), StringDictionary(), StringDictionary(), et ~StringDictionary().

---

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

• arcane/src/arcane/utils/StringDictionary.h
• arccore/src/common/arccore/common/StringDictionary.h
• StringDictionary.cc