Liste d'options de configuration d'un service ou module. Plus de détails...

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

Graphe de collaboration de Arcane::CaseOptionList:

Classes
class	InternalApi

Types publics
typedef std::pair< CaseOptionBase *, XmlNode >	CaseOptionBasePair

typedef std::vector< CaseOptionBasePair >	CaseOptionBasePairList

Fonctions membres publiques
	CaseOptionList (ICaseMng m, ICaseOptions ref_opt, XmlNode parent_element)

	CaseOptionList (ICaseOptionList parent, ICaseOptions ref_opt, XmlNode parent_element)

XmlNode	rootElement () const override
	Retourne l'élément lié à cette liste d'option.

XmlNode	parentElement () const override
	Retourne l'élément parent.

ICaseMng *	caseMng () const override
	Retourne le gestionnaire du cas.

void	addConfig (CaseOptionBase *cbi, XmlNode parent) override
	Ajoute l'option o avec le parent parent.

void	addChild (ICaseOptions *c) override
	Ajoute la liste co à la liste des fils.

void	removeChild (ICaseOptions *c) override
	Supprime co de la liste des fils.

void	readChildren (bool is_phase1) override
	Lis les valeurs des options à partir des éléments du DOM.

void	printChildren (const String &lang, int indent) override
	Affiche la liste des options filles dans le langage lang et leur valeur.

void	visit (ICaseDocumentVisitor *visitor) override
	Applique le visiteur visitor.

void	addInvalidChildren (XmlNodeList &nlist) override
	Ajoute les éléments fils ne correspondants par à de options dans nlist.

void	deepGetChildren (Array< CaseOptionBase * > &col) override
	Ajoute à la liste col tous les options filles.

String	rootTagName () const override
	Retourne le nom de l'élément de cette liste.

bool	isOptional () const override
	Indique si l'option est optionnelle.

void	setOptional (bool v)

void	setRootElementWithParent (XmlNode parent_element) override
	Positionne l'élément racine de la liste, avec parent_element comme parent. Si déjà positionné, ne fait rien.

void	setRootElement (XmlNode root_element) override
	Positionne l'élément racine de la liste. Si déjà positionné, lance une exception.

bool	isPresent () const override
	Indique si l'option est présente dans le jeu de données.

void	setIsMulti (bool v)
	Indique si l'option peut-être présente plusieurs fois.

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

MeshHandle	meshHandle () const override
	Handle du maillage associé

ICaseDocumentFragment *	caseDocumentFragment () const override
	Document associé.

void	disable () override
	Désactive l'option comme si elle était absente.

virtual ICaseOptionListInternal *	_internalApi () override
	API interne à Arcane.

Fonctions membres publiques hérités de Arccore::TraceAccessor
	TraceAccessor (ITraceMng *m)
	Construit un accesseur via le gestionnaire de trace m.

	TraceAccessor (const TraceAccessor &rhs)
	Constructeur par recopie.

TraceAccessor &	operator= (const TraceAccessor &rhs)
	Opérateur de recopie.

virtual	~TraceAccessor ()
	Libère les ressources.

ITraceMng *	traceMng () const
	Gestionnaire de trace.

TraceMessage	info () const
	Flot pour un message d'information.

TraceMessage	pinfo () const
	Flot pour un message d'information en parallèle.

TraceMessage	info (char category) const
	Flot pour un message d'information d'une catégorie donnée.

TraceMessage	pinfo (char category) const
	Flot pour un message d'information parallèle d'une catégorie donnée.

TraceMessage	info (bool v) const
	Flot pour un message d'information.

TraceMessage	warning () const
	Flot pour un message d'avertissement.

TraceMessage	pwarning () const

TraceMessage	error () const
	Flot pour un message d'erreur.

TraceMessage	perror () const

TraceMessage	log () const
	Flot pour un message de log.

TraceMessage	plog () const
	Flot pour un message de log.

TraceMessage	logdate () const
	Flot pour un message de log précédé de la date.

TraceMessage	fatal () const
	Flot pour un message d'erreur fatale.

TraceMessage	pfatal () const
	Flot pour un message d'erreur fatale en parallèle.

