Arcane  v3.16.0.0
Documentation développeur
Chargement...
Recherche...
Aucune correspondance
Référence de la classe Arcane::ICaseOptionsabstract

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 IServiceInfocaseServiceInfo () const =0
 Retourne le service associé ou nullptr s'il n'y en a pas.
 
virtual IModulecaseModule () 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 ICaseOptionListconfigList ()=0
 
virtual const ICaseOptionListconfigList () const =0
 
virtual ICaseFunctionactivateFunction ()=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 ICaseMngcaseMng () const =0
 
virtual ITraceMngtraceMng () const =0
 
virtual ISubDomainsubDomain () const =0
 Sous-domain associé.
 
virtual IMeshmesh () const =0
 
virtual MeshHandle meshHandle () const =0
 
virtual ICaseDocumentcaseDocument () const =0
 
virtual ICaseDocumentFragmentcaseDocumentFragment () 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< ICaseOptionstoReference ()=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.

Références activateFunction().

Référencé par activateFunction(), et Arcane::TimeLoopMng::doOneIteration().

+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

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

Références addAlternativeNodeName().

Référencé par addAlternativeNodeName().

+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

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

Référencé par caseModule(), Arcane::TimeLoopMng::doOneIteration(), et Arcane::SubDomain::dumpInternalInfos().

+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

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

Référencé par caseServiceInfo().

+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ deepGetChildren()

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

Ajoute à la liste col tous les options filles.

Implémenté dans Arcane::CaseOptions.

Références deepGetChildren().

Référencé par deepGetChildren().

+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ detach()

virtual void Arcane::ICaseOptions::detach ( )
pure virtual

Détache l'option de son parent.

Implémenté dans Arcane::CaseOptions.

Références detach().

Référencé par detach().

+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

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

Références isPresent().

Référencé par isPresent().

+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ 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::CaseOptionList::addChild(), Arcane::SubDomain::dumpInternalInfos(), Arcane::CaseMng::registerOptions(), et Arcane::CaseOptionList::removeChild().

+ Voici le graphe des appelants de cette fonction :

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

Références setCaseModule().

Référencé par setCaseModule().

+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ setCaseServiceInfo()

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

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

Implémenté dans Arcane::CaseOptions.

Références setCaseServiceInfo().

Référencé par setCaseServiceInfo().

+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

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

Références subDomain().

Référencé par subDomain().

+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ 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::CaseOptionMultiServiceImpl, Arcane::CaseOptions, et Arcane::CaseOptionServiceImpl.

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 :

◆ xpathFullName()

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

Nom complet au format XPath correspondant à rootElement()

Implémenté dans Arcane::CaseOptions.

Références xpathFullName().

Référencé par xpathFullName().

+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

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