Référence de la classe Arcane::ICaseOptionList

Fonctions membres publiques
virtual XmlNode	rootElement () const =0
	Retourne l'élément lié à cette liste d'option.
virtual XmlNode	parentElement () const =0
	Retourne l'élément parent.
virtual void	addChild (ICaseOptions *co)=0
	Ajoute la liste co à la liste des fils.
virtual void	removeChild (ICaseOptions *co)=0
	Supprime co de la liste des fils.
virtual ICaseMng *	caseMng () const =0
	Retourne le gestionnaire du cas.
virtual void	readChildren (bool is_phase1)=0
	Lis les valeurs des options à partir des éléments du DOM.
virtual void	printChildren (const String &lang, int indent)=0
	Affiche la liste des options filles dans le langage lang et leur valeur.
virtual String	rootTagName () const =0
	Retourne le nom de l'élément de cette liste.
virtual void	deepGetChildren (Array< CaseOptionBase * > &col)=0
	Ajoute à la liste col tous les options filles.
virtual bool	isPresent () const =0
	Indique si l'option est présente dans le jeu de données.
virtual bool	isOptional () const =0
	Indique si l'option est optionnelle.
virtual Integer	minOccurs () const =0
	Nombre minimum d'occurences.
virtual Integer	maxOccurs () const =0
	Nombre maximum d'occurences.
virtual void	visit (ICaseDocumentVisitor *visitor)=0
	Applique le visiteur visitor.
virtual String	xpathFullName () const =0
	Nom complet au format XPath correspondant à rootElement()
virtual MeshHandle	meshHandle () const =0
	Handle du maillage associé
virtual ICaseDocumentFragment *	caseDocumentFragment () const =0
	Document associé.
virtual void	disable ()=0
	Désactive l'option comme si elle était absente.
virtual void	addConfig (CaseOptionBase *o, XmlNode parent)=0
	Ajoute l'option o avec le parent parent.
virtual void	setRootElementWithParent (XmlNode parent_element)=0
	Positionne l'élément racine de la liste, avec parent_element comme parent. Si déjà positionné, ne fait rien.
virtual void	setRootElement (XmlNode root_element)=0
	Positionne l'élément racine de la liste. Si déjà positionné, lance une exception.
virtual void	addInvalidChildren (XmlNodeList &nlist)=0
	Ajoute les éléments fils ne correspondants par à de options dans nlist.
virtual ICaseOptionListInternal *	_internalApi ()=0
	API interne à Arcane.

Description détaillée

Définition à la ligne 37 du fichier ICaseOptionList.h.

Documentation des fonctions membres

_internalApi()

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

pure virtual

API interne à Arcane.

Implémenté dans Arcane::CaseOptionList.

Références _internalApi().

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

addChild()

virtual void Arcane::ICaseOptionList::addChild ( ICaseOptions * co )

pure virtual

Ajoute la liste co à la liste des fils.

Implémenté dans Arcane::CaseOptionList.

addConfig()

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

pure virtual

Ajoute l'option o avec le parent parent.

Implémenté dans Arcane::CaseOptionList.

Références addConfig().

Référencé par addConfig().

addInvalidChildren()

virtual void Arcane::ICaseOptionList::addInvalidChildren ( XmlNodeList & nlist )

pure virtual

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

Implémenté dans Arcane::CaseOptionList, et Arcane::CaseOptionListMulti.

Références addInvalidChildren().

Référencé par addInvalidChildren().

caseDocumentFragment()

virtual ICaseDocumentFragment * Arcane::ICaseOptionList::caseDocumentFragment ( ) const

pure virtual

Document associé.

Implémenté dans Arcane::CaseOptionList.

caseMng()

virtual ICaseMng * Arcane::ICaseOptionList::caseMng ( ) const

pure virtual

Retourne le gestionnaire du cas.

Implémenté dans Arcane::CaseOptionList.

deepGetChildren()

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

pure virtual

Ajoute à la liste col tous les options filles.

Implémenté dans Arcane::CaseOptionList, et Arcane::CaseOptionListMulti.

disable()

virtual void Arcane::ICaseOptionList::disable ( )

pure virtual

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émenté dans Arcane::CaseOptionList.

isOptional()

virtual bool Arcane::ICaseOptionList::isOptional ( ) const

pure virtual

Indique si l'option est optionnelle.

Implémenté dans Arcane::CaseOptionList, et Arcane::CaseOptionListMulti.

isPresent()

virtual bool Arcane::ICaseOptionList::isPresent ( ) const

pure virtual

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

Implémenté dans Arcane::CaseOptionList.

maxOccurs()

virtual Integer Arcane::ICaseOptionList::maxOccurs ( ) const

pure virtual

Nombre maximum d'occurences.

Implémenté dans Arcane::CaseOptionList, et Arcane::CaseOptionListMulti.

meshHandle()

virtual MeshHandle Arcane::ICaseOptionList::meshHandle ( ) const

pure virtual

Handle du maillage associé

Implémenté dans Arcane::CaseOptionList.

Référencé par Arcane::CaseOptionExtended::_search(), et Arcane::CaseOptionMultiExtended::_search().

minOccurs()

virtual Integer Arcane::ICaseOptionList::minOccurs ( ) const

pure virtual

Nombre minimum d'occurences.

Implémenté dans Arcane::CaseOptionList, et Arcane::CaseOptionListMulti.

parentElement()

virtual XmlNode Arcane::ICaseOptionList::parentElement ( ) const

pure virtual

Retourne l'élément parent.

Implémenté dans Arcane::CaseOptionList.

printChildren()

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

pure virtual

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

Implémenté dans Arcane::CaseOptionList, et Arcane::CaseOptionListMulti.

readChildren()

virtual void Arcane::ICaseOptionList::readChildren ( bool is_phase1 )

pure virtual

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

Implémenté dans Arcane::CaseOptionList, et Arcane::CaseOptionListMulti.

removeChild()

virtual void Arcane::ICaseOptionList::removeChild ( ICaseOptions * co )

pure virtual

Supprime co de la liste des fils.

Implémenté dans Arcane::CaseOptionList.

rootElement()

virtual XmlNode Arcane::ICaseOptionList::rootElement ( ) const

pure virtual

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émenté dans Arcane::CaseOptionList.

rootTagName()

virtual String Arcane::ICaseOptionList::rootTagName ( ) const

pure virtual

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

Implémenté dans Arcane::CaseOptionList.

setRootElement()

virtual void Arcane::ICaseOptionList::setRootElement ( XmlNode root_element )

pure virtual

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

Implémenté dans Arcane::CaseOptionList.

Références setRootElement().

Référencé par setRootElement().

setRootElementWithParent()

virtual void Arcane::ICaseOptionList::setRootElementWithParent ( XmlNode parent_element )

pure virtual

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

Implémenté dans Arcane::CaseOptionList.

Références setRootElementWithParent().

Référencé par setRootElementWithParent().

visit()

virtual void Arcane::ICaseOptionList::visit ( ICaseDocumentVisitor * visitor )

pure virtual

Applique le visiteur visitor.

Implémenté dans Arcane::CaseOptionList, et Arcane::CaseOptionListMulti.

xpathFullName()

virtual String Arcane::ICaseOptionList::xpathFullName ( ) const

pure virtual

Nom complet au format XPath correspondant à rootElement()

Implémenté dans Arcane::CaseOptionList.

---

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

• ICaseOptionList.h