Référence du modèle de la classe Arcane::CaseOptionExtendedT< T >

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

#include <arcane/core/CaseOptionExtended.h>

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

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

Fonctions membres publiques
	CaseOptionExtendedT (const CaseOptionBuildInfo &cob, const String &type_name)
	operator const T & () const
	Valeur de l'option.
const T &	value () const
	Valeur de l'option.
const T &	operator() () const
	Valeur de l'option.
const T &	valueIfPresentOrArgument (const T &arg_value)
	Retourne la valeur de l'option si isPresent()==true ou sinon arg_value.
Fonctions membres publiques hérités de Arcane::CaseOptionExtended
	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)
Fonctions membres protégées hérités de Arcane::CaseOptionExtended
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
T	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::CaseOptionExtendedT< T >

Option du jeu de donnée de type étendu.

Cette classe se sert d'une fonction externe dont le prototype est:

extern "C++" bool
_caseOptionConvert(const CaseOption&,const String&,T& obj);

pour retrouver à partir d'une chaine de caractère un objet du type T. Cette fonction retourne true si un tel objet n'est pas trouvé. Si l'objet est trouvé, il est stocké dans obj.

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

Documentation des constructeurs et destructeur

CaseOptionExtendedT()

template<class T >

Arcane::CaseOptionExtendedT< T >::CaseOptionExtendedT ( const CaseOptionBuildInfo &  cob, const String &  type_name  )

inline

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

Documentation des fonctions membres

_tryToConvert()

template<class T >

virtual bool Arcane::CaseOptionExtendedT< T >::_tryToConvert ( const String &  s )

inlineprotectedvirtual

Implémente Arcane::CaseOptionExtended.

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

operator const T &()

template<class T >

Arcane::CaseOptionExtendedT< T >::operator const T & ( ) const

inline

Valeur de l'option.

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

operator()()

template<class T >

const T & Arcane::CaseOptionExtendedT< T >::operator() ( ) const

inline

Valeur de l'option.

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

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

value()

template<class T >

const T & Arcane::CaseOptionExtendedT< T >::value ( ) const

inline

Valeur de l'option.

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

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

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

valueIfPresentOrArgument()

template<class T >

const T & Arcane::CaseOptionExtendedT< T >::valueIfPresentOrArgument ( const T &  arg_value )

inline

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

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

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

Documentation des données membres

m_value

template<class T >

T Arcane::CaseOptionExtendedT< T >::m_value

private

Valeur de l'option.

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

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

---

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

• CaseOptionExtended.h