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

#include <arcane/core/CaseOptionExtended.h>

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

Graphe de collaboration de Arcane::CaseOptionExtended:

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

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

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

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

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

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

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 bool	_tryToConvert (const String &s)=0

void	_search (bool is_phase1) override
	Cherche la valeur de l'option dans le jeu de donnée.

bool	_allowPhysicalUnit () override

String	_typeName () const

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
String	m_type_name
	Nom du type de l'option.

String	m_value
	Valeur de l'option sous forme de chaîne unicode.

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ées de type étendu.

Définition à la ligne 33 du fichier CaseOptionExtended.h.

Documentation des constructeurs et destructeur

◆ CaseOptionExtended()

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

inline

Définition à la ligne 38 du fichier CaseOptionExtended.h.

Documentation des fonctions membres

◆ _allowPhysicalUnit()

bool Arcane::CaseOptionExtended::_allowPhysicalUnit ( )

inlineoverrideprotectedvirtual

Implémente Arcane::CaseOptionSimple.

Définition à la ligne 61 du fichier CaseOptionExtended.h.

◆ _search()

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

overrideprotectedvirtual

Cherche la valeur de l'option dans le jeu de donnée.

La valeur trouvée est stockée dans m_value.

Si la valeur n'est pas présente dans le jeu de donnée, regarde s'il existe une valeur par défaut et utilise cette dernière.

Implémente Arcane::CaseOptionBase.

Définition à la ligne 141 du fichier CaseOptionExtended.cc.

◆ _typeName()

String Arcane::CaseOptionExtended::_typeName ( ) const

inlineprotected

Définition à la ligne 63 du fichier CaseOptionExtended.h.

◆ function()

ICaseFunction * Arcane::CaseOptionExtended::function ( ) const

inlineoverridevirtual

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

Implémente Arcane::CaseOptionBase.

Définition à la ligne 44 du fichier CaseOptionExtended.h.

◆ print()

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

overridevirtual

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

Implémente Arcane::CaseOptionBase.

Définition à la ligne 182 du fichier CaseOptionExtended.cc.

Références Arcane::CaseOptionSimple::hasValidValue(), et m_value.

◆ setDefaultValue()

void Arcane::CaseOptionExtended::setDefaultValue ( const String & def_value )

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 108 du fichier CaseOptionExtended.cc.

Références ARCANE_FATAL, Arcane::CaseOptionSimple::isPresent(), m_value, et Arcane::CaseOptionSimple::xpathFullName().

◆ updateFromFunction()

void Arcane::CaseOptionExtended::updateFromFunction	(	Real	current_time,
		Integer	current_iteration
	)

inlineoverridevirtual

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 45 du fichier CaseOptionExtended.h.

◆ visit()

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

overridevirtual

Applique le visiteur sur cette option.

Implémente Arcane::CaseOptionBase.

Définition à la ligne 196 du fichier CaseOptionExtended.cc.

Documentation des données membres

◆ m_type_name

String Arcane::CaseOptionExtended::m_type_name

private

Nom du type de l'option.

Définition à la ligne 67 du fichier CaseOptionExtended.h.

◆ m_value

String Arcane::CaseOptionExtended::m_value

private

Valeur de l'option sous forme de chaîne unicode.

Définition à la ligne 68 du fichier CaseOptionExtended.h.

Référencé par _search(), print(), et setDefaultValue().

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

Membres hérités additionnels

Description détaillée

Documentation des constructeurs et destructeur

◆ CaseOptionExtended()

Documentation des fonctions membres

◆ _allowPhysicalUnit()

◆ _search()

◆ _typeName()

◆ function()

◆ print()

◆ setDefaultValue()

◆ updateFromFunction()

◆ visit()

Documentation des données membres

◆ m_type_name

◆ m_value