Option du jeu de données de type liste d'énumération. Plus de détails...

#include <arcane/core/CaseOptionEnum.h>

Graphe d'héritage de Arcane::CaseOptionMultiEnum:

Graphe de collaboration de Arcane::CaseOptionMultiEnum:

Fonctions membres publiques
	CaseOptionMultiEnum (const CaseOptionBuildInfo &cob, const String &type_name)

virtual void	print (const String &lang, std::ostream &o) const
	Imprime la valeur de l'option dans le langage lang,sur le flot o.

virtual ICaseFunction *	function () const
	Retourne la fonction liée à cette option ou `nullptr` s'il n'y en a pas.

virtual void	updateFromFunction (Real, Integer)
	Met à jour la valeur de l'option à partir d'une fonction.

void	addEnumValue (CaseOptionEnumValue *value, bool do_clone)

CaseOptionEnumValues *	enumValues () const

virtual void	visit (ICaseDocumentVisitor *visitor) const
	Applique le visiteur sur cette option.

Fonctions membres publiques hérités de Arcane::CaseOptionBase
String	trueName () const
	Retourne le vrai nom (non traduit) de l'option.

String	name () const
	Retourne le nom de l'option correspondant au langage du jeu de données.

String	translatedName (const String &lang) const
	Nom dans la langue lang de l'option. Retourne name() si pas de traduction.

void	search (bool is_phase1)
	Récupère la valeur du fichier de configuration pour la variable.

ICaseMng *	caseMng () const
	Gestionnaire de cas.

ICaseOptionList *	parentOptionList () const
	OptionList parent.

ITraceMng *	traceMng () const
	Gestionnaire de traces.

ISubDomain *	subDomain () const
	Gestionnaire de sous-domaine.

	ARCANE_DEPRECATED_REASON ("Y2023: use caseMng()->caseDocument() instead.") ICaseDocument *caseDocument() const
	Retourne le gestionnaire de document.

ICaseDocumentFragment *	caseDocumentFragment () const
	Retourne le document associé à cette option.

void	setRootElement (const XmlNode &root_element)
	Positionne l'élément racine à root_element.

XmlNode	rootElement () const
	Retourne l'élément racine du DOM.

Integer	minOccurs () const
	Nombre minimum d'occurences (pour une option multiple)

Integer	maxOccurs () const
	Nombre maximum d'occurences (pour une option multiple) (-1 == unbounded)

void	addAlternativeNodeName (const String &lang, const String &name)
	Ajoute une traduction pour le nom de l'option.

void	addDefaultValue (const String &category, const String &value)
	Ajoute la valeur par défaut value à la catégorie category.

void	checkIsInitialized () const
	Lève une exception si l'option n'a pas été initialisée.

Fonctions membres protégées
virtual void	_search (bool is_phase1)

virtual bool	_allowPhysicalUnit ()

virtual void	_allocate (Integer size)=0
	Alloue un tableau pour size éléments.

virtual Integer	_nbElem () const =0
	Retourne le nombre d'éléments du tableau.

virtual void	_setOptionValue (Integer index, int v)=0

virtual int	_optionValue (Integer index) const =0
	Retourne la valeur de l'énumération pour l'indice index.

Fonctions membres protégées hérités de Arcane::CaseOptionBase
	CaseOptionBase (const CaseOptionBuildInfo &cob)

String	_defaultValue () const
	Retourne la valeur par défaut de l'option ou 0 s'il n'y en a pas.

void	_setDefaultValue (const String &def_value)

void	_setIsInitialized ()

bool	_isInitialized () const

void	_checkIsInitialized () const

void	_checkMinMaxOccurs (Integer nb_occur)

String	_xpathFullName () const

Attributs privés
String	m_type_name
	Nom de l'énumération.

CaseOptionEnumValues *	m_enum_values

Description détaillée

Option du jeu de données de type liste d'énumération.

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

Documentation des constructeurs et destructeur

◆ CaseOptionMultiEnum()

Arcane::CaseOptionMultiEnum::CaseOptionMultiEnum	(	const CaseOptionBuildInfo &	cob,
		const String &	type_name
	)

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

◆ ~CaseOptionMultiEnum()

