Classe représentant l'ensemble des paramètres pouvant modifier les options du jeu de données. Plus de détails...

#include <arcane/utils/ParameterCaseOption.h>

Graphe de collaboration de Arcane::ParameterCaseOption:

Fonctions membres publiques
	ParameterCaseOption (ParameterOptionElementsCollection *parameter_options, const String &lang)

String	getParameterOrNull (const String &xpath_before_index, const String &xpath_after_index, Integer index) const
	Méthode permettant de récupérer la valeur d'une option.

String	getParameterOrNull (const String &xpath_before_index, Integer index, bool allow_elems_after_index) const
	Méthode permettant de récupérer la valeur d'une option.

String	getParameterOrNull (const String &full_xpath) const
	Méthode permettant de récupérer la valeur d'une option.

bool	exist (const String &full_xpath) const
	Méthode permettant de savoir si une option est présente.

bool	existAnyIndex (const String &xpath_before_index, const String &xpath_after_index) const
	Méthode permettant de savoir si une option est présente.

bool	existAnyIndex (const String &full_xpath) const
	Méthode permettant de savoir si une option est présente.

void	indexesInParam (const String &xpath_before_index, const String &xpath_after_index, UniqueArray< Integer > &indexes) const
	Méthode permettant de récupérer le ou les indices de l'option.

void	indexesInParam (const String &xpath_before_index, UniqueArray< Integer > &indexes, bool allow_elems_after_index) const
	Méthode permettant de récupérer le ou les indices de l'option.

Integer	count (const String &xpath_before_index, const String &xpath_after_index) const
	Méthode permettant de connaitre le nombre d'indices de l'option.

Integer	count (const String &xpath_before_index) const
	Méthode permettant de connaitre le nombre d'indices de l'option.

Fonctions membres privées
StringView	_removeUselessPartInXpath (StringView xpath) const

Attributs privés
bool	m_is_fr

ParameterOptionElementsCollection *	m_lines

Description détaillée

Classe représentant l'ensemble des paramètres pouvant modifier les options du jeu de données.

Définition à la ligne 40 du fichier ParameterCaseOption.h.

Documentation des constructeurs et destructeur

◆ ParameterCaseOption()

Arcane::ParameterCaseOption::ParameterCaseOption	(	ParameterOptionElementsCollection *	parameter_options,
		const String &	lang )

Définition à la ligne 35 du fichier ParameterCaseOption.cc.

Documentation des fonctions membres

◆ _removeUselessPartInXpath()

StringView Arcane::ParameterCaseOption::_removeUselessPartInXpath ( StringView xpath ) const

inlineprivate

Définition à la ligne 191 du fichier ParameterCaseOption.cc.

◆ count() [1/2]

Integer Arcane::ParameterCaseOption::count ( const String & xpath_before_index ) const

Méthode permettant de connaitre le nombre d'indices de l'option.

L'adresse de l'option est reformée comme ceci : xpath_before_index[GET_INDEX]

xpath_before_index doit être de la forme suivante : //case/aaa/bbb[2]/ccc

