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

Graphe de collaboration de Arcane::CaseOptions:

Fonctions membres publiques
	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

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

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

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

Ref< ICaseOptions >	toReference () override

Fonctions membres protégées
	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
CaseOptionsPrivate *	m_p
	Implémentation.

Amis
class	ServiceBuilderWithOptionsBase

Description détaillée

Définition à la ligne 54 du fichier CaseOptions.h.

Documentation des constructeurs et destructeur

◆ CaseOptions() [1/6]

Arcane::CaseOptions::CaseOptions	(	ICaseMng *	cm,
		const String &	name
	)

Construit un jeu d'options.

Définition à la ligne 105 du fichier CaseOptions.cc.

Références m_p, et Arcane::ICaseMng::registerOptions().

◆ CaseOptions() [2/6]

Arcane::CaseOptions::CaseOptions	(	ICaseOptionList *	parent,
		const String &	name
	)

Construit un jeu d'options.

Définition à la ligne 117 du fichier CaseOptions.cc.

Références m_p.

◆ CaseOptions() [3/6]

Arcane::CaseOptions::CaseOptions	(	ICaseMng *	cm,
		const String &	name,
		const XmlNode &	parent
	)

Construit un jeu d'options.

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

Références m_p, et Arcane::ICaseMng::registerOptions().

◆ CaseOptions() [4/6]

Arcane::CaseOptions::CaseOptions	(	ICaseOptionList *	parent,
		const String &	name,
		const XmlNode &	parent,
		bool	is_optional = `false`,
		bool	is_multi = `false`
	)

Construit un jeu d'options.

Définition à la ligne 140 du fichier CaseOptions.cc.

Références m_p.

◆ CaseOptions() [5/6]

Arcane::CaseOptions::CaseOptions	(	ICaseMng *	cm,
		const String &	name,
		ICaseOptionList *	parent
	)

protected

Construit un jeu d'options.

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

Références m_p, et Arcane::ICaseMng::registerOptions().

◆ CaseOptions() [6/6]

Arcane::CaseOptions::CaseOptions	(	ICaseOptionList *	parent,
		const String &	name,
		ICaseOptionList *	parent
	)

protected

Construit un jeu d'options.

Définition à la ligne 167 du fichier CaseOptions.cc.

Références m_p.

◆ ~CaseOptions()

Arcane::CaseOptions::~CaseOptions ( )

override

Libère les ressources.

Définition à la ligne 196 du fichier CaseOptions.cc.

Références m_p, et Arcane::ICaseMng::unregisterOptions().

Documentation des fonctions membres

◆ _setMeshHandleAndCheckDisabled()

bool Arcane::CaseOptions::_setMeshHandleAndCheckDisabled ( const String & mesh_name )

protected

Positionne le maillage associé à cette option.

Si mesh_name est nul ou vide alors le maillage associé à cette option est celui de l'option parente. Si l'option n'a pas de parent alors c'est le maillage par défaut.

Si mesh_name n'est pas nul, il y a deux possibilités:

si le maillage spécifié existe alors l'option sera associée à ce maillage
s'il n'existe pas, alors l'option est désactivée et les éventuelles options filles ne seront pas lues. Ce dernier cas arrive par exemple si un service est associé à un maillage supplémentaire mais que ce dernier est optionnel. Dans ce cas l'option ne doit pas être lue.

Valeurs retournées

true	si l'option est désactivée suite à cet appel.

Définition à la ligne 431 du fichier CaseOptions.cc.

Références Arccore::String::empty(), Arcane::IMeshMng::findMeshHandle(), m_p, Arcane::ICaseOptionList::meshHandle(), et Arcane::ICaseMng::meshMng().

◆ _setTranslatedName()

void Arcane::CaseOptions::_setTranslatedName ( )

protected

Définition à la ligne 457 du fichier CaseOptions.cc.

◆ activateFunction()

ICaseFunction * Arcane::CaseOptions::activateFunction ( )

overridevirtual

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

Implémente Arcane::ICaseOptions.

Définition à la ligne 491 du fichier CaseOptions.cc.

Références Arcane::CaseOptionsPrivate::m_activate_function, et m_p.

◆ addAlternativeNodeName()

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

overridevirtual

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émente Arcane::ICaseOptions.

Définition à la ligne 259 du fichier CaseOptions.cc.

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

◆ addInvalidChildren()

void Arcane::CaseOptions::addInvalidChildren ( XmlNodeList & nlist )

overridevirtual

Ajoute à nlist les éléments non reconnus.

Implémente Arcane::ICaseOptions.

Définition à la ligne 558 du fichier CaseOptions.cc.

Références m_p.

◆ caseDocument()

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

overridevirtual

