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

Classe représentant un ensemble d'éléments XML (un ensemble d'options Arcane). Plus de détails...

#include <arcane/utils/internal/ParameterOption.h>

Graphe de collaboration de Arcane::ParameterOptionElementsCollection:

Fonctions membres publiques
void	addParameter (const String &parameter, const String &value)
	Méthode permettant d'ajouter un paramètre d'option dans la liste des paramètres d'options.
void	addElement (StringView addr, StringView value)
std::optional< StringView >	value (const ParameterOptionAddr &addr)
bool	isExistAddr (const ParameterOptionAddr &addr)
	Méthode permettant de savoir si une adresse est présente dans la liste d'éléments. Les ANY_TAG/ANY_INDEX sont pris en compte.
Integer	countAddr (const ParameterOptionAddr &addr)
	Méthode permettant de savoir combien de fois une adresse est présente dans la liste d'élements. Méthode particulièrement utile avec les ANY_TAG/ANY_INDEX.
void	getIndexInAddr (const ParameterOptionAddr &addr_with_get_index, UniqueArray< Integer > &indexes)
	Méthode permettant de récupérer un ou plusieurs indices dans la liste d'adresses.

Attributs privés
UniqueArray< ParameterOptionElement >	m_elements

Description détaillée

Classe représentant un ensemble d'éléments XML (un ensemble d'options Arcane).

Définition à la ligne 254 du fichier ParameterOption.h.

Documentation des fonctions membres

addElement()

void Arcane::ParameterOptionElementsCollection::addElement	(	StringView	addr,
		StringView	value )

Définition à la ligne 425 du fichier ParameterOption.cc.

addParameter()

void Arcane::ParameterOptionElementsCollection::addParameter	(	const String &	parameter,
		const String &	value )

Méthode permettant d'ajouter un paramètre d'option dans la liste des paramètres d'options.

Avertissement

Les deux paramètres ne sont pas copiés ! On ne récupère qu'une vue. L'utilisateur de cette classe doit gérer la durée de vie de ces objets.

Paramètres

parameter	Le paramètre d'option brut (avec les "//" au début).
value	La valeur de l'option.

Définition à la ligne 414 du fichier ParameterOption.cc.

Références Arcane::String::startsWith(), Arcane::StringView::subView(), et Arcane::String::view().

Voici le graphe d'appel pour cette fonction :

countAddr()

Integer Arcane::ParameterOptionElementsCollection::countAddr

(

const ParameterOptionAddr &

addr

)

Méthode permettant de savoir combien de fois une adresse est présente dans la liste d'élements. Méthode particulièrement utile avec les ANY_TAG/ANY_INDEX.

Paramètres

addr	L'adresse à rechercher.

Renvoie

Le nombre de correspondances trouvé.

Définition à la ligne 463 du fichier ParameterOption.cc.

getIndexInAddr()

void Arcane::ParameterOptionElementsCollection::getIndexInAddr	(	const ParameterOptionAddr &	addr_with_get_index,
		UniqueArray< Integer > &	indexes )

Méthode permettant de récupérer un ou plusieurs indices dans la liste d'adresses.

Le fonctionnement de cette méthode est simple. Nous avons les adresses suivantes : "aaa[1]/bbb[2]/ccc[1]/\@name[1]". "aaa[1]/bbb[2]/ccc[2]/\@name[1]". "ddd[1]/eee[2]". "fff[1]/ggg[2]/hhh[4]". L'adresse en paramètre est la suivante : "aaa[1]/bbb[2]/ccc[GET_INDEX]/\@name[1]". Les indices ajoutés dans le tableau en paramètre seront 1 et 2.

Attention : Avoir une adresse en entrée avec plusieurs "GET_INDEX" est autorisé mais ça peut être dangereux si le nombre d'indices trouvé par adresse est différent pour chaque adresse (s'il y a deux "GET_INDEX" mais que dans une des adresses, il n'y a pas deux correspondances, ces éventuelles correspondances ne seront pas prises en compte).

Paramètres

addr_with_get_index	L'adresse contenant des indices "GET_INDEX".
indexes	[OUT] Le tableau dans lequel sera ajouté le ou les indices (le tableau n'est pas effacé avant utilisation).

Définition à la ligne 477 du fichier ParameterOption.cc.

Références Arcane::Array< DataType >::addRange(), et Arcane::ParameterOptionAddr::nbIndexToGetInAddr().

Voici le graphe d'appel pour cette fonction :

isExistAddr()

bool Arcane::ParameterOptionElementsCollection::isExistAddr

(

const ParameterOptionAddr &

addr

)

Méthode permettant de savoir si une adresse est présente dans la liste d'éléments. Les ANY_TAG/ANY_INDEX sont pris en compte.

Paramètres

addr	L'adresse à rechercher.

Renvoie

true si l'adresse est trouvé.

Définition à la ligne 450 du fichier ParameterOption.cc.

value()

std::optional< StringView > Arcane::ParameterOptionElementsCollection::value

(

const ParameterOptionAddr &

addr

)

Définition à la ligne 437 du fichier ParameterOption.cc.

Documentation des données membres

m_elements

UniqueArray<ParameterOptionElement> Arcane::ParameterOptionElementsCollection::m_elements

private

Définition à la ligne 325 du fichier ParameterOption.h.

---

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

• ParameterOption.h
• ParameterOption.cc