TraceMessageDbg	debug (Trace::eDebugLevel=Trace::Medium) const
	Flot pour un message de debug.

Trace::eDebugLevel	configDbgLevel () const
	Niveau debug du fichier de configuration.

TraceMessage	info (Int32 verbose_level) const
	Flot pour un message d'information d'un niveau donné

TraceMessage	linfo () const
	Flot pour un message d'information avec le niveau d'information local à cette instance.

TraceMessage	linfo (Int32 relative_level) const
	Flot pour un message d'information avec le niveau d'information local à cette instance.

void	fatalMessage (const StandaloneTraceMessage &o) const

Fonctions membres publiques hérités de Arccore::ReferenceCounterImpl
void	addReference ()

void	removeReference ()

void	_internalAddReference ()

bool	_internalRemoveReference ()

Fonctions membres protégées
void	_addInvalidChildren (XmlNode parent, XmlNodeList &nlist)

void	_searchChildren (bool is_phase1)

void	_setRootElement (bool force_init, XmlNode parent_element)

void	_strIndent (char *buf, int indent, int max_indent)

void	_printOption (const String &lang, int indent, CaseOptionBase *co, std::ostream &o)

bool	_isValidChildTagName (const String &name)

Fonctions membres protégées hérités de Arccore::TraceAccessor
void	_setLocalVerboseLevel (Int32 v)

Int32	_localVerboseLevel () const

Attributs protégés
ICaseMng *	m_case_mng

XmlNode	m_root_element
	Elément racine pour cette liste d'options.

ICaseOptionList *	m_parent

ICaseOptions *	m_ref_opt

CaseOptionBasePairList	m_config_list
	Liste des valeurs de configuration.

std::vector< ICaseOptions * >	m_case_options

XmlNode	m_parent_element
	Elément parent.

bool	m_is_present

bool	m_is_multi

bool	m_is_optional

bool	m_is_disabled = false

InternalApi	m_internal_api

Fonctions membres privées
	ARCCORE_DEFINE_REFERENCE_COUNTED_INCLASS_METHODS ()

Description détaillée

Liste d'options de configuration d'un service ou module.

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

Documentation des définitions de type membres

◆ CaseOptionBasePair

typedef std::pair<CaseOptionBase*,XmlNode> Arcane::CaseOptionList::CaseOptionBasePair

Définition à la ligne 150 du fichier CaseOptionList.cc.

◆ CaseOptionBasePairList

typedef std::vector<CaseOptionBasePair> Arcane::CaseOptionList::CaseOptionBasePairList

Définition à la ligne 151 du fichier CaseOptionList.cc.

Documentation des constructeurs et destructeur

◆ CaseOptionList() [1/2]

Arcane::CaseOptionList::CaseOptionList	(	ICaseMng *	m,
		ICaseOptions *	ref_opt,
		XmlNode	parent_element
	)

inline

Définition à la ligne 153 du fichier CaseOptionList.cc.

◆ CaseOptionList() [2/2]

Arcane::CaseOptionList::CaseOptionList	(	ICaseOptionList *	parent,
		ICaseOptions *	ref_opt,
		XmlNode	parent_element
	)

inline

Définition à la ligne 157 du fichier CaseOptionList.cc.

◆ ~CaseOptionList()

Arcane::CaseOptionList::~CaseOptionList ( )

inline

Définition à la ligne 164 du fichier CaseOptionList.cc.

Documentation des fonctions membres

◆ _addInvalidChildren()

void Arcane::CaseOptionList::_addInvalidChildren	(	XmlNode	parent,
		XmlNodeList &	nlist
	)

protected

Définition à la ligne 519 du fichier CaseOptionList.cc.

◆ _internalApi()

virtual ICaseOptionListInternal * Arcane::CaseOptionList::_internalApi ( )

inlineoverridevirtual

API interne à Arcane.

Implémente Arcane::ICaseOptionList.

Définition à la ligne 273 du fichier CaseOptionList.cc.

◆ _isValidChildTagName()

bool Arcane::CaseOptionList::_isValidChildTagName ( const String & name )

protected

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

◆ _printOption()

