Option du jeu de données de type simple (réel, entier, booléen, ...) Plus de détails...

#include <arcane/core/CaseOptionSimple.h>

Graphe d'héritage de Arcane::CaseOptionSimpleT< T >:

Graphe de collaboration de Arcane::CaseOptionSimpleT< T >:

Types publics
typedef CaseOptionSimpleT< T >	ThatClass

typedef CaseOptionTraitsT< T >::ContainerType	Type
	Type de l'option.

Fonctions membres publiques
	CaseOptionSimpleT (const CaseOptionBuildInfo &cob)

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

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

const Type &	value () const
	Retourne la valeur de l'option.

	operator const Type & () const
	Valeur de l'option.

Type	valueAtParameter (Real t) const
	Retourne la valeur de l'option pour le paramètre réel t.

Type	valueAtParameter (Integer t) const
	Retourne la valeur de l'option pour le paramètre entier t.

const Type &	operator() () const
	Retourne la valeur de l'option.

ARCANE_DEPRECATED Type	operator() (Real t) const
	Retourne la valeur de l'option pour le paramètre réel t.

ARCANE_DEPRECATED Type	operator() (Integer t) const
	Retourne la valeur de l'option pour le paramètre entier t.

virtual void	updateFromFunction (Real current_time, Integer current_iteration)

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

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

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)
	Cherche la valeur de l'option dans le jeu de données.

virtual bool	_allowPhysicalUnit ()

Fonctions membres protégées hérités de Arcane::CaseOptionSimple
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
Type	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 T>
class Arcane::CaseOptionSimpleT< T >

Option du jeu de données de type simple (réel, entier, booléen, ...)

La méthode la plus utilisée de cette classe est l'opérateur operator()() qui permet de récupérer la valeur de l'option. Si une fonction (ICaseFunction) est associée à l'option, il est possible de récupérer la valeur de l'option au temps physique ou à l'itération passé en paramètre de la méthode valueAtParameter().

CaseOptionSimpleT<Real> real_option;
Real v = real_option(); // utilise operator()
Real v = real_option; // utilise opérateur de cast implicite
Real v = real_option.valueAtParameter(0.3); // valeur au temps physique 0.3

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

Documentation des définitions de type membres

◆ ThatClass

template<class T >

typedef CaseOptionSimpleT<T> Arcane::CaseOptionSimpleT< T >::ThatClass

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

◆ Type

template<class T >

typedef CaseOptionTraitsT<T>::ContainerType Arcane::CaseOptionSimpleT< T >::Type

Type de l'option.

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

Documentation des constructeurs et destructeur

◆ CaseOptionSimpleT() [1/2]

template<typename T >

Arcane::CaseOptionSimpleT< T >::CaseOptionSimpleT ( const CaseOptionBuildInfo & cob )

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

◆ CaseOptionSimpleT() [2/2]

template<typename T >

Arcane::CaseOptionSimpleT< T >::CaseOptionSimpleT	(	const CaseOptionBuildInfo &	cob,
		const String &	physical_unit
	)

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

Documentation des fonctions membres

◆ _allowPhysicalUnit()

template<typename T >

bool Arcane::CaseOptionSimpleT< T >::_allowPhysicalUnit ( )

protectedvirtual

Implémente Arcane::CaseOptionSimple.

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

◆ _search()

template<typename T >

void Arcane::CaseOptionSimpleT< T >::_search ( bool is_phase1 )

protectedvirtual

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

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

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

Réimplémentée à partir de Arcane::CaseOptionSimple.

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

◆ operator const Type &()

template<class T >

Arcane::CaseOptionSimpleT< T >::operator const Type & ( ) const

inline

Valeur de l'option.

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

Références Arcane::CaseOptionSimpleT< T >::value().

◆ operator()() [1/3]

template<class T >

const Type & Arcane::CaseOptionSimpleT< T >::operator() ( ) const

inline

Retourne la valeur de l'option.

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

Références Arcane::CaseOptionSimpleT< T >::value().

◆ operator()() [2/3]

template<class T >

ARCANE_DEPRECATED Type Arcane::CaseOptionSimpleT< T >::operator() ( Integer t ) const

inline

Retourne la valeur de l'option pour le paramètre entier t.

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

Références Arcane::CaseOptionSimpleT< T >::valueAtParameter().

◆ operator()() [3/3]

template<class T >

ARCANE_DEPRECATED Type Arcane::CaseOptionSimpleT< T >::operator() ( Real t ) const

inline

Retourne la valeur de l'option pour le paramètre réel t.

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

Références Arcane::CaseOptionSimpleT< T >::valueAtParameter().

◆ print()

template<typename T >

void Arcane::CaseOptionSimpleT< T >::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 570 du fichier CaseOptionSimple.cc.

◆ setDefaultValue()

template<typename T >

void Arcane::CaseOptionSimpleT< T >::setDefaultValue ( const Type & 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 418 du fichier CaseOptionSimple.cc.

Références ARCANE_FATAL, et Arcane::builtInPutValue().

◆ updateFromFunction()

template<typename T >

void Arcane::CaseOptionSimpleT< T >::updateFromFunction	(	Real	current_time,
		Integer	current_iteration
	)

virtual

For internal use only

Implémente Arcane::CaseOptionBase.

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

Références Arccore::TraceAccessor::debug(), et Arccore::TraceAccessor::traceMng().

◆ value()

template<class T >

const Type & Arcane::CaseOptionSimpleT< T >::value ( ) const

inline

Retourne la valeur de l'option.

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

Références Arcane::CaseOptionSimpleT< T >::m_value.

Référencé par Arcane::CaseOptionSimpleT< T >::operator const Type &(), et Arcane::CaseOptionSimpleT< T >::operator()().

◆ valueAtParameter() [1/2]

template<typename T >

CaseOptionSimpleT< T >::Type Arcane::CaseOptionSimpleT< T >::valueAtParameter ( Integer t ) const

Retourne la valeur de l'option pour le paramètre entier t.

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

◆ valueAtParameter() [2/2]

template<typename T >

CaseOptionSimpleT< T >::Type Arcane::CaseOptionSimpleT< T >::valueAtParameter ( Real t ) const

Retourne la valeur de l'option pour le paramètre réel t.

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

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

◆ valueIfPresentOrArgument()

template<class T >

const Type & Arcane::CaseOptionSimpleT< T >::valueIfPresentOrArgument ( const Type & arg_value )

inline

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

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

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

Documentation des données membres

◆ m_value

template<class T >

Type Arcane::CaseOptionSimpleT< T >::m_value

private

Valeur de l'option.

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

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

La documentation de cette classe a été générée à partir des fichiers suivants :

Types publics

Fonctions membres publiques

Fonctions membres protégées

Attributs privés

Membres hérités additionnels

Description détaillée

Documentation des définitions de type membres

◆ ThatClass

◆ Type

Documentation des constructeurs et destructeur

◆ CaseOptionSimpleT() [1/2]

◆ CaseOptionSimpleT() [2/2]

Documentation des fonctions membres

◆ _allowPhysicalUnit()

◆ _search()

◆ operator const Type &()

◆ operator()() [1/3]

◆ operator()() [2/3]

◆ operator()() [3/3]

◆ print()

◆ setDefaultValue()

◆ updateFromFunction()

◆ value()

◆ valueAtParameter() [1/2]

◆ valueAtParameter() [2/2]

◆ valueIfPresentOrArgument()

Documentation des données membres

◆ m_value