Classe de base des options simples (uniquement une valeur). Plus de détails...

#include <arcane/core/CaseOptionSimple.h>

Fonctions membres publiques
	CaseOptionSimple (const CaseOptionBuildInfo &cob)

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

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

	ARCANE_DEPRECATED_LONG_TERM ("Y2022: Do not access XML item from option") 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.

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

ICaseMng *	caseMng () const
	Gestionnaire de cas.

ICaseOptionList *	parentOptionList () const
	OptionList parent.

ITraceMng *	traceMng () const
	Gestionnaire de traces.

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

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)

bool	isOptional () const
	Permet de savoir si une option est optionnelle.

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

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
void	_search (bool is_phase1) override

virtual bool	_allowPhysicalUnit ()=0

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 protégées statiques
static String	_convertFunctionRealToString (ICaseFunction *func, Real t)

static String	_convertFunctionIntegerToString (ICaseFunction *func, Integer t)

Description détaillée

Classe de base des options simples (uniquement une valeur).

Définition à la ligne 79 du fichier CaseOptionSimple.h.

Documentation des constructeurs et destructeur

◆ CaseOptionSimple() [1/2]

Arcane::CaseOptionSimple::CaseOptionSimple ( const CaseOptionBuildInfo & cob )

explicit

Définition à la ligne 83 du fichier CaseOptionSimple.cc.

◆ CaseOptionSimple() [2/2]

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

Définition à la ligne 94 du fichier CaseOptionSimple.cc.

◆ ~CaseOptionSimple()

Arcane::CaseOptionSimple::~CaseOptionSimple ( )

Définition à la ligne 106 du fichier CaseOptionSimple.cc.

Documentation des fonctions membres

◆ _convertFunctionIntegerToString()

String Arcane::CaseOptionSimple::_convertFunctionIntegerToString	(	ICaseFunction *	func,
		Integer	t )

staticprotected

Définition à la ligne 814 du fichier CaseOptionSimple.cc.

◆ _convertFunctionRealToString()

String Arcane::CaseOptionSimple::_convertFunctionRealToString	(	ICaseFunction *	func,
		Real	t )

staticprotected

Définition à la ligne 803 du fichier CaseOptionSimple.cc.

◆ _element()

XmlNode Arcane::CaseOptionSimple::_element ( ) const

inlineprotected

Définition à la ligne 167 du fichier CaseOptionSimple.h.

◆ _search()

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

overrideprotectedvirtual

Implémente Arcane::CaseOptionBase.

Définition à la ligne 115 du fichier CaseOptionSimple.cc.

◆ _searchFunction()

void Arcane::CaseOptionSimple::_searchFunction ( XmlNode & velem )

protected

Définition à la ligne 195 du fichier CaseOptionSimple.cc.

◆ _setChangedSinceLastIteration()

void Arcane::CaseOptionSimple::_setChangedSinceLastIteration ( bool has_changed )

protected

Définition à la ligne 229 du fichier CaseOptionSimple.cc.

◆ _setHasValidValue()

void Arcane::CaseOptionSimple::_setHasValidValue ( bool v )

inlineprotected

Définition à la ligne 166 du fichier CaseOptionSimple.h.

◆ _setPhysicalUnit()

void Arcane::CaseOptionSimple::_setPhysicalUnit ( const String & value )

protected

Définition à la ligne 177 du fichier CaseOptionSimple.cc.

◆ ARCANE_DEPRECATED_LONG_TERM()

Arcane::CaseOptionSimple::ARCANE_DEPRECATED_LONG_TERM ( "Y2022: Do not access XML item from option" ) const

inline

Retourne l'élément de l'option.

Obsolète: L'implémentation interne ne doit pas être utilisée pour permettre à terme d'utiliser un autre format que le XML.

Définition à la ligne 99 du fichier CaseOptionSimple.h.

◆ defaultPhysicalUnit()

String Arcane::CaseOptionSimple::defaultPhysicalUnit ( ) const

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

Définition à la ligne 259 du fichier CaseOptionSimple.cc.

◆ function()

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

inlineoverridevirtual

Fonction associée à cette option (0 si aucune).

Si une fonction est associée à l'option, les valeurs de cette dernière sont recalculées automatiquement à chaque itération.

Implémente Arcane::CaseOptionBase.

Définition à la ligne 108 du fichier CaseOptionSimple.h.

Référencé par Arcane::CaseOptionSimpleT< T >::updateFromFunction(), Arcane::CaseOptionSimpleT< T >::valueAtParameter(), et Arcane::CaseOptionSimpleT< T >::valueAtParameter().

◆ hasChangedSinceLastIteration()