le "//case/" au début (ou "//cas/" en français"), - une succession de tags avec possiblement leurs indices, - pas de "/" à la fin,
un indice peut être mise à la fin (mais il sera remplacé par GET_INDEX).

Les indices sont des indices XML et ces indices commencent par 1. L'indice GET_INDEX est un indice spécial désignant les indices que l'on souhaite récupérer.

Paramètres

xpath_before_index L'adresse avant indice.

Renvoie: Le nombre d'indices de l'option.

Définition à la ligne 176 du fichier ParameterCaseOption.cc.

Références Arcane::String::view().

Voici le graphe d'appel pour cette fonction :

◆ count() [2/2]

Integer Arcane::ParameterCaseOption::count	(	const String &	xpath_before_index,
		const String &	xpath_after_index ) const

Méthode permettant de connaitre le nombre d'indices de l'option.

L'adresse de l'option est reformée comme ceci : xpath_before_index[GET_INDEX]/xpath_after_index

xpath_before_index doit être de la forme suivante : //case/aaa/bbb[2]/ccc

le "//case/" au début (ou "//cas/" en français"), - une succession de tags avec possiblement leurs indices, - pas de "/" à la fin, - un indice peut être mise à la fin (mais il sera remplacé par GET_INDEX). xpath_after_index doit être de la forme suivante : ddd/eee - pas de "/" au début ni à la fin.

Les indices sont des indices XML et ces indices commencent par 1. L'indice GET_INDEX est un indice spécial désignant les indices que l'on souhaite récupérer.

Paramètres

xpath_before_index	L'adresse avant indice.
xpath_after_index	L'adresse après indice.

Renvoie: Le nombre d'indices de l'option.

Définition à la ligne 163 du fichier ParameterCaseOption.cc.

Références Arcane::String::view().

Voici le graphe d'appel pour cette fonction :

◆ exist()

bool Arcane::ParameterCaseOption::exist ( const String & full_xpath ) const

Méthode permettant de savoir si une option est présente.

L'adresse doit être de la forme suivante : //case/aaa/bbb[2]/ccc

le "//case/" au début (ou "//cas/" en français"), - une succession de tags avec possiblement leurs indices, - pas de "/" à la fin,
un indice peut être mise à la fin.

Les indices sont des indices XML et ces indices commencent par 1.

Paramètres

full_xpath L'adresse à rechercher.

Renvoie: true si l'adresse est trouvée dans la liste.

Définition à la ligne 99 du fichier ParameterCaseOption.cc.

Références Arcane::String::view().

Voici le graphe d'appel pour cette fonction :

◆ existAnyIndex() [1/2]

bool Arcane::ParameterCaseOption::existAnyIndex ( const String & full_xpath ) const

Méthode permettant de savoir si une option est présente.

L'adresse de l'option est reformée comme ceci : full_xpath[ANY_INDEX]

L'adresse doit être de la forme suivante : //case/aaa/bbb[2]/ccc

le "//case/" au début (ou "//cas/" en français"), - une succession de tags avec possiblement leurs indices, - pas de "/" à la fin,
un indice peut être mise à la fin (mais il sera remplacé par ANY_INDEX).

Les indices sont des indices XML et ces indices commencent par 1. L'indice ANY_INDEX est un indice spécial désignant tous les indices.

Paramètres

full_xpath L'adresse à rechercher.

Renvoie: true si l'adresse est trouvée dans la liste.

Définition à la ligne 123 du fichier ParameterCaseOption.cc.

Références Arcane::String::view().

Voici le graphe d'appel pour cette fonction :

◆ existAnyIndex() [2/2]

bool Arcane::ParameterCaseOption::existAnyIndex	(	const String &	xpath_before_index,
		const String &	xpath_after_index ) const

Méthode permettant de savoir si une option est présente.

L'adresse de l'option est reformée comme ceci : xpath_before_index[ANY_INDEX]/xpath_after_index

xpath_before_index doit être de la forme suivante : //case/aaa/bbb[2]/ccc

le "//case/" au début (ou "//cas/" en français"), - une succession de tags avec possiblement leurs indices, - pas de "/" à la fin, - un indice peut être mise à la fin (mais il sera remplacé par ANY_INDEX). xpath_after_index doit être de la forme suivante : ddd/eee - pas de "/" au début ni à la fin.

Les indices sont des indices XML et ces indices commencent par 1. L'indice ANY_INDEX est un indice spécial désignant tous les indices.

Paramètres

xpath_before_index	L'adresse avant indice.
xpath_after_index	L'adresse après indice.

Renvoie: true si l'adresse est trouvée dans la liste.

Définition à la ligne 109 du fichier ParameterCaseOption.cc.

Références Arcane::String::view().

Voici le graphe d'appel pour cette fonction :

◆ getParameterOrNull() [1/3]

String Arcane::ParameterCaseOption::getParameterOrNull ( const String & full_xpath ) const

Méthode permettant de récupérer la valeur d'une option.

L'adresse doit être de la forme suivante : //case/aaa/bbb[2]/ccc

le "//case/" au début (ou "//cas/" en français"), - une succession de tags avec possiblement leurs indices, - pas de "/" à la fin,
un indice peut être mise à la fin.

Les indices sont des indices XML et ces indices commencent par 1.

Paramètres

full_xpath L'adresse à rechercher.

Renvoie: La valeur si trouvée, sinon chaîne null.

Définition à la ligne 85 du fichier ParameterCaseOption.cc.

Références Arcane::String::view().

Voici le graphe d'appel pour cette fonction :

◆ getParameterOrNull() [2/3]

String Arcane::ParameterCaseOption::getParameterOrNull	(	const String &	xpath_before_index,
		const String &	xpath_after_index,
		Integer	index ) const

Méthode permettant de récupérer la valeur d'une option.

L'adresse de l'option est reformée comme ceci : xpath_before_index[index]/xpath_after_index

xpath_before_index doit être de la forme suivante : //case/aaa/bbb[2]/ccc

le "//case/" au début (ou "//cas/" en français"), - une succession de tags avec possiblement leurs indices, - pas de "/" à la fin, - un indice peut être mise à la fin (mais il sera remplacé par celui passé en paramètre). xpath_after_index doit être de la forme suivante : ddd/eee - pas de "/" au début ni à la fin.

Les indices sont des indices XML et ces indices commencent par 1.

Paramètres

xpath_before_index	L'adresse avant indice.
xpath_after_index	L'adresse après indice.
index	L'indice à mettre entre les deux parties de l'adresse.

Renvoie: La valeur si trouvée, sinon chaîne null.

Définition à la ligne 44 du fichier ParameterCaseOption.cc.

Références ARCANE_FATAL, et Arcane::String::view().

Voici le graphe d'appel pour cette fonction :

◆ getParameterOrNull() [3/3]

String Arcane::ParameterCaseOption::getParameterOrNull	(	const String &	xpath_before_index,
		Integer	index,
		bool	allow_elems_after_index ) const

Méthode permettant de récupérer la valeur d'une option.

L'adresse de l'option est reformée comme ceci : xpath_before_index[index]

xpath_before_index doit être de la forme suivante : //case/aaa/bbb[2]/ccc

le "//case/" au début (ou "//cas/" en français"), - une succession de tags avec possiblement leurs indices, - pas de "/" à la fin,
un indice peut être mise à la fin (mais il sera remplacé par celui passé en paramètre).

Si le paramètre allow_elems_after_index est activé, les adresses de la forme : xpath_before_index[index]/aaa/bbb seront aussi recherchées.

Les indices sont des indices XML et ces indices commencent par 1.

Paramètres

xpath_before_index	L'adresse avant indice.
index	L'indice à mettre après l'adresse.
allow_elems_after_index	Doit-on vérifier la présence d'éléments après l'indice ?

Renvoie: La valeur si trouvée, sinon chaîne null.

Définition à la ligne 64 du fichier ParameterCaseOption.cc.

Références ARCANE_FATAL, et Arcane::String::view().

Voici le graphe d'appel pour cette fonction :

◆ indexesInParam() [1/2]

void Arcane::ParameterCaseOption::indexesInParam	(	const String &	xpath_before_index,
		const String &	xpath_after_index,
		UniqueArray< Integer > &	indexes ) const

Méthode permettant de récupérer le ou les indices de l'option.

L'adresse de l'option est reformée comme ceci : xpath_before_index[GET_INDEX]/xpath_after_index

xpath_before_index doit être de la forme suivante : //case/aaa/bbb[2]/ccc

le "//case/" au début (ou "//cas/" en français"), - une succession de tags avec possiblement leurs indices, - pas de "/" à la fin, - un indice peut être mise à la fin (mais il sera remplacé par GET_INDEX). xpath_after_index doit être de la forme suivante : ddd/eee - pas de "/" au début ni à la fin.

Les indices sont des indices XML et ces indices commencent par 1. L'indice GET_INDEX est un indice spécial désignant les indices que l'on souhaite récupérer.

Paramètres

xpath_before_index	L'adresse avant indice.
xpath_after_index	L'adresse après indice.
indexes	Le tableau qui contiendra l'ensemble des indices trouvés (ce tableau n'est pas effacé avant utilisation).

Définition à la ligne 135 du fichier ParameterCaseOption.cc.

Références Arcane::String::view().

Voici le graphe d'appel pour cette fonction :

◆ indexesInParam() [2/2]

void Arcane::ParameterCaseOption::indexesInParam	(	const String &	xpath_before_index,
		UniqueArray< Integer > &	indexes,
		bool	allow_elems_after_index ) const

Méthode permettant de récupérer le ou les indices de l'option.

L'adresse de l'option est reformée comme ceci : xpath_before_index[GET_INDEX]

xpath_before_index doit être de la forme suivante : //case/aaa/bbb[2]/ccc

le "//case/" au début (ou "//cas/" en français"), - une succession de tags avec possiblement leurs indices, - pas de "/" à la fin,
un indice peut être mise à la fin (mais il sera remplacé par GET_INDEX).

Si le paramètre allow_elems_after_index est activé, les adresses de la forme : xpath_before_index[GET_INDEX]/aaa/bbb seront aussi recherchées.

Les indices sont des indices XML et ces indices commencent par 1. L'indice GET_INDEX est un indice spécial désignant les indices que l'on souhaite récupérer.

Paramètres

xpath_before_index	L'adresse avant indice.
indexes	Le tableau qui contiendra l'ensemble des indices trouvés
allow_elems_after_index	Doit-on vérifier la présence d'éléments après l'indice ? (ce tableau n'est pas effacé avant utilisation).

Définition à la ligne 148 du fichier ParameterCaseOption.cc.

Références Arcane::String::view().

Voici le graphe d'appel pour cette fonction :

Documentation des données membres

◆ m_is_fr

bool Arcane::ParameterCaseOption::m_is_fr

private

Définition à la ligne 298 du fichier ParameterCaseOption.h.

◆ m_lines

ParameterOptionElementsCollection* Arcane::ParameterCaseOption::m_lines

private

Définition à la ligne 299 du fichier ParameterCaseOption.h.

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

Fonctions membres publiques

Fonctions membres privées

Attributs privés

Description détaillée

Documentation des constructeurs et destructeur

◆ ParameterCaseOption()

Documentation des fonctions membres

◆ _removeUselessPartInXpath()

◆ count() [1/2]

◆ count() [2/2]

◆ exist()

◆ existAnyIndex() [1/2]

◆ existAnyIndex() [2/2]

◆ getParameterOrNull() [1/3]

◆ getParameterOrNull() [2/3]

◆ getParameterOrNull() [3/3]

◆ indexesInParam() [1/2]

◆ indexesInParam() [2/2]

Documentation des données membres

◆ m_is_fr

◆ m_lines