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

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

#include </__w/arcaneframework.github.io/arcaneframework.github.io/framework/arccore/src/common/arccore/common/ParameterList.h>

Graphe de collaboration de Arcane::ParameterList:

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.

Attributs privés
Impl *	m_p = nullptr
	Implémentation.

Amis
class	ParameterListWithCaseOption

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 arccore/src/common/arccore/common/ParameterList.h.

Documentation des constructeurs et destructeur

ParameterList() [1/2]

Arcane::ParameterList::ParameterList

(

)

Implémentation.

Construit un dictionnaire

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

Références m_p.

Référencé par ParameterList().

Voici le graphe des appelants de cette fonction :

ParameterList() [2/2]

Arcane::ParameterList::ParameterList

(

const ParameterList &

rhs

)

Construit un dictionnaire.

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

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

Voici le graphe d'appel pour cette fonction :

~ParameterList()

Arcane::ParameterList::~ParameterList

(

)

Libère les ressources.

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

Références m_p.

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 165 du fichier ParameterList.cc.

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

Voici le graphe d'appel pour cette fonction :

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 196 du fichier ParameterList.cc.

Références m_p.

Référencé par Arcane::ParameterListWithCaseOption::addParameters().

Voici le graphe des appelants de cette fonction :

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 156 du fichier ParameterList.cc.

Références m_p.

Documentation des fonctions amies et associées

ParameterListWithCaseOption

friend class ParameterListWithCaseOption

friend

Définition à la ligne 39 du fichier arccore/src/common/arccore/common/ParameterList.h.

Documentation des données membres

m_p

Impl* Arcane::ParameterList::m_p = nullptr

private

Implémentation.

Définition à la ligne 94 du fichier arccore/src/common/arccore/common/ParameterList.h.

Référencé par addParameterLine(), fillParameters(), getParameterOrNull(), ParameterList(), ParameterList(), et ~ParameterList().

---

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

• arccore/src/common/arccore/common/ParameterList.h
• ParameterList.cc