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

#include <arcane/core/CaseOptionSimple.h>

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

Graphe de collaboration de Arcane::CaseOptionSimple:

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.

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.

	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)

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)

Attributs privés
XmlNode	m_element
	Element de l'option.

ICaseFunction *	m_function = nullptr
	Fonction associée (ou nullptr)

IStandardFunction *	m_standard_function = nullptr

IPhysicalUnitConverter *	m_unit_converter = nullptr
	Convertisseur d'unité (nullptr si pas besoin). Valide uniquement pour les options 'Real'.

bool	m_changed_since_last_iteration = false

bool	m_is_optional = false

bool	m_has_valid_value = false

String	m_default_physical_unit

String	m_physical_unit

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 77 du fichier CaseOptionSimple.cc.

◆ CaseOptionSimple() [2/2]

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

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

◆ ~CaseOptionSimple()

Arcane::CaseOptionSimple::~CaseOptionSimple ( )

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

Documentation des fonctions membres

◆ _convertFunctionIntegerToString()

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

staticprotected

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

◆ _convertFunctionRealToString()

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

staticprotected

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

Réimplémentée dans Arcane::CaseOptionSimpleT< T >, Arcane::CaseOptionSimpleT< bool >, Arcane::CaseOptionSimpleT< Int32 >, Arcane::CaseOptionSimpleT< Int64 >, Arcane::CaseOptionSimpleT< Integer >, Arcane::CaseOptionSimpleT< Real >, Arcane::CaseOptionSimpleT< Real2 >, Arcane::CaseOptionSimpleT< Real3 >, Arcane::CaseOptionSimpleT< RealArray >, et Arcane::CaseOptionSimpleT< String >.

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

◆ _searchFunction()

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

protected

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

◆ _setChangedSinceLastIteration()

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

protected

Définition à la ligne 204 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 152 du fichier CaseOptionSimple.cc.

◆ 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 234 du fichier CaseOptionSimple.cc.

◆ element()

XmlNode Arcane::CaseOptionSimple::element ( ) 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 100 du fichier CaseOptionSimple.h.

◆ 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.

◆ 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 213 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().

◆ 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().

◆ 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::ArcaneCaseMeshService::createMesh(), Arcane::CaseOptionExtended::setDefaultValue(), Arcane::CaseOptionExtendedT< T >::valueIfPresentOrArgument(), Arcane::CaseOptionSimpleT< T >::valueIfPresentOrArgument(), et Arcane::CaseOptionEnumT< EnumType >::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 161 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.

◆ 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 243 du fichier CaseOptionSimple.cc.

◆ xpathFullName()

String Arcane::CaseOptionSimple::xpathFullName ( ) const

Nom complet au format donné par la norme XPath.

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

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

Documentation des données membres

◆ m_changed_since_last_iteration

bool Arcane::CaseOptionSimple::m_changed_since_last_iteration = false

private

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

◆ m_default_physical_unit

String Arcane::CaseOptionSimple::m_default_physical_unit

private

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

◆ m_element

XmlNode Arcane::CaseOptionSimple::m_element

private

Element de l'option.

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

◆ m_function

ICaseFunction* Arcane::CaseOptionSimple::m_function = nullptr

private

Fonction associée (ou nullptr)

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

◆ m_has_valid_value

bool Arcane::CaseOptionSimple::m_has_valid_value = false

private

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

◆ m_is_optional

bool Arcane::CaseOptionSimple::m_is_optional = false

private

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

◆ m_physical_unit

String Arcane::CaseOptionSimple::m_physical_unit

private

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

◆ m_standard_function

IStandardFunction* Arcane::CaseOptionSimple::m_standard_function = nullptr

private

Fonction standard associée (ou nullpt)

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

◆ m_unit_converter

IPhysicalUnitConverter* Arcane::CaseOptionSimple::m_unit_converter = nullptr

private

Convertisseur d'unité (nullptr si pas besoin). Valide uniquement pour les options 'Real'.

Définition à la ligne 178 du fichier CaseOptionSimple.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 protégées statiques

Attributs privés

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()

◆ defaultPhysicalUnit()

◆ element()

◆ function()

◆ hasChangedSinceLastIteration()

◆ hasValidValue()

◆ isOptional()

◆ isPresent()

◆ physicalUnit()

◆ physicalUnitConverter()

◆ standardFunction()

◆ visit()

◆ xpathFullName()

Documentation des données membres

◆ m_changed_since_last_iteration

◆ m_default_physical_unit

◆ m_element

◆ m_function

◆ m_has_valid_value

◆ m_is_optional

◆ m_physical_unit

◆ m_standard_function

◆ m_unit_converter