Option du jeu de données de type énuméré. Plus de détails...

#include <arcane/core/CaseOptionEnum.h>

Graphe d'héritage de Arcane::CaseOptionEnumT< EnumType >:

Graphe de collaboration de Arcane::CaseOptionEnumT< EnumType >:

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

EnumType	value () const
	Valeur de l'option.

	operator EnumType () const
	Valeur de l'option.

EnumType	operator() () const
	Valeur de l'option.

void	setDefaultValue (EnumType def_value)
	Positionne la valeur par défaut de l'option.

EnumType	valueIfPresentOrArgument (EnumType arg_value)
	Retourne la valeur de l'option si isPresent()==true ou sinon arg_value.

Fonctions membres publiques hérités de Arcane::CaseOptionEnum
	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	_setOptionValue (int i)
	Positionne à v la valeur de l'option.

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

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

virtual bool	_allowPhysicalUnit ()

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

Attributs privés
EnumType	m_value
	Valeur de l'option.

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

template<class EnumType>
class Arcane::CaseOptionEnumT< EnumType >

Option du jeu de données de type énuméré.

T est le type informatique de l'énumération.

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

Documentation des constructeurs et destructeur

◆ CaseOptionEnumT()

template<class EnumType >

Arcane::CaseOptionEnumT< EnumType >::CaseOptionEnumT	(	const CaseOptionBuildInfo &	cob,
		const String &	type_name
	)

inline

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

Documentation des fonctions membres

◆ _optionValue()

template<class EnumType >

virtual int Arcane::CaseOptionEnumT< EnumType >::_optionValue ( ) const

inlineprotectedvirtual

Retourne la valeur de l'option.

Implémente Arcane::CaseOptionEnum.

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

Références Arcane::CaseOptionEnumT< EnumType >::m_value.

◆ _setOptionValue()

template<class EnumType >

virtual void Arcane::CaseOptionEnumT< EnumType >::_setOptionValue ( int v )

inlineprotectedvirtual

Positionne à v la valeur de l'option.

Implémente Arcane::CaseOptionEnum.

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

Références Arcane::CaseOptionEnumT< EnumType >::m_value.

◆ operator EnumType()

template<class EnumType >

Arcane::CaseOptionEnumT< EnumType >::operator EnumType ( ) const

inline

Valeur de l'option.

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

Références Arcane::CaseOptionEnumT< EnumType >::value().

◆ operator()()

template<class EnumType >

EnumType Arcane::CaseOptionEnumT< EnumType >::operator() ( ) const

inline

Valeur de l'option.

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

Références Arcane::CaseOptionEnumT< EnumType >::value().

◆ setDefaultValue()

template<class EnumType >

void Arcane::CaseOptionEnumT< EnumType >::setDefaultValue ( EnumType def_value )

inline

Positionne la valeur par défaut de l'option.

Si l'option n'est pas pas présente dans le jeu de données, alors sa valeur sera celle spécifiée par l'argument def_value, sinon l'appel de cette méthode est sans effet.

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

◆ value()

template<class EnumType >

EnumType Arcane::CaseOptionEnumT< EnumType >::value ( ) const

inline

Valeur de l'option.

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

Références Arcane::CaseOptionEnumT< EnumType >::m_value.

Référencé par Arcane::CaseOptionEnumT< EnumType >::operator EnumType(), et Arcane::CaseOptionEnumT< EnumType >::operator()().

◆ valueIfPresentOrArgument()

template<class EnumType >

EnumType Arcane::CaseOptionEnumT< EnumType >::valueIfPresentOrArgument ( EnumType arg_value )

inline

Retourne la valeur de l'option si isPresent()==true ou sinon arg_value.

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

Références Arcane::CaseOptionSimple::isPresent(), et Arcane::CaseOptionEnumT< EnumType >::m_value.

Documentation des données membres

◆ m_value

template<class EnumType >

EnumType Arcane::CaseOptionEnumT< EnumType >::m_value

private

Valeur de l'option.

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

Référencé par Arcane::CaseOptionEnumT< EnumType >::_optionValue(), Arcane::CaseOptionEnumT< EnumType >::_setOptionValue(), Arcane::CaseOptionEnumT< EnumType >::value(), et Arcane::CaseOptionEnumT< EnumType >::valueIfPresentOrArgument().

La documentation de cette classe a été générée à partir du fichier suivant :

CaseOptionEnum.h

Fonctions membres publiques

Fonctions membres protégées

Attributs privés

Membres hérités additionnels

Description détaillée

Documentation des constructeurs et destructeur

◆ CaseOptionEnumT()

Documentation des fonctions membres

◆ _optionValue()

◆ _setOptionValue()

◆ operator EnumType()

◆ operator()()

◆ setDefaultValue()

◆ value()

◆ valueIfPresentOrArgument()

Documentation des données membres

◆ m_value