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

Interface d'une classe gérant un document XML du jeu de données. Plus de détails...

#include <arcane/core/ICaseDocument.h>

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

Fonctions membres publiques

virtual void build ()=0
 Construit l'instance.
 
virtual ICaseDocumentclone ()=0
 Clone le document.
 
virtual CaseNodeNamescaseNodeNames ()=0
 Retourne l'instance contenant les noms des noeuds XML par langage.
 
virtual XmlNode arcaneElement ()=0
 Retourne l'élément des informations pour Arcane.
 
virtual XmlNode configurationElement ()=0
 Retourne l'élément des informations de configuration.
 
virtual XmlNode timeloopElement ()=0
 Retourne l'élément contenant le choix de la boucle en temps.
 
virtual XmlNode titleElement ()=0
 Retourne l'élément contenant le titre du cas.
 
virtual XmlNode descriptionElement ()=0
 Retourne l'élément contenant la description du cas.
 
virtual XmlNode modulesElement ()=0
 Retourne l'élément contenant la description des modules.
 
virtual XmlNode servicesElement ()=0
 Retourne l'élément contenant la description des services.
 
virtual XmlNode functionsElement ()=0
 Retourne l'élément racine des fonctions.
 
virtual const XmlNodeListmeshElements ()=0
 Retourne l'élément racine des informations de maillage.
 
virtual XmlNode meshesElement ()=0
 Elément contenant la liste des maillages (nouveau mécanisme) (peut être nul)
 
virtual String userClass () const =0
 Nom de la classe d'utilisation du cas.
 
virtual void setUserClass (const String &value)=0
 Positionne le nom de la classe d'utilisation du cas.
 
virtual String codeName () const =0
 Nom du code du cas.
 
virtual void setCodeName (const String &value)=0
 Positionne le nom du code du cas.
 
virtual String codeVersion () const =0
 Numéro de version du code correspondant au cas.
 
virtual void setCodeVersion (const String &value)=0
 Positionne le numéro de version du code.
 
virtual String codeUnitSystem () const =0
 Nom du système d'unité du document.
 
virtual void setCodeUnitSystem (const String &value)=0
 Positionne le nom du systmème d'unité du document.
 
virtual void setDefaultCategory (const String &v)=0
 Positionne la catégorie utilisée pour les valeurs par défaut.
 
virtual ICaseDocumentFragmentfragment ()=0
 Fragment correspondant à ce document.
 
- Fonctions membres publiques hérités de Arcane::ICaseDocumentFragment
virtual IXmlDocumentHolderdocumentHolder ()=0
 Retourne le document Xml du jeu de données. Ce pointeur reste la propriété de cette classe et est détruit lorsque cette instance est détruite.
 
virtual XmlNode documentNode ()=0
 Retourne le noeud document.
 
virtual XmlNode rootElement ()=0
 Retourne l'élément racine.
 
virtual String language () const =0
 Langage utilisé dans le jeu de données.
 
virtual String defaultCategory () const =0
 Catégorie utilisée pour les valeurs par défaut.
 
virtual void addError (const CaseOptionError &case_error)=0
 Ajoute une erreur dans le jeu de données.
 
virtual void addWarning (const CaseOptionError &case_error)=0
 Ajoute un avertissement dans le jeu de données.
 
virtual bool hasError () const =0
 
virtual bool hasWarnings () const =0
 
virtual void printErrors (std::ostream &o)=0
 Ecrit les erreurs dans le flot o.
 
virtual void printWarnings (std::ostream &o)=0
 Ecrit les avertissements dans le flot o.
 
virtual void clearErrorsAndWarnings ()=0
 Supprime les messages d'erreurs et d'avertissements enregistrés.
 

Description détaillée

Interface d'une classe gérant un document XML du jeu de données.

A faire:
Ne plus hériter de ICaseDocumentFragment (utiliser la méthode fragment() à la place)

Définition à la ligne 100 du fichier ICaseDocument.h.

Documentation des fonctions membres

◆ arcaneElement()

virtual XmlNode Arcane::ICaseDocument::arcaneElement ( )
pure virtual

Retourne l'élément des informations pour Arcane.

Implémenté dans Arcane::CaseDocument.

◆ build()

virtual void Arcane::ICaseDocument::build ( )
pure virtual

Construit l'instance.

Implémenté dans Arcane::CaseDocument.

◆ caseNodeNames()

virtual CaseNodeNames * Arcane::ICaseDocument::caseNodeNames ( )
pure virtual