Implémente Arcane::ICaseOptions.

Définition à la ligne 374 du fichier CaseOptions.cc.

◆ caseDocumentFragment()

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

overridevirtual

Implémente Arcane::ICaseOptions.

Définition à la ligne 383 du fichier CaseOptions.cc.

◆ caseMng()

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

overridevirtual

Implémente Arcane::ICaseOptions.

Définition à la ligne 329 du fichier CaseOptions.cc.

◆ caseModule()

IModule * Arcane::CaseOptions::caseModule ( ) const

overridevirtual

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

Implémente Arcane::ICaseOptions.

Définition à la ligne 302 du fichier CaseOptions.cc.

Références Arcane::CaseOptionsPrivate::m_module, et m_p.

◆ caseServiceInfo()

IServiceInfo * Arcane::CaseOptions::caseServiceInfo ( ) const

overridevirtual

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

Implémente Arcane::ICaseOptions.

Définition à la ligne 293 du fichier CaseOptions.cc.

Références m_p, et Arcane::CaseOptionsPrivate::m_service_info.

◆ configList() [1/2]

const ICaseOptionList * Arcane::CaseOptions::configList ( ) const

overridevirtual

Implémente Arcane::ICaseOptions.

Définition à la ligne 284 du fichier CaseOptions.cc.

◆ configList() [2/2]

ICaseOptionList * Arcane::CaseOptions::configList ( )

overridevirtual

Implémente Arcane::ICaseOptions.

Définition à la ligne 275 du fichier CaseOptions.cc.

◆ deepGetChildren()

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

overridevirtual

Ajoute à la liste col tous les options filles.

Implémente Arcane::ICaseOptions.

Définition à la ligne 585 du fichier CaseOptions.cc.

Références m_p.

◆ detach()

void Arcane::CaseOptions::detach ( )

overridevirtual

Implémente Arcane::ICaseOptions.

Définition à la ligne 211 du fichier CaseOptions.cc.

◆ isPresent()

bool Arcane::CaseOptions::isPresent ( ) const

overridevirtual

Vrai si l'option est présente dans le fichier, faux s'il s'agit de la valeur par défaut.

Implémente Arcane::ICaseOptions.

Définition à la ligne 241 du fichier CaseOptions.cc.

Références m_p.

◆ mesh()

IMesh * Arcane::CaseOptions::mesh ( ) const

overridevirtual

Implémente Arcane::ICaseOptions.

Définition à la ligne 365 du fichier CaseOptions.cc.

◆ meshHandle()

MeshHandle Arcane::CaseOptions::meshHandle ( ) const

overridevirtual

Implémente Arcane::ICaseOptions.

Définition à la ligne 356 du fichier CaseOptions.cc.

◆ name()

virtual String Arcane::CaseOptions::name ( ) const

inlinevirtual

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

Définition à la ligne 121 du fichier CaseOptions.h.

Référencé par addAlternativeNodeName().

◆ printChildren()

void Arcane::CaseOptions::printChildren	(	const String &	lang,
		int	indent
	)

overridevirtual

Implémente Arcane::ICaseOptions.

Définition à la ligne 567 du fichier CaseOptions.cc.

◆ read() [1/2]

void Arcane::CaseOptions::read ( bool is_phase1 )

inlineoverridevirtual

Implémente Arcane::ICaseOptions.

Définition à la ligne 123 du fichier CaseOptions.h.

◆ read() [2/2]

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

overridevirtual

Effectue la lecture de la phase read_phase des options.

Implémente Arcane::ICaseOptions.

Réimplémentée dans Arcane::CaseOptionServiceImpl.

Définition à la ligne 500 du fichier CaseOptions.cc.

Références Arcane::CaseOptionError::addError(), Arcane::XmlNode::attrValue(), Arcane::ICaseDocumentFragment::caseNodeNames(), Arcane::ICaseMng::findFunction(), Arccore::ITraceMng::info(), Arcane::CaseOptionsPrivate::m_activate_function, m_p, Arcane::ICaseFunction::name(), Arccore::String::null(), Arcane::ICaseFunction::ParamReal, Arcane::ICaseFunction::paramType(), Arcane::ICaseFunction::ValueBool, Arcane::ICaseFunction::valueType(), et Arcane::XmlNode::xpathFullName().

◆ rootTagName()

String Arcane::CaseOptions::rootTagName ( ) const

overridevirtual

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

Implémente Arcane::ICaseOptions.

Définition à la ligne 232 du fichier CaseOptions.cc.

Références m_p.

◆ rootTagTrueName()

String Arcane::CaseOptions::rootTagTrueName ( ) const

overridevirtual

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

Implémente Arcane::ICaseOptions.

