Classe de base de l'implémentation des options utilisant des services. Plus de détails...

#include <arcane/core/CaseOptionServiceImpl.h>

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

Graphe de collaboration de Arcane::CaseOptionServiceImpl:

Fonctions membres publiques
	CaseOptionServiceImpl (const CaseOptionBuildInfo &cob, bool allow_null, bool is_optional)

void	read (eCaseOptionReadPhase phase) override
	Effectue la lecture de la phase read_phase des options.

String	serviceName () const

bool	isOptional () const

virtual void	getAvailableNames (StringArray &names) const
	Retourne dans names les noms d'implémentations valides pour ce service.

void	visit (ICaseDocumentVisitor *visitor) const override
	Applique le visiteur sur cette option.

void	setDefaultValue (const String &def_value)

void	addDefaultValue (const String &category, const String &value)

void	setContainer (ICaseOptionServiceContainer *container)
	Positionne le conteneur d'instances.

void	setMeshName (const String &mesh_name)

String	meshName () const

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	addInvalidChildren (XmlNodeList &) override
	Ajoute à nlist les éléments non reconnus.

void	printChildren (const String &lang, int indent) override

IServiceInfo *	caseServiceInfo () const override
	Retourne le service associé ou 0 s'il n'y en a pas.

IModule *	caseModule () 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.

ICaseOptionList *	configList () override

const ICaseOptionList *	configList () const override

ICaseFunction *	activateFunction () 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.

ICaseMng *	caseMng () const override

ITraceMng *	traceMng () const override

ISubDomain *	subDomain () const override
	Sous-domain associé.

IMesh *	mesh () const override

MeshHandle	meshHandle () const override

ICaseDocument *	caseDocument () const override

ICaseDocumentFragment *	caseDocumentFragment () const override

void	detach () override

String	xpathFullName () const override
	Nom complet au format XPath correspondant à rootElement()

Ref< ICaseOptions >	toReference () 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
virtual void	print (const String &lang, std::ostream &o) const

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.

Fonctions membres privées
void	_readPhase1 ()

Attributs privés
String	m_name

String	m_default_value

String	m_service_name

String	m_mesh_name

XmlNode	m_element
	Element de l'option.

bool	m_allow_null

bool	m_is_optional

bool	m_is_override_default

StringDictionary	m_default_values
	Liste des valeurs par défaut par catégorie.

ICaseOptionServiceContainer *	m_container

Membres hérités additionnels
Attributs protégés hérités de Arcane::CaseOptions
CaseOptionsPrivate *	m_p
	Implémentation.

Description détaillée

Classe de base de l'implémentation des options utilisant des services.

Cette classe est interne à Arcane. La classe à utiliser est 'CaseOptionService'.

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

Documentation des constructeurs et destructeur

◆ CaseOptionServiceImpl()

Arcane::CaseOptionServiceImpl::CaseOptionServiceImpl	(	const CaseOptionBuildInfo &	cob,
		bool	allow_null,
		bool	is_optional
	)

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

Documentation des fonctions membres

◆ _defaultValue()

String Arcane::CaseOptionServiceImpl::_defaultValue ( ) const

inlineprotected

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

◆ _readPhase1()

void Arcane::CaseOptionServiceImpl::_readPhase1 ( )

private

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

◆ addDefaultValue()

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

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

◆ getAvailableNames()

void Arcane::CaseOptionServiceImpl::getAvailableNames ( StringArray & names ) const

virtual

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

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

◆ isOptional()

bool Arcane::CaseOptionServiceImpl::isOptional ( ) const

inline

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

◆ meshName()

String Arcane::CaseOptionServiceImpl::meshName ( ) const

inline

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

◆ print()

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

protectedvirtual

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

◆ read()

void Arcane::CaseOptionServiceImpl::read ( eCaseOptionReadPhase read_phase )

overridevirtual

Effectue la lecture de la phase read_phase des options.

Réimplémentée à partir de Arcane::CaseOptions.

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

◆ serviceName()

String Arcane::CaseOptionServiceImpl::serviceName ( ) const

inline

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

◆ setContainer()

void Arcane::CaseOptionServiceImpl::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 159 du fichier CaseOptionService.cc.

◆ setDefaultValue()

void Arcane::CaseOptionServiceImpl::setDefaultValue ( const String & def_value )

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

◆ setMeshName()

void Arcane::CaseOptionServiceImpl::setMeshName ( const String & mesh_name )

inline

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

◆ visit()

void Arcane::CaseOptionServiceImpl::visit ( ICaseDocumentVisitor * visitor ) const

overridevirtual

Applique le visiteur sur cette option.

Réimplémentée à partir de Arcane::CaseOptions.

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

Références Arcane::CaseOptions::visit().

Documentation des données membres

◆ m_allow_null

bool Arcane::CaseOptionServiceImpl::m_allow_null

private

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

◆ m_container

ICaseOptionServiceContainer* Arcane::CaseOptionServiceImpl::m_container

private

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

◆ m_default_value

String Arcane::CaseOptionServiceImpl::m_default_value

private

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

◆ m_default_values

StringDictionary Arcane::CaseOptionServiceImpl::m_default_values

private

Liste des valeurs par défaut par catégorie.

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

◆ m_element

XmlNode Arcane::CaseOptionServiceImpl::m_element

private

Element de l'option.

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

◆ m_is_optional

bool Arcane::CaseOptionServiceImpl::m_is_optional

private

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

◆ m_is_override_default

bool Arcane::CaseOptionServiceImpl::m_is_override_default

private

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

◆ m_mesh_name

String Arcane::CaseOptionServiceImpl::m_mesh_name

private

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

◆ m_name

String Arcane::CaseOptionServiceImpl::m_name

private

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

◆ m_service_name

String Arcane::CaseOptionServiceImpl::m_service_name

private

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

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

Membres hérités additionnels

Description détaillée

Documentation des constructeurs et destructeur

◆ CaseOptionServiceImpl()

Documentation des fonctions membres

◆ _defaultValue()

◆ _readPhase1()

◆ addDefaultValue()

◆ getAvailableNames()

◆ isOptional()

◆ meshName()

◆ print()

◆ read()

◆ serviceName()

◆ setContainer()

◆ setDefaultValue()

◆ setMeshName()

◆ visit()

Documentation des données membres

◆ m_allow_null

◆ m_container

◆ m_default_value

◆ m_default_values

◆ m_element

◆ m_is_optional

◆ m_is_override_default

◆ m_mesh_name

◆ m_name

◆ m_service_name