Option du jeu de donnée de type énumération. Plus de détails...

#include <arcane/core/CaseOptionEnum.h>

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

Graphe de collaboration de Arcane::CaseOptionEnum:

Fonctions membres publiques
	CaseOptionEnum (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 void	updateFromFunction (Real current_time, Integer current_iteration)
	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.

int	enumValueAsInt () const

Fonctions membres publiques hérités de Arcane::CaseOptionSimple
	CaseOptionSimple (const CaseOptionBuildInfo &cob)

	CaseOptionSimple (const CaseOptionBuildInfo &cob, const String &physical_unit)

bool	isPresent () const
	Retourne true si l'option est présente.

XmlNode	element () const
	Retourne l'élément de l'option.

ICaseFunction *	function () const override
	Fonction associée à cette option (0 si aucune).

virtual IStandardFunction *	standardFunction () const
	Fonction standard associée à cette option (0 si aucune).

bool	hasChangedSinceLastIteration () const
	Indique si la valeur a changée depuis la dernière itération.

String	xpathFullName () const
	Nom complet au format donné par la norme XPath.

String	defaultPhysicalUnit () const
	Unité physique par défaut de cette option (null si aucune unité), spécifiée dans le fichier .axl.

String	physicalUnit () const
	unité physique spécifiée dans le jeu de données (null si aucune unité)

IPhysicalUnitConverter *	physicalUnitConverter () const
	Convertisseur d'unité physique.

bool	isOptional () const
	Indique si l'option est facultative.

bool	hasValidValue () const
	Indique si l'option a une valeur invalide.

void	visit (ICaseDocumentVisitor *visitor) const override
	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	_setOptionValue (int v)=0
	Positionne à v la valeur de l'option.

virtual int	_optionValue () const =0
	Retourne la valeur de l'option.

void	_setEnumDefaultValue (int def_value)

Fonctions membres protégées hérités de Arcane::CaseOptionSimple
void	_search (bool is_phase1) override

void	_setChangedSinceLastIteration (bool has_changed)

void	_searchFunction (XmlNode &velem)

void	_setPhysicalUnit (const String &value)

void	_setHasValidValue (bool v)

XmlNode	_element () const

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

Fonctions membres privées
void	_updateFromFunction (Real current_time, Integer current_iteration)

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

CaseOptionEnumValues *	m_enum_values

Membres hérités additionnels
Fonctions membres protégées statiques hérités de Arcane::CaseOptionSimple
static String	_convertFunctionRealToString (ICaseFunction *func, Real t)

static String	_convertFunctionIntegerToString (ICaseFunction *func, Integer t)

Description détaillée

Option du jeu de donnée de type énumération.

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

Documentation des constructeurs et destructeur

◆ CaseOptionEnum()

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

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

◆ ~CaseOptionEnum()

Arcane::CaseOptionEnum::~CaseOptionEnum ( )

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

Documentation des fonctions membres

◆ _allowPhysicalUnit()

virtual bool Arcane::CaseOptionEnum::_allowPhysicalUnit ( )

inlineprotectedvirtual

Implémente Arcane::CaseOptionSimple.

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

◆ _optionValue()

virtual int Arcane::CaseOptionEnum::_optionValue ( ) const

protectedpure virtual

Retourne la valeur de l'option.

Implémenté dans Arcane::CaseOptionEnumT< EnumType >, Arcane::CaseOptionEnumT< MetisCallStrategy >, et Arcane::CaseOptionEnumT< MetisEmptyPartitionStrategy >.

Référencé par print().

◆ _search()

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

protectedvirtual

Implémente Arcane::CaseOptionBase.

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

◆ _setEnumDefaultValue()

void Arcane::CaseOptionEnum::_setEnumDefaultValue ( int def_value )

protected

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

◆ _setOptionValue()

virtual void Arcane::CaseOptionEnum::_setOptionValue ( int v )

protectedpure virtual

Positionne à v la valeur de l'option.

Implémenté dans Arcane::CaseOptionEnumT< EnumType >, Arcane::CaseOptionEnumT< MetisCallStrategy >, et Arcane::CaseOptionEnumT< MetisEmptyPartitionStrategy >.

◆ _updateFromFunction()

void Arcane::CaseOptionEnum::_updateFromFunction	(	Real	current_time,
		Integer	current_iteration
	)

private

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

◆ addEnumValue()

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

inline

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

◆ enumValueAsInt()

int Arcane::CaseOptionEnum::enumValueAsInt ( ) const

inline

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

◆ enumValues()

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

inline

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

◆ print()

void Arcane::CaseOptionEnum::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 296 du fichier CaseOptionEnum.cc.

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

◆ updateFromFunction()

virtual void Arcane::CaseOptionEnum::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 170 du fichier CaseOptionEnum.h.

◆ visit()

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

virtual

Applique le visiteur sur cette option.

Implémente Arcane::CaseOptionBase.

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

Documentation des données membres

◆ m_enum_values

CaseOptionEnumValues* Arcane::CaseOptionEnum::m_enum_values

private

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

◆ m_type_name

String Arcane::CaseOptionEnum::m_type_name

private

Nom de l'énumération.

Définition à la ligne 202 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

Fonctions membres privées

Attributs privés

Membres hérités additionnels

Description détaillée

Documentation des constructeurs et destructeur

◆ CaseOptionEnum()

◆ ~CaseOptionEnum()

Documentation des fonctions membres

◆ _allowPhysicalUnit()

◆ _optionValue()

◆ _search()

◆ _setEnumDefaultValue()

◆ _setOptionValue()

◆ _updateFromFunction()

◆ addEnumValue()

◆ enumValueAsInt()

◆ enumValues()

◆ print()

◆ updateFromFunction()

◆ visit()

Documentation des données membres

◆ m_enum_values

◆ m_type_name