Définition à la ligne 223 du fichier CaseOptions.cc.

Références m_p.

◆ setCaseModule()

void Arcane::CaseOptions::setCaseModule ( IModule * m )

overridevirtual

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

Implémente Arcane::ICaseOptions.

Définition à la ligne 320 du fichier CaseOptions.cc.

Références Arcane::CaseOptionsPrivate::m_module, et m_p.

◆ setCaseServiceInfo()

void Arcane::CaseOptions::setCaseServiceInfo ( IServiceInfo * m )

overridevirtual

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

Implémente Arcane::ICaseOptions.

Définition à la ligne 311 du fichier CaseOptions.cc.

Références m_p, et Arcane::CaseOptionsPrivate::m_service_info.

◆ subDomain()

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

overridevirtual

Sous-domain associé.

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

Implémente Arcane::ICaseOptions.

Définition à la ligne 347 du fichier CaseOptions.cc.

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

◆ toReference()

Ref< ICaseOptions > Arcane::CaseOptions::toReference ( )

overridevirtual

Implémente Arcane::ICaseOptions.

Définition à la ligne 609 du fichier CaseOptions.cc.

◆ traceMng()

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

overridevirtual

Implémente Arcane::ICaseOptions.

Définition à la ligne 338 du fichier CaseOptions.cc.

◆ translatedName()

String Arcane::CaseOptions::translatedName ( const String & lang ) const

overridevirtual

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

Implémente Arcane::ICaseOptions.

Définition à la ligne 477 du fichier CaseOptions.cc.

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

◆ trueName()

virtual String Arcane::CaseOptions::trueName ( ) const

inlinevirtual

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

Définition à la ligne 118 du fichier CaseOptions.h.

◆ visit()

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

overridevirtual

Applique le visiteur sur cette option.

Implémente Arcane::ICaseOptions.

Réimplémentée dans Arcane::CaseOptionServiceImpl.

Définition à la ligne 576 du fichier CaseOptions.cc.

Références m_p.

Référencé par Arcane::CaseOptionServiceImpl::visit().

◆ xpathFullName()

String Arcane::CaseOptions::xpathFullName ( ) const

overridevirtual

Nom complet au format XPath correspondant à rootElement()

Implémente Arcane::ICaseOptions.

Définition à la ligne 250 du fichier CaseOptions.cc.

Références m_p.

Documentation des fonctions amies et associées

◆ ServiceBuilderWithOptionsBase

friend class ServiceBuilderWithOptionsBase

friend

Définition à la ligne 88 du fichier CaseOptions.h.

Documentation des données membres

◆ m_p

CaseOptionsPrivate* Arcane::CaseOptions::m_p

protected

Implémentation.

Définition à la ligne 194 du fichier CaseOptions.h.

Référencé par _setMeshHandleAndCheckDisabled(), activateFunction(), addAlternativeNodeName(), addInvalidChildren(), caseModule(), CaseOptions(), CaseOptions(), CaseOptions(), CaseOptions(), CaseOptions(), CaseOptions(), caseServiceInfo(), deepGetChildren(), isPresent(), read(), rootTagName(), rootTagTrueName(), setCaseModule(), setCaseServiceInfo(), subDomain(), translatedName(), visit(), xpathFullName(), et ~CaseOptions().

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

Fonctions membres publiques

Fonctions membres protégées

Attributs protégés

Amis

Description détaillée

Documentation des constructeurs et destructeur

◆ CaseOptions() [1/6]

◆ CaseOptions() [2/6]

◆ CaseOptions() [3/6]

◆ CaseOptions() [4/6]

◆ CaseOptions() [5/6]

◆ CaseOptions() [6/6]

◆ ~CaseOptions()

Documentation des fonctions membres

◆ _setMeshHandleAndCheckDisabled()

◆ _setTranslatedName()

◆ activateFunction()

◆ addAlternativeNodeName()

◆ addInvalidChildren()

◆ caseDocument()

◆ caseDocumentFragment()

◆ caseMng()

◆ caseModule()

◆ caseServiceInfo()

◆ configList() [1/2]

◆ configList() [2/2]

◆ deepGetChildren()

◆ detach()

◆ isPresent()

◆ mesh()

◆ meshHandle()

◆ name()

◆ printChildren()

◆ read() [1/2]

◆ read() [2/2]

◆ rootTagName()

◆ rootTagTrueName()

◆ setCaseModule()

◆ setCaseServiceInfo()

◆ subDomain()

◆ toReference()

◆ traceMng()

◆ translatedName()

◆ trueName()

◆ visit()

◆ xpathFullName()

Documentation des fonctions amies et associées

◆ ServiceBuilderWithOptionsBase

Documentation des données membres

◆ m_p