Arcane  v3.14.10.0
Documentation utilisateur
Chargement...
Recherche...
Aucune correspondance
Référence de la classe Arcane::CaseOptionEnumValues
+ Graphe de collaboration de Arcane::CaseOptionEnumValues:

Types publics

typedef UniqueArray< CaseOptionEnumValue * > EnumValueList
 Type de la liste des valeurs.
 

Fonctions membres publiques

 CaseOptionEnumValues ()
 Contruit l'instance.
 
 ~CaseOptionEnumValues ()
 Libère les ressources.
 
void addEnumValue (CaseOptionEnumValue *value, bool do_clone)
 Ajoute la valeur d'énumération value. L'instance devient propriétaire de value qui est détruite lorsqu'elle n'est plus utilisée. Cette fonction ne doit être appelée qu'à l'initialisation. Si do_clone est vrai, c'est une copie de value qui est utilisée.
 
Integer nbEnumValue () const
 Retourne le nombre de valeurs de l'énumération.
 
CaseOptionEnumValueenumValue (Integer index) const
 Retourne la ième valeur.
 
bool valueOfName (const String &name, const String &lang, int &value) const
 Retourne la valeur de l'énumération ayant le nom name.
 
String nameOfValue (int value, const String &lang) const
 Retourne le nom de correspondant à la valeur value pour le langage lang.
 
void getValidNames (const String &lang, StringArray &names) const
 Remplit names avec les noms valides pour la langue lang.
 

Description détaillée

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

Documentation des définitions de type membres

◆ EnumValueList

Type de la liste des valeurs.

Définition à la ligne 105 du fichier CaseOptionEnum.h.

Documentation des constructeurs et destructeur

◆ CaseOptionEnumValues()

Arcane::CaseOptionEnumValues::CaseOptionEnumValues ( )

Contruit l'instance.

Définition à la ligne 119 du fichier CaseOptionEnum.cc.

◆ ~CaseOptionEnumValues()

Arcane::CaseOptionEnumValues::~CaseOptionEnumValues ( )

Libère les ressources.

Définition à la ligne 125 du fichier CaseOptionEnum.cc.

Documentation des fonctions membres

◆ addEnumValue()

void Arcane::CaseOptionEnumValues::addEnumValue ( CaseOptionEnumValue value,
bool  do_clone 
)

Ajoute la valeur d'énumération value. L'instance devient propriétaire de value qui est détruite lorsqu'elle n'est plus utilisée. Cette fonction ne doit être appelée qu'à l'initialisation. Si do_clone est vrai, c'est une copie de value qui est utilisée.

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

◆ enumValue()

CaseOptionEnumValue * Arcane::CaseOptionEnumValues::enumValue ( Integer  index) const

Retourne la ième valeur.

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

◆ getValidNames()

void Arcane::CaseOptionEnumValues::getValidNames ( const String lang,
StringArray names 
) const

Remplit names avec les noms valides pour la langue lang.

Définition à la ligne 197 du fichier CaseOptionEnum.cc.

Références Arccore::Array< T >::add().

◆ nameOfValue()

String Arcane::CaseOptionEnumValues::nameOfValue ( int  value,
const String lang 
) const

Retourne le nom de correspondant à la valeur value pour le langage lang.

Définition à la ligne 181 du fichier CaseOptionEnum.cc.

Référencé par Arcane::CaseOptionEnum::print(), et Arcane::CaseOptionMultiEnum::print().

◆ nbEnumValue()

Integer Arcane::CaseOptionEnumValues::nbEnumValue ( ) const

Retourne le nombre de valeurs de l'énumération.

Définition à la ligne 156 du fichier CaseOptionEnum.cc.

◆ valueOfName()

bool Arcane::CaseOptionEnumValues::valueOfName ( const String name,
const String lang,
int &  value 
) const

Retourne la valeur de l'énumération ayant le nom name.

La valeur est retournée dans index.

Paramètres
namenom de l'énumération
langest le langage du jeu de données
valueest la valeur de l'énumération (en retour)
Valeurs retournées
trueen cas d'erreur,
falseen cas de succès.

Définition à la ligne 165 du fichier CaseOptionEnum.cc.


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