Retourne l'instance contenant les noms des noeuds XML par langage.

Implémente Arcane::ICaseDocumentFragment.

Implémenté dans Arcane::CaseDocument.

◆ clone()

virtual ICaseDocument * Arcane::ICaseDocument::clone ( )
pure virtual

Clone le document.

Implémenté dans Arcane::CaseDocument.

◆ codeName()

virtual String Arcane::ICaseDocument::codeName ( ) const
pure virtual

Nom du code du cas.

Implémenté dans Arcane::CaseDocument.

◆ codeUnitSystem()

virtual String Arcane::ICaseDocument::codeUnitSystem ( ) const
pure virtual

Nom du système d'unité du document.

Implémenté dans Arcane::CaseDocument.

◆ codeVersion()

virtual String Arcane::ICaseDocument::codeVersion ( ) const
pure virtual

Numéro de version du code correspondant au cas.

Implémenté dans Arcane::CaseDocument.

◆ configurationElement()

virtual XmlNode Arcane::ICaseDocument::configurationElement ( )
pure virtual

Retourne l'élément des informations de configuration.

Implémenté dans Arcane::CaseDocument.

◆ descriptionElement()

virtual XmlNode Arcane::ICaseDocument::descriptionElement ( )
pure virtual

Retourne l'élément contenant la description du cas.

Implémenté dans Arcane::CaseDocument.

◆ fragment()

virtual ICaseDocumentFragment * Arcane::ICaseDocument::fragment ( )
pure virtual

Fragment correspondant à ce document.

Implémenté dans Arcane::CaseDocument.

Référencé par Arcane::CaseMng::printOptions(), et Arcane::CaseMng::readOptions().

◆ functionsElement()

virtual XmlNode Arcane::ICaseDocument::functionsElement ( )
pure virtual

Retourne l'élément racine des fonctions.

Implémenté dans Arcane::CaseDocument.

◆ meshElements()

virtual const XmlNodeList & Arcane::ICaseDocument::meshElements ( )
pure virtual

Retourne l'élément racine des informations de maillage.

Implémenté dans Arcane::CaseDocument.

◆ meshesElement()

virtual XmlNode Arcane::ICaseDocument::meshesElement ( )
pure virtual

Elément contenant la liste des maillages (nouveau mécanisme) (peut être nul)

Implémenté dans Arcane::CaseDocument.

◆ modulesElement()

virtual XmlNode Arcane::ICaseDocument::modulesElement ( )
pure virtual

Retourne l'élément contenant la description des modules.

Implémenté dans Arcane::CaseDocument.

◆ servicesElement()

virtual XmlNode Arcane::ICaseDocument::servicesElement ( )
pure virtual

Retourne l'élément contenant la description des services.

Implémenté dans Arcane::CaseDocument.

◆ setCodeName()

virtual void Arcane::ICaseDocument::setCodeName ( const String value)
pure virtual

Positionne le nom du code du cas.

Implémenté dans Arcane::CaseDocument.

◆ setCodeUnitSystem()

virtual void Arcane::ICaseDocument::setCodeUnitSystem ( const String value)
pure virtual

Positionne le nom du systmème d'unité du document.

Implémenté dans Arcane::CaseDocument.

◆ setCodeVersion()

virtual void Arcane::ICaseDocument::setCodeVersion ( const String value)
pure virtual

Positionne le numéro de version du code.

Implémenté dans Arcane::CaseDocument.

◆ setDefaultCategory()

virtual void Arcane::ICaseDocument::setDefaultCategory ( const String v)
pure virtual

Positionne la catégorie utilisée pour les valeurs par défaut.

Implémenté dans Arcane::CaseDocument.

◆ setUserClass()

virtual void Arcane::ICaseDocument::setUserClass ( const String value)
pure virtual

Positionne le nom de la classe d'utilisation du cas.

Implémenté dans Arcane::CaseDocument.

◆ timeloopElement()

virtual XmlNode Arcane::ICaseDocument::timeloopElement ( )
pure virtual

Retourne l'élément contenant le choix de la boucle en temps.

Implémenté dans Arcane::CaseDocument.

◆ titleElement()

virtual XmlNode Arcane::ICaseDocument::titleElement ( )
pure virtual

Retourne l'élément contenant le titre du cas.

Implémenté dans Arcane::CaseDocument.

◆ userClass()

virtual String Arcane::ICaseDocument::userClass ( ) const
pure virtual

Nom de la classe d'utilisation du cas.

Implémenté dans Arcane::CaseDocument.


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