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

Liste de paramètres. Plus de détails...

#include <arcane/utils/ParameterList.h>

Classes
class	Impl

Fonctions membres publiques
	ParameterList ()
	Implémentation.
	ParameterList (const ParameterList &rhs)
	Construit un dictionnaire.
	~ParameterList ()
	Libère les ressources.
String	getParameterOrNull (const String &param_name) const
	Récupère le paramètre de nom param_name.
bool	addParameterLine (const String &line)
	Analyse la ligne line.
void	fillParameters (StringList &param_names, StringList &values) const
	Récupère la liste des paramètres et leur valeur.
ParameterCaseOption	getParameterCaseOption (const String &language) const
	Méthode permettant de récupérer un objet de type ParameterCaseOption.

Description détaillée

Liste de paramètres.

Une liste de paramètres est similaire à un ensemble (clé,valeur) mais une clé peut-être éventuellement présente plusieurs fois (un peu à la manière de la classe std::multi_map).

Définition à la ligne 35 du fichier ParameterList.h.

Documentation des constructeurs et destructeur

ParameterList() [1/2]

Arcane::ParameterList::ParameterList

(

)

Implémentation.

Construit un dictionnaire

Définition à la ligne 153 du fichier ParameterList.cc.

Référencé par ParameterList().

ParameterList() [2/2]

Arcane::ParameterList::ParameterList

(

const ParameterList &

rhs

)

Construit un dictionnaire.

Définition à la ligne 162 du fichier ParameterList.cc.

Références ParameterList().

~ParameterList()

Arcane::ParameterList::~ParameterList

(

)

Libère les ressources.

Définition à la ligne 171 du fichier ParameterList.cc.

Documentation des fonctions membres

addParameterLine()

bool Arcane::ParameterList::addParameterLine

(

const String &

line

)

Analyse la ligne line.

La ligne doit avoir une des formes suivantes, avec A le paramètre et B la valeur:

1. A=B,
2. A:=B
3. A+=B,
4. A-=B

Dans le cas (1) ou (3), la valeur de l'argument est ajoutée aux occurences déjà présentes. Dans le cas (2), la valeur de l'argument remplace toutes les occurences déjà présentes. Dans le cas (4), l'occurence ayant la valeur B est supprimée si elle était présente et rien ne se produit si elle était absente.

Valeurs retournées

false	si un paramètre a pu être analysé
true	sinon.

Définition à la ligne 189 du fichier ParameterList.cc.

Références Arcane::String::bytes(), Arcane::SpanImpl< T, SizeType, Extent, MinValue >::length(), et Arcane::String::substring().

fillParameters()

void Arcane::ParameterList::fillParameters	(	StringList &	param_names,
		StringList &	values ) const

Récupère la liste des paramètres et leur valeur.

Retourne dans param_names la liste des noms des paramêtres et dans values la valeur associée.

Définition à la ligne 220 du fichier ParameterList.cc.

getParameterCaseOption()

ParameterCaseOption Arcane::ParameterList::getParameterCaseOption

(

const String &

language

)

const

Méthode permettant de récupérer un objet de type ParameterCaseOption.

Cet objet peut être détruit après utilisation.

Paramètres

language

Le langage dans lequel est écrit le jeu de données.

Renvoie

Un objet de type ParameterCaseOption.

Définition à la ligne 229 du fichier ParameterList.cc.

Référencé par Arcane::CaseOptionMultiExtended::_search(), et Arcane::CaseOptionMultiSimpleT< T >::_search().

getParameterOrNull()

String Arcane::ParameterList::getParameterOrNull

(

const String &

param_name

)

const

Récupère le paramètre de nom param_name.

Retourne une chaîne nulle s'il n'y aucun paramètre avec ce nom.

Si le paramètre est présent plusieurs fois, seule la dernière valeur est retournée.

Définition à la ligne 180 du fichier ParameterList.cc.

---

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

• ParameterList.h
• ParameterList.cc