void Arcane::CaseOptionList::_printOption	(	const String &	lang,
		int	indent,
		CaseOptionBase *	co,
		std::ostream &	o
	)

protected

Définition à la ligne 480 du fichier CaseOptionList.cc.

◆ _searchChildren()

void Arcane::CaseOptionList::_searchChildren ( bool is_phase1 )

protected

Définition à la ligne 404 du fichier CaseOptionList.cc.

◆ _setRootElement()

void Arcane::CaseOptionList::_setRootElement	(	bool	force_init,
		XmlNode	parent_element
	)

protected

Définition à la ligne 420 du fichier CaseOptionList.cc.

◆ _strIndent()

void Arcane::CaseOptionList::_strIndent	(	char *	buf,
		int	indent,
		int	max_indent
	)

protected

Définition à la ligne 464 du fichier CaseOptionList.cc.

◆ addChild()

void Arcane::CaseOptionList::addChild ( ICaseOptions * co )

inlineoverridevirtual

Ajoute la liste co à la liste des fils.

Implémente Arcane::ICaseOptionList.

Définition à la ligne 184 du fichier CaseOptionList.cc.

Références Arccore::TraceAccessor::info().

◆ addConfig()

void Arcane::CaseOptionList::addConfig	(	CaseOptionBase *	o,
		XmlNode	parent
	)

inlineoverridevirtual

Ajoute l'option o avec le parent parent.

Implémente Arcane::ICaseOptionList.

Définition à la ligne 179 du fichier CaseOptionList.cc.

Références m_config_list.

◆ addInvalidChildren()

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

overridevirtual

Ajoute les éléments fils ne correspondants par à de options dans nlist.

Implémente Arcane::ICaseOptionList.

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

Définition à la ligne 384 du fichier CaseOptionList.cc.

Références Arccore::TraceAccessor::info(), m_parent_element, m_root_element, Arcane::XmlNode::null(), et Arcane::XmlNode::xpathFullName().

Référencé par Arcane::CaseOptionList::InternalApi::addInvalidChildren().

◆ caseDocumentFragment()

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

inlineoverridevirtual

Document associé.

Implémente Arcane::ICaseOptionList.

Définition à la ligne 256 du fichier CaseOptionList.cc.

Référencé par readChildren().

◆ caseMng()

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

inlineoverridevirtual

Retourne le gestionnaire du cas.

Implémente Arcane::ICaseOptionList.

Définition à la ligne 178 du fichier CaseOptionList.cc.

◆ deepGetChildren()

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

inlineoverridevirtual

Ajoute à la liste col tous les options filles.

Implémente Arcane::ICaseOptionList.

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

Définition à la ligne 206 du fichier CaseOptionList.cc.

Références m_config_list.

◆ disable()

void Arcane::CaseOptionList::disable ( )

inlineoverridevirtual

Désactive l'option comme si elle était absente.

Cela est utilisé par exemple si l'option est associée à un maillage qui n'est pas défini.

Implémente Arcane::ICaseOptionList.

Définition à la ligne 263 du fichier CaseOptionList.cc.

Références Arccore::TraceAccessor::info(), m_root_element, et Arcane::XmlNode::xpathFullName().

◆ isOptional()

bool Arcane::CaseOptionList::isOptional ( ) const

inlineoverridevirtual

Indique si l'option est optionnelle.

Implémente Arcane::ICaseOptionList.

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

Définition à la ligne 216 du fichier CaseOptionList.cc.

Référencé par printChildren(), et visit().

◆ isPresent()

bool Arcane::CaseOptionList::isPresent ( ) const

inlineoverridevirtual

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

Implémente Arcane::ICaseOptionList.

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

◆ meshHandle()

MeshHandle Arcane::CaseOptionList::meshHandle ( ) const

inlineoverridevirtual

Handle du maillage associé

Implémente Arcane::ICaseOptionList.

Définition à la ligne 252 du fichier CaseOptionList.cc.

◆ parentElement()

XmlNode Arcane::CaseOptionList::parentElement ( ) const

inlineoverridevirtual

Retourne l'élément parent.

Implémente Arcane::ICaseOptionList.

Définition à la ligne 177 du fichier CaseOptionList.cc.

Références m_parent_element.

