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)

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

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

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

protected

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

◆ ~CaseOptionBase()

Arcane::CaseOptionBase::~CaseOptionBase ( )

virtual

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

Documentation des fonctions membres

◆ _checkIsInitialized()

void Arcane::CaseOptionBase::_checkIsInitialized ( ) const

protected

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

◆ _checkMinMaxOccurs()

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

protected

Définition à la ligne 347 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 164 du fichier CaseOptionBase.cc.

Références Arcane::CaseOptionBasePrivate::m_default_value.

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

◆ _isInitialized()

bool Arcane::CaseOptionBase::_isInitialized ( ) const

protected

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

◆ _search()

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

protectedpure virtual

Implémenté dans Arcane::CaseOptionSimpleT< T >, Arcane::CaseOptionSimpleT< bool >, Arcane::CaseOptionSimpleT< Integer >, Arcane::CaseOptionExtended, Arcane::CaseOptionMultiExtended, et Arcane::CaseOptionMultiSimpleT< T >.

◆ _setDefaultValue()

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

protected

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

◆ _setIsInitialized()

void Arcane::CaseOptionBase::_setIsInitialized ( )

protected

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

◆ _xpathFullName()

String Arcane::CaseOptionBase::_xpathFullName ( ) const

protected

Définition à la ligne 383 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 300 du fichier CaseOptionBase.cc.

Références Arcane::StringDictionary::add(), Arcane::CaseOptionBasePrivate::m_name_translations, et name().

◆ 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 309 du fichier CaseOptionBase.cc.

Références Arcane::StringDictionary::add(), et Arcane::CaseOptionBasePrivate::m_default_values.

◆ caseDocument()

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

Retourne le gestionnaire de document.

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

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

◆ caseDocumentFragment()

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

Retourne le document associé à cette option.

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

Références Arcane::CaseOptionBasePrivate::m_case_document_fragment.

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

◆ caseMng()

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

Gestionnaire de cas.

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

Références Arcane::CaseOptionBasePrivate::m_case_mng.

Référencé par caseDocument().

◆ checkIsInitialized()

void Arcane::CaseOptionBase::checkIsInitialized ( ) const

inline

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

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

◆ 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::CaseOptionMultiEnum, Arcane::CaseOptionExtended, Arcane::CaseOptionMultiExtended, Arcane::CaseOptionSimple, et Arcane::CaseOptionMultiSimpleT< T >.

◆ maxOccurs()

Integer Arcane::CaseOptionBase::maxOccurs ( ) const

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

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

Références Arcane::CaseOptionBasePrivate::m_max_occurs.

◆ minOccurs()

Integer Arcane::CaseOptionBase::minOccurs ( ) const

Nombre minimum d'occurences (pour une option multiple)

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

Références Arcane::CaseOptionBasePrivate::m_min_occurs.

◆ name()

String Arcane::CaseOptionBase::name ( ) const

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

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

Références Arcane::CaseOptionBasePrivate::m_name.

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

◆ parentOptionList()

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

OptionList parent.

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

Références Arcane::CaseOptionBasePrivate::m_parent_option_list.

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

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

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

◆ rootElement()

XmlNode Arcane::CaseOptionBase::rootElement ( ) const

Retourne l'élément racine du DOM.

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

Références Arcane::CaseOptionBasePrivate::m_root_element.

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

◆ search()

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

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

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

◆ setRootElement()

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

Positionne l'élément racine à root_element.

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

Références Arcane::CaseOptionBasePrivate::m_root_element.

◆ subDomain()

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

Gestionnaire de sous-domaine.

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

Références Arcane::CaseOptionBasePrivate::m_case_mng, et Arcane::ICaseMng::subDomain().

◆ traceMng()

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

Gestionnaire de traces.

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

Références Arcane::CaseOptionBasePrivate::m_case_mng, et Arcane::ICaseMng::traceMng().

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

◆ 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 268 du fichier CaseOptionBase.cc.

Références Arcane::StringDictionary::find(), Arcane::CaseOptionBasePrivate::m_name, Arcane::CaseOptionBasePrivate::m_name_translations, et Arccore::String::null().

◆ trueName()

String Arcane::CaseOptionBase::trueName ( ) const

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

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

Références Arcane::CaseOptionBasePrivate::m_true_name.

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

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

◆ visit()

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

pure virtual

Applique le visiteur sur cette option.

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

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

Fonctions membres publiques

Fonctions membres protégées

Description détaillée

Documentation des constructeurs et destructeur

◆ CaseOptionBase()

◆ ~CaseOptionBase()

Documentation des fonctions membres

◆ _checkIsInitialized()

◆ _checkMinMaxOccurs()

◆ _defaultValue()

◆ _isInitialized()

◆ _search()

◆ _setDefaultValue()

◆ _setIsInitialized()

◆ _xpathFullName()

◆ addAlternativeNodeName()

◆ addDefaultValue()

◆ caseDocument()

◆ caseDocumentFragment()

◆ caseMng()

◆ checkIsInitialized()

◆ function()

◆ maxOccurs()

◆ minOccurs()

◆ name()

◆ parentOptionList()

◆ print()

◆ rootElement()

◆ search()

◆ setRootElement()

◆ subDomain()

◆ traceMng()

◆ translatedName()

◆ trueName()

◆ updateFromFunction()

◆ visit()