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

Classe de base d'une option service pouvant être présente plusieurs fois. Plus de détails...

#include <arcane/core/CaseOptionServiceImpl.h>

+ Graphe d'héritage de Arcane::CaseOptionMultiServiceImpl:
+ Graphe de collaboration de Arcane::CaseOptionMultiServiceImpl:

Fonctions membres publiques

 CaseOptionMultiServiceImpl (const CaseOptionBuildInfo &cob, bool allow_null)
 
void getAvailableNames (StringArray &names) const
 Retourne dans names les noms d'implémentations valides pour ce service.
 
String serviceName (Integer index) const
 Nom du n-ième service.
 
void multiAllocate (const XmlNodeList &) override
 
void visit (ICaseDocumentVisitor *visitor) const override
 Applique le visiteur sur cette option.
 
void setContainer (ICaseOptionServiceContainer *container)
 Positionne le conteneur d'instances.
 
void setMeshName (const String &mesh_name)
 
String meshName () const
 
void _setNotifyAllocateFunctor (IFunctor *f)
 
- Fonctions membres publiques hérités de Arcane::CaseOptionsMulti
 CaseOptionsMulti (ICaseMng *, const String &tag_root_name, const XmlNode &element, Integer min_occurs, Integer max_occurs)
 
 CaseOptionsMulti (ICaseOptionList *, const String &tag_root_name, const XmlNode &element, Integer min_occurs, Integer max_occurs)
 
ICaseOptionstoCaseOptions () override
 
void addChild (ICaseOptionList *v) override
 
Integer nbChildren () const override
 
ICaseOptionListchild (Integer index) const override
 
ICaseOptionsMultitoCaseOptionsMulti ()
 
- Fonctions membres publiques hérités de Arcane::CaseOptions
 CaseOptions (ICaseMng *cm, const String &name)
 Construit un jeu d'options.
 
 CaseOptions (ICaseOptionList *, const String &name)
 Construit un jeu d'options.
 
 CaseOptions (ICaseMng *cm, const String &name, const XmlNode &parent)
 Construit un jeu d'options.
 
 CaseOptions (ICaseOptionList *, const String &name, const XmlNode &parent, bool is_optional=false, bool is_multi=false)
 Construit un jeu d'options.
 
 ~CaseOptions () override
 Libère les ressources.
 
String rootTagTrueName () const override
 Retourne le vrai nom (non traduit) de l'élément.
 
String rootTagName () const override
 Retourne le nom de l'élément dans le langage du jeu de données.
 
String translatedName (const String &lang) const override
 Nom dans la langue lang de l'option. Retourne rootTagTrueName() si pas de traduction.
 
virtual String trueName () const
 Retourne le vrai nom (non traduit) de l'élément.
 
virtual String name () const
 Retourne le nom de l'élément dans le langage du jeu de données.
 
void read (bool is_phase1) override
 
void read (eCaseOptionReadPhase phase) override
 Effectue la lecture de la phase read_phase des options.
 
void addInvalidChildren (XmlNodeList &) override
 Ajoute à nlist les éléments non reconnus.
 
void printChildren (const String &lang, int indent) override
 
IServiceInfocaseServiceInfo () const override
 Retourne le service associé ou 0 s'il n'y en a pas.
 
IModulecaseModule () const override
 Retourne le module associé ou 0 s'il n'y en a pas.
 
void setCaseServiceInfo (IServiceInfo *m) override
 Associe le service m à ce jeu de données.
 
void setCaseModule (IModule *m) override
 Associe le module m à ce jeu de données.
 
void deepGetChildren (Array< CaseOptionBase * > &col) override
 Ajoute à la liste col tous les options filles.
 
ICaseOptionListconfigList () override
 
const ICaseOptionListconfigList () const override
 
ICaseFunctionactivateFunction () override
 Fonction indiquant l'état d'activation de l'option.
 
bool isPresent () const override
 Vrai si l'option est présente dans le fichier, faux s'il s'agit de la valeur par défaut.
 
void addAlternativeNodeName (const String &lang, const String &name) override
 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.
 
ICaseMngcaseMng () const override
 
ITraceMngtraceMng () const override
 
ISubDomainsubDomain () const override
 Sous-domain associé.
 
IMeshmesh () const override
 
MeshHandle meshHandle () const override
 
ICaseDocumentcaseDocument () const override
 
ICaseDocumentFragmentcaseDocumentFragment () const override
 
void detach () override
 
void visit (ICaseDocumentVisitor *visitor) const override
 Applique le visiteur sur cette option.
 
String xpathFullName () const override
 Nom complet au format XPath correspondant à rootElement()
 
Ref< ICaseOptionstoReference () override
 
- Fonctions membres publiques hérités de Arcane::ICaseOptions
 ARCCORE_DEPRECATED_2019 ("Use meshHandle().mesh() instead") virtual IMesh *mesh() const =0
 
 ARCANE_DEPRECATED_REASON ("Y2023: use caseMng()->caseDocument() instead.") virtual ICaseDocument *caseDocument() const =0
 

Fonctions membres protégées

String _defaultValue () const
 
- Fonctions membres protégées hérités de Arcane::CaseOptions
 CaseOptions (ICaseMng *, const String &name, ICaseOptionList *parent)
 Construit un jeu d'options.
 
 CaseOptions (ICaseOptionList *, const String &name, ICaseOptionList *parent)
 Construit un jeu d'options.
 
