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

Classe représentant une partie d'une adresse d'option du jeu de données. À noter qu'en XML, l'index commence à 1 et non à 0. Plus de détails...

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

Graphe de collaboration de Arcane::ParameterOptionAddrPart:

Fonctions membres publiques
	ParameterOptionAddrPart ()
	Constructeur. Définit le tag en ANY_TAG et l'index en ANY_INDEX.
	ParameterOptionAddrPart (const StringView tag)
	Constructeur. Définit l'index à 1.
	ParameterOptionAddrPart (const StringView tag, const Integer index)
	Constructeur.
StringView	tag () const
Integer	index () const
void	setTag (const StringView tag)
void	setIndex (const Integer index)
bool	isAny () const
	isAny si ANY_TAG et ANY_INDEX.
bool	operator== (const ParameterOptionAddrPart &other) const
	Opérateur d'égalité. Le tag ANY_TAG est égal à tous les tags. L'index ANY_INDEX est égal à tous les index. L'index GET_INDEX est égal à tous les index.
bool	operator!= (const ParameterOptionAddrPart &other) const

Attributs publics statiques
static constexpr const char *	ANY_TAG = "/"
static constexpr Integer	ANY_INDEX = -1
static constexpr Integer	GET_INDEX = -2

Attributs privés
StringView	m_tag
Integer	m_index

Description détaillée

Classe représentant une partie d'une adresse d'option du jeu de données. À noter qu'en XML, l'index commence à 1 et non à 0.

Un tag spécial nommé ANY_TAG représente n'importe quel tag. Deux index spéciaux sont aussi disponibles :

• ANY_INDEX : Représente n'importe quel index,
• GET_INDEX : Représente un index à récupérer (voir la classe ParameterOptionAddr). Ces élements sont utiles pour l'opérateur ==. À noter que ANY_TAG ne peut pas être définit sans ANY_INDEX. Aussi, le tag ne peut pas être vide.

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

Documentation des constructeurs et destructeur

ParameterOptionAddrPart() [1/3]

Arcane::ParameterOptionAddrPart::ParameterOptionAddrPart

(

)

Constructeur. Définit le tag en ANY_TAG et l'index en ANY_INDEX.

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

Référencé par operator==().

Voici le graphe des appelants de cette fonction :

ParameterOptionAddrPart() [2/3]

Arcane::ParameterOptionAddrPart::ParameterOptionAddrPart ( const StringView tag )

explicit

Constructeur. Définit l'index à 1.

Paramètres

tag	Le tag de cette partie d'adresse. Ce tag ne peut pas être ANY_TAG.

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

ParameterOptionAddrPart() [3/3]

Arcane::ParameterOptionAddrPart::ParameterOptionAddrPart	(	const StringView	tag,
		const Integer	index )

Constructeur.

Paramètres

tag	Le tag de cette partie d'adresse. Ce tag ne peut pas être ANY_TAG si l'index n'est pas ANY_INDEX.
index	L'index de cette partie d'adresse.

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

Documentation des fonctions membres

index()

Integer Arcane::ParameterOptionAddrPart::index

(

)

const

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

isAny()

bool Arcane::ParameterOptionAddrPart::isAny

(

)

const

isAny si ANY_TAG et ANY_INDEX.

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

Référencé par Arcane::ParameterOptionAddr::operator==().

Voici le graphe des appelants de cette fonction :

operator!=()

bool Arcane::ParameterOptionAddrPart::operator!=

(

const ParameterOptionAddrPart &

other

)

const

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

operator==()

bool Arcane::ParameterOptionAddrPart::operator==

(

const ParameterOptionAddrPart &

other

)

const

Opérateur d'égalité. Le tag ANY_TAG est égal à tous les tags. L'index ANY_INDEX est égal à tous les index. L'index GET_INDEX est égal à tous les index.

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

Références ParameterOptionAddrPart().

Voici le graphe d'appel pour cette fonction :

setIndex()

void Arcane::ParameterOptionAddrPart::setIndex

(

const Integer

index

)

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

setTag()

void Arcane::ParameterOptionAddrPart::setTag

(

const StringView

tag

)

Si l'index est ANY_INDEX, le tag ne peut pas être ANY_TAG. Attention à la durée de vie de tag.

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

tag()

StringView Arcane::ParameterOptionAddrPart::tag

(

)

const

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

Documentation des données membres

ANY_INDEX

Integer Arcane::ParameterOptionAddrPart::ANY_INDEX = -1

staticconstexpr

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

ANY_TAG

const char* Arcane::ParameterOptionAddrPart::ANY_TAG = "/"

staticconstexpr

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

GET_INDEX

Integer Arcane::ParameterOptionAddrPart::GET_INDEX = -2

staticconstexpr

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

m_index

Integer Arcane::ParameterOptionAddrPart::m_index

private

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

m_tag

StringView Arcane::ParameterOptionAddrPart::m_tag

private

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

---

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

• ParameterOption.h
• ParameterOption.cc