◆ printChildren()

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

overridevirtual

Affiche la liste des options filles dans le langage lang et leur valeur.

Implémente Arcane::ICaseOptionList.

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

Définition à la ligne 334 du fichier CaseOptionList.cc.

Références Arcane::ICaseOptions::caseServiceInfo(), Arccore::TraceAccessor::info(), isOptional(), Arcane::IServiceInfo::localName(), m_config_list, et rootTagName().

◆ readChildren()

void Arcane::CaseOptionList::readChildren ( bool is_phase1 )

overridevirtual

Lis les valeurs des options à partir des éléments du DOM.

Implémente Arcane::ICaseOptionList.

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

Définition à la ligne 306 du fichier CaseOptionList.cc.

Références Arcane::CaseOptionError::addWarning(), caseDocumentFragment(), Arcane::XmlNode::children(), Arccore::TraceAccessor::info(), m_config_list, m_parent_element, m_root_element, Arcane::XmlNode::null(), rootTagName(), et Arcane::XmlNode::xpathFullName().

◆ removeChild()

void Arcane::CaseOptionList::removeChild ( ICaseOptions * co )

inlineoverridevirtual

Supprime co de la liste des fils.

Implémente Arcane::ICaseOptionList.

Définition à la ligne 190 du fichier CaseOptionList.cc.

Références ARCANE_FATAL, et Arccore::TraceAccessor::info().

◆ rootElement()

XmlNode Arcane::CaseOptionList::rootElement ( ) const

inlineoverridevirtual

Retourne l'élément lié à cette liste d'option.

S'il n'y en a pas, retourne un XmlNode nul. S'il y en a plusieurs, retourne le premier.

Implémente Arcane::ICaseOptionList.

Définition à la ligne 176 du fichier CaseOptionList.cc.

Références m_root_element.

◆ rootTagName()

String Arcane::CaseOptionList::rootTagName ( ) const

inlineoverridevirtual

Retourne le nom de l'élément de cette liste.

Implémente Arcane::ICaseOptionList.

Définition à la ligne 214 du fichier CaseOptionList.cc.

Références Arcane::ICaseOptions::rootTagName().

Référencé par printChildren(), readChildren(), et Arcane::CaseOptionListMulti::readChildren().

◆ setIsMulti()

void Arcane::CaseOptionList::setIsMulti ( bool v )

inline

Indique si l'option peut-être présente plusieurs fois.

Cela sert à vérifier que l'élément correspondant de l'option n'est présent qu'une seule fois si v est faux. Si v est vrai, la vérification a lieu ailleurs. Cette fonction doit être appelée avant readChildren() pour être pris en compte.

Définition à la ligne 245 du fichier CaseOptionList.cc.

◆ setOptional()

void Arcane::CaseOptionList::setOptional ( bool v )

inline

Définition à la ligne 217 du fichier CaseOptionList.cc.

◆ setRootElement()

void Arcane::CaseOptionList::setRootElement ( XmlNode root_element )

inlineoverridevirtual

Positionne l'élément racine de la liste. Si déjà positionné, lance une exception.

Implémente Arcane::ICaseOptionList.

Définition à la ligne 224 du fichier CaseOptionList.cc.

Références m_root_element, et Arcane::XmlNode::null().

Référencé par Arcane::CaseOptionList::InternalApi::setRootElement().

◆ setRootElementWithParent()

void Arcane::CaseOptionList::setRootElementWithParent ( XmlNode parent_element )

inlineoverridevirtual

Positionne l'élément racine de la liste, avec parent_element comme parent. Si déjà positionné, ne fait rien.

Implémente Arcane::ICaseOptionList.

Définition à la ligne 219 du fichier CaseOptionList.cc.

Référencé par Arcane::CaseOptionList::InternalApi::setRootElementWithParent().

◆ visit()

void Arcane::CaseOptionList::visit ( ICaseDocumentVisitor * visitor )

overridevirtual

Applique le visiteur visitor.

Implémente Arcane::ICaseOptionList.

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

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

Références isOptional(), et m_config_list.

◆ xpathFullName()

String Arcane::CaseOptionList::xpathFullName ( ) const