void _setTranslatedName ()
 
bool _setMeshHandleAndCheckDisabled (const String &mesh_name)
 Positionne le maillage associé à cette option.
 

Attributs protégés

bool m_allow_null
 
String m_default_value
 
String m_mesh_name
 
IFunctorm_notify_functor
 
ICaseOptionServiceContainerm_container
 
UniqueArray< ReferenceCounter< ICaseOptions > > m_allocated_options
 Liste des options allouées qu'il faudra supprimer.
 
UniqueArray< Stringm_services_name
 Noms du service pour chaque occurence.
 
- Attributs protégés hérités de Arcane::CaseOptions
CaseOptionsPrivatem_p
 Implémentation.
 

Description détaillée

Classe de base d'une option service pouvant être présente plusieurs fois.

Il faut appeler setContainer() pour positionner un conteneur avant d'utiliser cette classe.

Définition à la ligne 129 du fichier CaseOptionServiceImpl.h.

Documentation des constructeurs et destructeur

◆ CaseOptionMultiServiceImpl()

Arcane::CaseOptionMultiServiceImpl::CaseOptionMultiServiceImpl ( const CaseOptionBuildInfo cob,
bool  allow_null 
)

Définition à la ligne 301 du fichier CaseOptionService.cc.

◆ ~CaseOptionMultiServiceImpl()

Arcane::CaseOptionMultiServiceImpl::~CaseOptionMultiServiceImpl ( )

Définition à la ligne 314 du fichier CaseOptionService.cc.

Documentation des fonctions membres

◆ _defaultValue()

String Arcane::CaseOptionMultiServiceImpl::_defaultValue ( ) const
inlineprotected

Définition à la ligne 169 du fichier CaseOptionServiceImpl.h.

◆ _setNotifyAllocateFunctor()

void Arcane::CaseOptionMultiServiceImpl::_setNotifyAllocateFunctor ( IFunctor f)
inline

Définition à la ligne 162 du fichier CaseOptionServiceImpl.h.

◆ getAvailableNames()

void Arcane::CaseOptionMultiServiceImpl::getAvailableNames ( StringArray names) const

Retourne dans names les noms d'implémentations valides pour ce service.

Définition à la ligne 413 du fichier CaseOptionService.cc.

◆ meshName()

String Arcane::CaseOptionMultiServiceImpl::meshName ( ) const
inline

Définition à la ligne 158 du fichier CaseOptionServiceImpl.h.

◆ multiAllocate()

void Arcane::CaseOptionMultiServiceImpl::multiAllocate ( const XmlNodeList elem_list)
overridevirtual

Implémente Arcane::ICaseOptionsMulti.

Définition à la ligne 346 du fichier CaseOptionService.cc.

◆ serviceName()

String Arcane::CaseOptionMultiServiceImpl::serviceName ( Integer  index) const
inline

Nom du n-ième service.

Définition à la ligne 142 du fichier CaseOptionServiceImpl.h.

◆ setContainer()

void Arcane::CaseOptionMultiServiceImpl::setContainer ( ICaseOptionServiceContainer container)

Positionne le conteneur d'instances.

container reste la propriété de l'appelant qui doit gérer sa durée de vie.

Définition à la ligne 322 du fichier CaseOptionService.cc.

◆ setMeshName()

void Arcane::CaseOptionMultiServiceImpl::setMeshName ( const String mesh_name)
inline

Définition à la ligne 157 du fichier CaseOptionServiceImpl.h.

◆ visit()

void Arcane::CaseOptionMultiServiceImpl::visit ( ICaseDocumentVisitor visitor) const
overridevirtual

Applique le visiteur sur cette option.

Implémente Arcane::ICaseOptions.

Définition à la ligne 331 du fichier CaseOptionService.cc.

Références m_allocated_options.

Documentation des données membres

◆ m_allocated_options

UniqueArray<ReferenceCounter<ICaseOptions> > Arcane::CaseOptionMultiServiceImpl::m_allocated_options
protected

Liste des options allouées qu'il faudra supprimer.

Définition à la ligne 179 du fichier CaseOptionServiceImpl.h.

Référencé par visit().

◆ m_allow_null

bool Arcane::CaseOptionMultiServiceImpl::m_allow_null
protected

Définition à la ligne 173 du fichier CaseOptionServiceImpl.h.

◆ m_container

ICaseOptionServiceContainer* Arcane::CaseOptionMultiServiceImpl::m_container
protected

Définition à la ligne 177 du fichier CaseOptionServiceImpl.h.

◆ m_default_value

String Arcane::CaseOptionMultiServiceImpl::m_default_value
protected

Définition à la ligne 174 du fichier CaseOptionServiceImpl.h.

◆ m_mesh_name

String Arcane::CaseOptionMultiServiceImpl::m_mesh_name
protected

Définition à la ligne 175 du fichier CaseOptionServiceImpl.h.

◆ m_notify_functor

IFunctor* Arcane::CaseOptionMultiServiceImpl::m_notify_functor
protected

Définition à la ligne 176 du fichier CaseOptionServiceImpl.h.

◆ m_services_name

UniqueArray<String> Arcane::CaseOptionMultiServiceImpl::m_services_name
protected

Noms du service pour chaque occurence.

Définition à la ligne 181 du fichier CaseOptionServiceImpl.h.


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