Classe de base d'une option du jeu de donnée. Plus de détails...

#include <arcane/core/CaseOptionBase.h>

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

Graphe de collaboration de Arcane::CaseOptionBase:

Fonctions membres publiques
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.

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

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.

virtual void	visit (ICaseDocumentVisitor *visitor) const =0
	Applique le visiteur sur cette option.

void	checkIsInitialized () const
	Lève une exception si l'option n'a pas été initialisée.

Fonctions membres protégées
	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)

virtual void	_search (bool is_phase1)=0

void	_setIsInitialized ()

bool	_isInitialized () const

void	_checkIsInitialized () const

void	_checkMinMaxOccurs (Integer nb_occur)

String	_xpathFullName () const

Fonctions membres privées
void	_setTranslatedName ()

void	_setCategoryDefaultValue ()

	CaseOptionBase (const CaseOptionBase &from)=delete
	Constructeur de copie.

CaseOptionBase &	operator= (const CaseOptionBase &from)=delete
	Opérateur de recopie.

Attributs privés
CaseOptionBasePrivate *	m_p
	Implémentation.

Description détaillée

Classe de base d'une option du jeu de donnée.

Fait le lien entre l'option de nom m_name et le noeud du DOM correspondant.

Définition à la ligne 50 du fichier CaseOptionBase.h.

Documentation des constructeurs et destructeur

◆ CaseOptionBase() [1/2]

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

protected

Définition à la ligne 93 du fichier CaseOptionBase.cc.

◆ ~CaseOptionBase()

Arcane::CaseOptionBase::~CaseOptionBase ( )

virtual

Définition à la ligne 103 du fichier CaseOptionBase.cc.

◆ CaseOptionBase() [2/2]

Arcane::CaseOptionBase::CaseOptionBase ( const CaseOptionBase & from )

privatedelete

Constructeur de copie.

Le constructeur par copie est privée car l'option ne doit pas être copiée, notamment à cause du ICaseFunction qui est unique.

Documentation des fonctions membres

◆ _checkIsInitialized()

void Arcane::CaseOptionBase::_checkIsInitialized ( ) const

protected

Définition à la ligne 347 du fichier CaseOptionBase.cc.

◆ _checkMinMaxOccurs()

void Arcane::CaseOptionBase::_checkMinMaxOccurs ( Integer nb_occur )

protected

Définition à la ligne 358 du fichier CaseOptionBase.cc.

◆ _defaultValue()

String Arcane::CaseOptionBase::_defaultValue ( ) const

protected

Retourne la valeur par défaut de l'option ou 0 s'il n'y en a pas.

Définition à la ligne 166 du fichier CaseOptionBase.cc.

Références m_p.

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

Voici le graphe des appelants de cette fonction :

◆ _isInitialized()

bool Arcane::CaseOptionBase::_isInitialized ( ) const

protected

Définition à la ligne 338 du fichier CaseOptionBase.cc.

◆ _search()

virtual void Arcane::CaseOptionBase::_search ( bool is_phase1 )

protectedpure virtual

◆ _setCategoryDefaultValue()

void Arcane::CaseOptionBase::_setCategoryDefaultValue ( )

private

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

◆ _setDefaultValue()

void Arcane::CaseOptionBase::_setDefaultValue ( const String & def_value )

protected

Définition à la ligne 175 du fichier CaseOptionBase.cc.

◆ _setIsInitialized()

void Arcane::CaseOptionBase::_setIsInitialized ( )

protected

Définition à la ligne 329 du fichier CaseOptionBase.cc.

◆ _setTranslatedName()

void Arcane::CaseOptionBase::_setTranslatedName ( )

private

Définition à la ligne 241 du fichier CaseOptionBase.cc.

◆ _xpathFullName()

String Arcane::CaseOptionBase::_xpathFullName ( ) const

protected

Définition à la ligne 399 du fichier CaseOptionBase.cc.

◆ addAlternativeNodeName()

void Arcane::CaseOptionBase::addAlternativeNodeName	(	const String &	lang,
		const String &	name )

Ajoute une traduction pour le nom de l'option.

Ajoute le nom name de l'option correspondant au langage lang. Si une traduction existe déjà pour ce langage, elle est remplacée par celle-ci.

Définition à la ligne 311 du fichier CaseOptionBase.cc.

Références m_p, et name().

Référencé par updateFromFunction().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ addDefaultValue()

void Arcane::CaseOptionBase::addDefaultValue	(	const String &	category,
		const String &	value )

Ajoute la valeur par défaut value à la catégorie category.

Définition à la ligne 320 du fichier CaseOptionBase.cc.

Références m_p.

Référencé par updateFromFunction().