inlineoverridevirtual

Nom complet au format XPath correspondant à rootElement()

Implémente Arcane::ICaseOptionList.

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

Références m_root_element, et Arcane::XmlNode::xpathFullName().

Documentation des données membres

◆ m_case_mng

ICaseMng* Arcane::CaseOptionList::m_case_mng

protected

Définition à la ligne 286 du fichier CaseOptionList.cc.

◆ m_case_options

std::vector<ICaseOptions*> Arcane::CaseOptionList::m_case_options

protected

Définition à la ligne 291 du fichier CaseOptionList.cc.

◆ m_config_list

CaseOptionBasePairList Arcane::CaseOptionList::m_config_list

protected

Liste des valeurs de configuration.

Définition à la ligne 290 du fichier CaseOptionList.cc.

Référencé par addConfig(), deepGetChildren(), printChildren(), readChildren(), Arcane::CaseOptionListMulti::readChildren(), et visit().

◆ m_internal_api

InternalApi Arcane::CaseOptionList::m_internal_api

protected

Définition à la ligne 297 du fichier CaseOptionList.cc.

◆ m_is_disabled

bool Arcane::CaseOptionList::m_is_disabled = false

protected

Définition à la ligne 296 du fichier CaseOptionList.cc.

◆ m_is_multi

bool Arcane::CaseOptionList::m_is_multi

protected

Définition à la ligne 294 du fichier CaseOptionList.cc.

◆ m_is_optional

bool Arcane::CaseOptionList::m_is_optional

protected

Définition à la ligne 295 du fichier CaseOptionList.cc.

◆ m_is_present

bool Arcane::CaseOptionList::m_is_present

protected

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

◆ m_parent

ICaseOptionList* Arcane::CaseOptionList::m_parent

protected

Définition à la ligne 288 du fichier CaseOptionList.cc.

◆ m_parent_element

XmlNode Arcane::CaseOptionList::m_parent_element

protected

Elément parent.

Définition à la ligne 292 du fichier CaseOptionList.cc.

Référencé par addInvalidChildren(), parentElement(), readChildren(), et Arcane::CaseOptionListMulti::readChildren().

◆ m_ref_opt

ICaseOptions* Arcane::CaseOptionList::m_ref_opt

protected

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

◆ m_root_element

XmlNode Arcane::CaseOptionList::m_root_element

protected

Elément racine pour cette liste d'options.

Définition à la ligne 287 du fichier CaseOptionList.cc.

Référencé par addInvalidChildren(), disable(), readChildren(), Arcane::CaseOptionListMulti::readChildren(), rootElement(), setRootElement(), et xpathFullName().

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

CaseOptionList.cc

Classes

Types publics

Fonctions membres publiques

Fonctions membres protégées

Attributs protégés

Fonctions membres privées

Description détaillée

Documentation des définitions de type membres

◆ CaseOptionBasePair

◆ CaseOptionBasePairList

Documentation des constructeurs et destructeur

◆ CaseOptionList() [1/2]

◆ CaseOptionList() [2/2]

◆ ~CaseOptionList()

Documentation des fonctions membres

◆ _addInvalidChildren()

◆ _internalApi()

◆ _isValidChildTagName()

◆ _printOption()

◆ _searchChildren()

◆ _setRootElement()

◆ _strIndent()

◆ addChild()

◆ addConfig()

◆ addInvalidChildren()

◆ caseDocumentFragment()

◆ caseMng()

◆ deepGetChildren()

◆ disable()

◆ isOptional()

◆ isPresent()

◆ meshHandle()

◆ parentElement()

◆ printChildren()

◆ readChildren()

◆ removeChild()

◆ rootElement()

◆ rootTagName()

◆ setIsMulti()

◆ setOptional()

◆ setRootElement()

◆ setRootElementWithParent()

◆ visit()

◆ xpathFullName()

Documentation des données membres

◆ m_case_mng

◆ m_case_options

◆ m_config_list

◆ m_internal_api

◆ m_is_disabled

◆ m_is_multi

◆ m_is_optional

◆ m_is_present

◆ m_parent

◆ m_parent_element

◆ m_ref_opt

◆ m_root_element