Référence de la classe Arcane::ICaseOptions

Interface d'une liste d'options du jeu de données. Plus de détails...

#include <arcane/core/ICaseOptions.h>

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

Graphe de collaboration de Arcane::ICaseOptions:

Fonctions membres publiques
virtual String	rootTagTrueName () const =0
	Vrai nom (non traduit) de l'élément.
virtual String	rootTagName () const =0
	Nom de l'élément dans le langage du jeu de données.
virtual String	translatedName (const String &lang) const =0
	Nom dans la langue lang de l'option. Retourne rootTagTrueName() si pas de traduction.
virtual void	read (bool is_phase1)=0
virtual void	read (eCaseOptionReadPhase read_phase)=0
	Effectue la lecture de la phase read_phase des options.
virtual void	addInvalidChildren (XmlNodeList &)=0
virtual void	printChildren (const String &lang, int indent)=0
virtual IServiceInfo *	caseServiceInfo () const =0
	Retourne le service associé ou nullptr s'il n'y en a pas.
virtual IModule *	caseModule () const =0
	Retourne le module associé ou nullptr s'il n'y en a pas.
virtual void	setCaseServiceInfo (IServiceInfo *m)=0
	Associe le service m à ce jeu de données.
virtual void	setCaseModule (IModule *m)=0
	Associe le module m à ce jeu de données.
virtual void	deepGetChildren (Array< CaseOptionBase * > &col)=0
	Ajoute à la liste col tous les options filles.
virtual ICaseOptionList *	configList ()=0
virtual const ICaseOptionList *	configList () const =0
virtual ICaseFunction *	activateFunction ()=0
	Fonction indiquant l'état d'activation de l'option.
virtual bool	isPresent () const =0
	Indique si l'option est présente dans le jeu de données.
virtual void	addAlternativeNodeName (const String &lang, const String &name)=0
	Ajoute une traduction pour le nom de l'option.
virtual ICaseMng *	caseMng () const =0
virtual ITraceMng *	traceMng () const =0
virtual ISubDomain *	subDomain () const =0
	Sous-domain associé.
	ARCCORE_DEPRECATED_2019 ("Use meshHandle().mesh() instead") virtual IMesh *mesh() const =0
virtual MeshHandle	meshHandle () const =0
	ARCANE_DEPRECATED_REASON ("Y2023: use caseMng()->caseDocument() instead.") virtual ICaseDocument *caseDocument() const =0
virtual ICaseDocumentFragment *	caseDocumentFragment () const =0
virtual void	detach ()=0
virtual void	visit (ICaseDocumentVisitor *visitor) const =0
	Applique le visiteur sur cette option.
virtual String	xpathFullName () const =0
	Nom complet au format XPath correspondant à rootElement()
virtual Ref< ICaseOptions >	toReference ()=0

Fonctions membres privées
	ARCCORE_DECLARE_REFERENCE_COUNTED_INCLASS_METHODS ()

Description détaillée

Interface d'une liste d'options du jeu de données.

Cette interface est gérée par un compteur de référence et ne doit pas être détruite explictement.

Définition à la ligne 34 du fichier ICaseOptions.h.

Documentation des fonctions membres

activateFunction()

virtual ICaseFunction * Arcane::ICaseOptions::activateFunction ( )

pure virtual

Fonction indiquant l'état d'activation de l'option.

Implémenté dans Arcane::CaseOptions.

addAlternativeNodeName()

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

pure virtual

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.

Implémenté dans Arcane::CaseOptions.

addInvalidChildren()

virtual void Arcane::ICaseOptions::addInvalidChildren ( XmlNodeList &  )

pure virtual

Implémenté dans Arcane::CaseOptions.

caseModule()

virtual IModule * Arcane::ICaseOptions::caseModule ( ) const

pure virtual

Retourne le module associé ou nullptr s'il n'y en a pas.

Implémenté dans Arcane::CaseOptions.

Référencé par Arcane::SubDomain::dumpInternalInfos().

caseServiceInfo()

virtual IServiceInfo * Arcane::ICaseOptions::caseServiceInfo ( ) const

pure virtual

Retourne le service associé ou nullptr s'il n'y en a pas.

Implémenté dans Arcane::CaseOptions.

Référencé par Arcane::CaseOptionList::printChildren().

deepGetChildren()

virtual void Arcane::ICaseOptions::deepGetChildren ( Array< CaseOptionBase * > &  col )

pure virtual

Ajoute à la liste col tous les options filles.

Implémenté dans Arcane::CaseOptions.

detach()

virtual void Arcane::ICaseOptions::detach ( )

pure virtual

Détache l'option de son parent.

Implémenté dans Arcane::CaseOptions.

isPresent()

virtual bool Arcane::ICaseOptions::isPresent ( ) const

pure virtual

Indique si l'option est présente dans le jeu de données.

Une option peut ne pas apparaître si elle ne contient que des options ayant une valeur par défaut.

Implémenté dans Arcane::CaseOptions.

read()

virtual void Arcane::ICaseOptions::read ( eCaseOptionReadPhase  read_phase )

pure virtual

Effectue la lecture de la phase read_phase des options.

Implémenté dans Arcane::CaseOptions, et Arcane::CaseOptionServiceImpl.

rootTagName()

virtual String Arcane::ICaseOptions::rootTagName ( ) const

pure virtual

Nom de l'élément dans le langage du jeu de données.

Implémenté dans Arcane::CaseOptions.

Référencé par Arcane::SubDomain::dumpInternalInfos(), et Arcane::CaseOptionList::rootTagName().

rootTagTrueName()

virtual String Arcane::ICaseOptions::rootTagTrueName ( ) const

pure virtual

Vrai nom (non traduit) de l'élément.

Implémenté dans Arcane::CaseOptions.

setCaseModule()

virtual void Arcane::ICaseOptions::setCaseModule ( IModule *  m )

pure virtual

Associe le module m à ce jeu de données.

Implémenté dans Arcane::CaseOptions.

setCaseServiceInfo()

virtual void Arcane::ICaseOptions::setCaseServiceInfo ( IServiceInfo *  m )

pure virtual

Associe le service m à ce jeu de données.

Implémenté dans Arcane::CaseOptions.

subDomain()

virtual ISubDomain * Arcane::ICaseOptions::subDomain ( ) const

pure virtual

Sous-domain associé.

Obsolète:

Ne plus utiliser cette méthode car à terme une option pourra exister sans sous-domaine.

Implémenté dans Arcane::CaseOptions.

translatedName()

virtual String Arcane::ICaseOptions::translatedName ( const String &  lang ) const

pure virtual

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

Implémenté dans Arcane::CaseOptions.

visit()

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

pure virtual

Applique le visiteur sur cette option.

Implémenté dans Arcane::CaseOptions, Arcane::CaseOptionServiceImpl, et Arcane::CaseOptionMultiServiceImpl.

xpathFullName()

virtual String Arcane::ICaseOptions::xpathFullName ( ) const

pure virtual

Nom complet au format XPath correspondant à rootElement()

Implémenté dans Arcane::CaseOptions.

---

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

• ICaseOptions.h