Voici le graphe des appelants de cette fonction :

◆ caseDocument()

ICaseDocument * Arcane::CaseOptionBase::caseDocument ( ) const

Retourne le gestionnaire de document.

Définition à la ligne 148 du fichier CaseOptionBase.cc.

Références Arcane::ICaseMng::caseDocument(), et caseMng().

Référencé par print().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ caseDocumentFragment()

ICaseDocumentFragment * Arcane::CaseOptionBase::caseDocumentFragment ( ) const

Retourne le document associé à cette option.

Définition à la ligne 157 du fichier CaseOptionBase.cc.

Références m_p.

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

Voici le graphe des appelants de cette fonction :

◆ caseMng()

ICaseMng * Arcane::CaseOptionBase::caseMng ( ) const

Gestionnaire de cas.

Définition à la ligne 112 du fichier CaseOptionBase.cc.

Références m_p.

Référencé par Arcane::CaseOptionMultiExtended::_search(), Arcane::CaseOptionMultiSimpleT< T >::_search(), caseDocument(), print(), et Arcane::CaseOptionSimpleT< T >::updateFromFunction().

Voici le graphe des appelants de cette fonction :

◆ checkIsInitialized()

void Arcane::CaseOptionBase::checkIsInitialized ( ) const

inline

Lève une exception si l'option n'a pas été initialisée.

Définition à la ligne 141 du fichier CaseOptionBase.h.

Références checkIsInitialized().

Référencé par checkIsInitialized().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ function()

virtual ICaseFunction * Arcane::CaseOptionBase::function ( ) const

pure virtual

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

Implémenté dans Arcane::CaseOptionExtended, Arcane::CaseOptionMultiEnum, Arcane::CaseOptionMultiExtended, Arcane::CaseOptionMultiSimpleT< T >, Arcane::CaseOptionMultiSimpleT< Arcane::Integer >, Arcane::CaseOptionMultiSimpleT< Arcane::String >, et Arcane::CaseOptionSimple.

Références function(), isOptional(), maxOccurs(), et minOccurs().

Référencé par function().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ isOptional()

bool Arcane::CaseOptionBase::isOptional ( ) const

Permet de savoir si une option est optionnelle.

Définition à la ligne 232 du fichier CaseOptionBase.cc.

Références m_p.

Référencé par Arcane::CaseOptionMultiExtended::_search(), Arcane::CaseOptionMultiSimpleT< T >::_search(), et function().

Voici le graphe des appelants de cette fonction :

◆ maxOccurs()

Integer Arcane::CaseOptionBase::maxOccurs ( ) const

Nombre maximum d'occurences (pour une option multiple) (-1 == unbounded)

Définition à la ligne 223 du fichier CaseOptionBase.cc.

Références m_p.

Référencé par Arcane::CaseOptionMultiExtended::_search(), Arcane::CaseOptionMultiSimpleT< T >::_search(), et function().

Voici le graphe des appelants de cette fonction :

◆ minOccurs()

Integer Arcane::CaseOptionBase::minOccurs ( ) const

Nombre minimum d'occurences (pour une option multiple)

Définition à la ligne 214 du fichier CaseOptionBase.cc.

Références m_p.

Référencé par Arcane::CaseOptionMultiExtended::_search(), Arcane::CaseOptionMultiSimpleT< T >::_search(), et function().

Voici le graphe des appelants de cette fonction :

◆ name()

String Arcane::CaseOptionBase::name ( ) const

Retourne le nom de l'option correspondant au langage du jeu de données.

Définition à la ligne 205 du fichier CaseOptionBase.cc.

Références m_p.

Référencé par Arcane::CaseOptionExtended::_search(), Arcane::CaseOptionMultiExtended::_search(), Arcane::CaseOptionMultiSimpleT< T >::_search(), Arcane::CaseOptionSimpleT< T >::_search(), addAlternativeNodeName(), updateFromFunction(), Arcane::CaseOptionSimpleT< T >::updateFromFunction(), et Arcane::CaseOptionSimple::xpathFullName().

Voici le graphe des appelants de cette fonction :

◆ parentOptionList()

ICaseOptionList * Arcane::CaseOptionBase::parentOptionList ( ) const

OptionList parent.

Définition à la ligne 121 du fichier CaseOptionBase.cc.

Références m_p.

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

Voici le graphe des appelants de cette fonction :

◆ print()

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

pure virtual

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

Références caseDocument(), caseDocumentFragment(), caseMng(), parentOptionList(), rootElement(), setRootElement(), subDomain(), et traceMng().

Voici le graphe d'appel pour cette fonction :

◆ rootElement()

XmlNode Arcane::CaseOptionBase::rootElement ( ) const