bool Arcane::CaseOptionSimple::hasChangedSinceLastIteration ( ) const

Indique si la valeur a changée depuis la dernière itération.

La valeur ne peut changée que si une fonction est associée à l'option. La méthode retourne vrai si la valeur de l'option est différente de l'itération précédente. Cette méthode fonctionne aussi en cas de retour arrière.

Définition à la ligne 238 du fichier CaseOptionSimple.cc.

◆ hasValidValue()

bool Arcane::CaseOptionSimple::hasValidValue ( ) const

inline

Indique si l'option a une valeur invalide.

C'est apriori toujours le cas, sauf si l'option est facultative (isOptional()==true) et non renseignée.

Définition à la ligne 155 du fichier CaseOptionSimple.h.

Référencé par Arcane::CaseOptionExtended::print(), et Arcane::CaseOptionSimpleT< T >::print().

◆ isOptional()

bool Arcane::CaseOptionSimple::isOptional ( ) const

inline

Indique si l'option est facultative.

Si une option facultative n'est pas renseignée, sa valeur est indéfinie et ne doit donc pas être utilisée.

Définition à la ligne 147 du fichier CaseOptionSimple.h.

Référencé par Arcane::CaseOptionExtended::_search(), et Arcane::CaseOptionSimpleT< T >::_search().

◆ isPresent()

bool Arcane::CaseOptionSimple::isPresent ( ) const

inline

Retourne true si l'option est présente.

Définition à la ligne 91 du fichier CaseOptionSimple.h.

Référencé par Arcane::CaseOptionExtended::setDefaultValue(), Arcane::CaseOptionSimpleT< T >::setDefaultValue(), Arcane::CaseOptionEnumT< EnumType >::valueIfPresentOrArgument(), Arcane::CaseOptionExtendedT< T >::valueIfPresentOrArgument(), et Arcane::CaseOptionSimpleT< Real >::valueIfPresentOrArgument().

◆ physicalUnit()

String Arcane::CaseOptionSimple::physicalUnit ( ) const

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

Définition à la ligne 186 du fichier CaseOptionSimple.cc.

◆ physicalUnitConverter()

IPhysicalUnitConverter * Arcane::CaseOptionSimple::physicalUnitConverter ( ) const

inline

Convertisseur d'unité physique.

Ce convertisseur n'existe que pour les options de type 'Real'ou 'RealArray'. Il est nul si l'option ne possède pas d'unité.

Définition à la ligne 140 du fichier CaseOptionSimple.h.

Référencé par Arcane::CaseOptionSimpleT< T >::_search(), Arcane::CaseOptionSimpleT< T >::updateFromFunction(), Arcane::CaseOptionSimpleT< T >::valueAtParameter(), et Arcane::CaseOptionSimpleT< T >::valueAtParameter().

◆ standardFunction()

virtual IStandardFunction * Arcane::CaseOptionSimple::standardFunction ( ) const

inlinevirtual

Fonction standard associée à cette option (0 si aucune).

Une fonction standard a un prototype spécifique et peut être appelée directement. Contrairement à function(), la présence d'une fonction standard ne change pas la valeur de l'option.

Définition à la ligne 116 du fichier CaseOptionSimple.h.

◆ visit()

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

overridevirtual

Applique le visiteur sur cette option.

Implémente Arcane::CaseOptionBase.

Définition à la ligne 268 du fichier CaseOptionSimple.cc.

◆ xpathFullName()

String Arcane::CaseOptionSimple::xpathFullName ( ) const

Nom complet au format donné par la norme XPath.

Définition à la ligne 247 du fichier CaseOptionSimple.cc.

Références Arcane::CaseOptionBase::name(), et Arcane::CaseOptionBase::rootElement().

Référencé par Arcane::CaseOptionExtended::_search(), et Arcane::CaseOptionExtended::setDefaultValue().

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 protégées statiques

Description détaillée

Documentation des constructeurs et destructeur

◆ CaseOptionSimple() [1/2]

◆ CaseOptionSimple() [2/2]

◆ ~CaseOptionSimple()

Documentation des fonctions membres

◆ _convertFunctionIntegerToString()

◆ _convertFunctionRealToString()

◆ _element()

◆ _search()

◆ _searchFunction()

◆ _setChangedSinceLastIteration()

◆ _setHasValidValue()

◆ _setPhysicalUnit()

◆ ARCANE_DEPRECATED_LONG_TERM()

◆ defaultPhysicalUnit()

◆ function()

◆ hasChangedSinceLastIteration()

◆ hasValidValue()

◆ isOptional()

◆ isPresent()

◆ physicalUnit()

◆ physicalUnitConverter()

◆ standardFunction()

◆ visit()

◆ xpathFullName()