Arcane::CaseOptionMultiEnum::~CaseOptionMultiEnum ( )

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

Documentation des fonctions membres

◆ _allocate()

virtual void Arcane::CaseOptionMultiEnum::_allocate ( Integer size )

protectedpure virtual

Alloue un tableau pour size éléments.

Implémenté dans Arcane::CaseOptionMultiEnumT< T >.

◆ _allowPhysicalUnit()

virtual bool Arcane::CaseOptionMultiEnum::_allowPhysicalUnit ( )

inlineprotectedvirtual

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

◆ _nbElem()

virtual Integer Arcane::CaseOptionMultiEnum::_nbElem ( ) const

protectedpure virtual

Retourne le nombre d'éléments du tableau.

Implémenté dans Arcane::CaseOptionMultiEnumT< T >.

Référencé par print().

◆ _optionValue()

virtual int Arcane::CaseOptionMultiEnum::_optionValue ( Integer index ) const

protectedpure virtual

Retourne la valeur de l'énumération pour l'indice index.

Implémenté dans Arcane::CaseOptionMultiEnumT< T >.

Référencé par print().

◆ _search()

void Arcane::CaseOptionMultiEnum::_search ( bool is_phase1 )

protectedvirtual

Implémente Arcane::CaseOptionBase.

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

◆ _setOptionValue()

virtual void Arcane::CaseOptionMultiEnum::_setOptionValue	(	Integer	index,
		int	v
	)

protectedpure virtual

Positionne la valeur de l'option à la valeur v. v est directement convertie en la valeur de l'énumération.

Implémenté dans Arcane::CaseOptionMultiEnumT< T >.

◆ addEnumValue()

void Arcane::CaseOptionMultiEnum::addEnumValue	(	CaseOptionEnumValue *	value,
		bool	do_clone
	)

inline

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

◆ enumValues()

CaseOptionEnumValues * Arcane::CaseOptionMultiEnum::enumValues ( ) const

inline

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

◆ function()

virtual ICaseFunction * Arcane::CaseOptionMultiEnum::function ( ) const

inlinevirtual

Retourne la fonction liée à cette option ou nullptr s'il n'y en a pas.

Implémente Arcane::CaseOptionBase.

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

◆ print()

void Arcane::CaseOptionMultiEnum::print	(	const String &	lang,
		std::ostream &	o
	)		const

virtual

Imprime la valeur de l'option dans le langage lang,sur le flot o.

Implémente Arcane::CaseOptionBase.

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

Références _nbElem(), _optionValue(), et Arcane::CaseOptionEnumValues::nameOfValue().

◆ updateFromFunction()

virtual void Arcane::CaseOptionMultiEnum::updateFromFunction	(	Real	current_time,
		Integer	current_iteration
	)

inlinevirtual

Met à jour la valeur de l'option à partir d'une fonction.

Si l'option n'est pas liée à une table de marche, ne fait rien. Sinon, utilise current_time ou current_iteration suivant le type de paramètre de la fonction pour calculer la nouvelle valeur de l'option. Cette valeur sera ensuite accessible normalement par la méthode operator().

Implémente Arcane::CaseOptionBase.

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

◆ visit()

void Arcane::CaseOptionMultiEnum::visit ( ICaseDocumentVisitor * visitor ) const

virtual

Applique le visiteur sur cette option.

Implémente Arcane::CaseOptionBase.

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

Documentation des données membres

◆ m_enum_values

CaseOptionEnumValues* Arcane::CaseOptionMultiEnum::m_enum_values

private

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

◆ m_type_name

String Arcane::CaseOptionMultiEnum::m_type_name

private

Nom de l'énumération.

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

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

Fonctions membres publiques

Fonctions membres protégées

Attributs privés

Description détaillée

Documentation des constructeurs et destructeur

◆ CaseOptionMultiEnum()

◆ ~CaseOptionMultiEnum()

Documentation des fonctions membres

◆ _allocate()

◆ _allowPhysicalUnit()

◆ _nbElem()

◆ _optionValue()

◆ _search()

◆ _setOptionValue()

◆ addEnumValue()

◆ enumValues()

◆ function()

◆ print()

◆ updateFromFunction()

◆ visit()

Documentation des données membres

◆ m_enum_values

◆ m_type_name