Retourne l'élément racine du DOM.

Définition à la ligne 302 du fichier CaseOptionBase.cc.

Références m_p.

Référencé par Arcane::CaseOptionExtended::_search(), Arcane::CaseOptionMultiExtended::_search(), Arcane::CaseOptionMultiSimpleT< T >::_search(), Arcane::CaseOptionSimpleT< T >::_search(), print(), et Arcane::CaseOptionSimple::xpathFullName().

Voici le graphe des appelants de cette fonction :

◆ search()

void Arcane::CaseOptionBase::search ( bool is_phase1 )

Récupère la valeur du fichier de configuration pour la variable.

Définition à la ligne 185 du fichier CaseOptionBase.cc.

◆ setRootElement()

void Arcane::CaseOptionBase::setRootElement ( const XmlNode & root_element )

Positionne l'élément racine à root_element.

Définition à la ligne 293 du fichier CaseOptionBase.cc.

Références m_p.

Référencé par print().

Voici le graphe des appelants de cette fonction :

◆ subDomain()

ISubDomain * Arcane::CaseOptionBase::subDomain ( ) const

Gestionnaire de sous-domaine.

Définition à la ligne 139 du fichier CaseOptionBase.cc.

Références m_p.

Référencé par print().

Voici le graphe des appelants de cette fonction :

◆ traceMng()

ITraceMng * Arcane::CaseOptionBase::traceMng ( ) const

Gestionnaire de traces.

Définition à la ligne 130 du fichier CaseOptionBase.cc.

Références m_p.

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

Voici le graphe des appelants de cette fonction :

◆ translatedName()

String Arcane::CaseOptionBase::translatedName ( const String & lang ) const

Nom dans la langue lang de l'option. Retourne name() si pas de traduction.

Définition à la ligne 279 du fichier CaseOptionBase.cc.

Références m_p, et Arcane::String::null().

Voici le graphe d'appel pour cette fonction :

◆ trueName()

String Arcane::CaseOptionBase::trueName ( ) const

Retourne le vrai nom (non traduit) de l'option.

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

Références m_p.

◆ updateFromFunction()

virtual void Arcane::CaseOptionBase::updateFromFunction	(	Real	current_time,
		Integer	current_iteration )

pure virtual

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

Références addAlternativeNodeName(), addDefaultValue(), name(), et updateFromFunction().

Référencé par updateFromFunction().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ visit()

virtual void Arcane::CaseOptionBase::visit ( ICaseDocumentVisitor * visitor ) const

pure virtual

Applique le visiteur sur cette option.

Implémenté dans Arcane::CaseOptionEnum, Arcane::CaseOptionExtended, Arcane::CaseOptionMultiEnum, Arcane::CaseOptionMultiExtended, Arcane::CaseOptionMultiSimpleT< T >, Arcane::CaseOptionMultiSimpleT< Arcane::Integer >, Arcane::CaseOptionMultiSimpleT< Arcane::String >, et Arcane::CaseOptionSimple.

Références visit().

Référencé par visit().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

Documentation des données membres

◆ m_p

CaseOptionBasePrivate* Arcane::CaseOptionBase::m_p

private

Implémentation.

Définition à la ligne 161 du fichier CaseOptionBase.h.

Référencé par _defaultValue(), addAlternativeNodeName(), addDefaultValue(), caseDocumentFragment(), caseMng(), isOptional(), maxOccurs(), minOccurs(), name(), parentOptionList(), rootElement(), setRootElement(), subDomain(), traceMng(), translatedName(), et trueName().

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 privées

Attributs privés

Description détaillée

Documentation des constructeurs et destructeur

◆ CaseOptionBase() [1/2]

◆ ~CaseOptionBase()

◆ CaseOptionBase() [2/2]

Documentation des fonctions membres

◆ _checkIsInitialized()

◆ _checkMinMaxOccurs()

◆ _defaultValue()

◆ _isInitialized()

◆ _search()

◆ _setCategoryDefaultValue()

◆ _setDefaultValue()

◆ _setIsInitialized()

◆ _setTranslatedName()

◆ _xpathFullName()

◆ addAlternativeNodeName()

◆ addDefaultValue()

◆ caseDocument()

◆ caseDocumentFragment()

◆ caseMng()

◆ checkIsInitialized()

◆ function()

◆ isOptional()

◆ maxOccurs()

◆ minOccurs()

◆ name()

◆ parentOptionList()

◆ print()

◆ rootElement()

◆ search()

◆ setRootElement()

◆ subDomain()

◆ traceMng()

◆ translatedName()

◆ trueName()

◆ updateFromFunction()

◆ visit()

Documentation des données membres

◆ m_p