Classe gérant un document XML du jeu de données. Plus de détails...

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

Graphe de collaboration de Arcane::CaseDocument:

Fonctions membres publiques
	CaseDocument (ITraceMng sm, IXmlDocumentHolder document)

void	build () override
	Construit l'instance.

ICaseDocument *	clone () override
	Clone le document.

IXmlDocumentHolder *	documentHolder () override
	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.

XmlNode	documentNode () override
	Retourne le noeud document.

XmlNode	rootElement () override
	Retourne l'élément racine.

String	language () const override
	Langage utilisé dans le jeu de données.

String	defaultCategory () const override
	Catégorie utilisée pour les valeurs par défaut.

CaseNodeNames *	caseNodeNames () override
	Retourne l'instance contenant les noms des noeuds XML par langage.

void	addError (const CaseOptionError &case_error) override
	Ajoute une erreur dans le jeu de données.

void	addWarning (const CaseOptionError &case_error) override
	Ajoute un avertissement dans le jeu de données.

bool	hasError () const override

bool	hasWarnings () const override

void	printErrors (std::ostream &o) override
	Ecrit les erreurs dans le flot o.

void	printWarnings (std::ostream &o) override
	Ecrit les avertissements dans le flot o.

void	clearErrorsAndWarnings () override
	Supprime les messages d'erreurs et d'avertissements enregistrés.

XmlNode	arcaneElement () override
	Retourne l'élément des informations pour Arcane.

XmlNode	configurationElement () override
	Retourne l'élément des informations de configuration.

XmlNode	timeloopElement () override
	Retourne l'élément contenant le choix de la boucle en temps.

XmlNode	titleElement () override
	Retourne l'élément contenant le titre du cas.

XmlNode	descriptionElement () override
	Retourne l'élément contenant la description du cas.

XmlNode	modulesElement () override
	Retourne l'élément contenant la description des modules.

XmlNode	servicesElement () override
	Retourne l'élément contenant la description des services.

const XmlNodeList &	meshElements () override
	Retourne l'élément racine des informations de maillage.

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

XmlNode	functionsElement () override
	Retourne l'élément racine des fonctions.

String	userClass () const override
	Nom de la classe d'utilisation du cas.

void	setUserClass (const String &value) override
	Positionne le nom de la classe d'utilisation du cas.

String	codeName () const override
	Nom du code du cas.

void	setCodeName (const String &value) override
	Positionne le nom du code du cas.

String	codeVersion () const override
	Numéro de version du code correspondant au cas.

void	setCodeVersion (const String &value) override
	Positionne le numéro de version du code.

String	codeUnitSystem () const override
	Nom du système d'unité du document.

void	setCodeUnitSystem (const String &value) override
	Positionne le nom du systmème d'unité du document.

void	setDefaultCategory (const String &v) override
	Positionne la catégorie utilisée pour les valeurs par défaut.

ICaseDocumentFragment *	fragment () override
	Fragment correspondant à ce document.

void	setLanguage (const String &language)

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 privées
XmlNode	_forceCreateChild (XmlNode &parent, const String &us)

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

Int32	_localVerboseLevel () const

Description détaillée

Classe gérant un document XML du jeu de données.

Définition à la ligne 98 du fichier CaseDocument.cc.

Documentation des constructeurs et destructeur

◆ CaseDocument()

Arcane::CaseDocument::CaseDocument	(	ITraceMng *	sm,
		IXmlDocumentHolder *	document
	)

Définition à la ligne 247 du fichier CaseDocument.cc.

◆ ~CaseDocument()

Arcane::CaseDocument::~CaseDocument ( )

override

Définition à la ligne 257 du fichier CaseDocument.cc.

Documentation des fonctions membres

◆ _forceCreateChild()

XmlNode Arcane::CaseDocument::_forceCreateChild	(	XmlNode &	parent,
		const String &	us
	)

private

Définition à la ligne 350 du fichier CaseDocument.cc.

◆ addError()

void Arcane::CaseDocument::addError ( const CaseOptionError & case_error )

inlineoverridevirtual

Ajoute une erreur dans le jeu de données.

Implémente Arcane::ICaseDocumentFragment.

Définition à la ligne 119 du fichier CaseDocument.cc.

Références Arcane::CaseDocumentFragment::addError().

◆ addWarning()

void Arcane::CaseDocument::addWarning ( const CaseOptionError & case_error )

inlineoverridevirtual

Ajoute un avertissement dans le jeu de données.

Implémente Arcane::ICaseDocumentFragment.

Définition à la ligne 120 du fichier CaseDocument.cc.

Références Arcane::CaseDocumentFragment::addWarning().

◆ arcaneElement()

XmlNode Arcane::CaseDocument::arcaneElement ( )

inlineoverridevirtual

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

Implémente Arcane::ICaseDocument.

Définition à la ligne 130 du fichier CaseDocument.cc.

◆ build()

void Arcane::CaseDocument::build ( )

overridevirtual

Construit l'instance.

Implémente Arcane::ICaseDocument.

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

Références caseNodeNames().

◆ caseNodeNames()

CaseNodeNames * Arcane::CaseDocument::caseNodeNames ( )

inlineoverridevirtual

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

Implémente Arcane::ICaseDocument.

Définition à la ligne 118 du fichier CaseDocument.cc.

Référencé par build(), setCodeName(), setCodeUnitSystem(), setCodeVersion(), et setUserClass().

◆ clearErrorsAndWarnings()

void Arcane::CaseDocument::clearErrorsAndWarnings ( )

inlineoverridevirtual

Supprime les messages d'erreurs et d'avertissements enregistrés.

Implémente Arcane::ICaseDocumentFragment.

Définition à la ligne 125 du fichier CaseDocument.cc.

Références Arcane::CaseDocumentFragment::clearErrorsAndWarnings().

◆ clone()

ICaseDocument * Arcane::CaseDocument::clone ( )

overridevirtual

Clone le document.

Implémente Arcane::ICaseDocument.

Définition à la ligne 331 du fichier CaseDocument.cc.

◆ codeName()

String Arcane::CaseDocument::codeName ( ) const

inlineoverridevirtual

Nom du code du cas.

Implémente Arcane::ICaseDocument.

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

◆ codeUnitSystem()

String Arcane::CaseDocument::codeUnitSystem ( ) const

inlineoverridevirtual

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

Implémente Arcane::ICaseDocument.

Définition à la ligne 154 du fichier CaseDocument.cc.

◆ codeVersion()

String Arcane::CaseDocument::codeVersion ( ) const

inlineoverridevirtual

Numéro de version du code correspondant au cas.

Implémente Arcane::ICaseDocument.

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

◆ configurationElement()

XmlNode Arcane::CaseDocument::configurationElement ( )

inlineoverridevirtual

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

Implémente Arcane::ICaseDocument.

Définition à la ligne 131 du fichier CaseDocument.cc.

◆ defaultCategory()

String Arcane::CaseDocument::defaultCategory ( ) const

inlineoverridevirtual

Catégorie utilisée pour les valeurs par défaut.

Implémente Arcane::ICaseDocumentFragment.

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

◆ descriptionElement()

XmlNode Arcane::CaseDocument::descriptionElement ( )

inlineoverridevirtual

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

Implémente Arcane::ICaseDocument.

Définition à la ligne 135 du fichier CaseDocument.cc.

◆ documentHolder()

IXmlDocumentHolder * Arcane::CaseDocument::documentHolder ( )

inlineoverridevirtual

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.

Implémente Arcane::ICaseDocumentFragment.

Définition à la ligne 113 du fichier CaseDocument.cc.

◆ documentNode()

XmlNode Arcane::CaseDocument::documentNode ( )

inlineoverridevirtual

Retourne le noeud document.

Implémente Arcane::ICaseDocumentFragment.

Définition à la ligne 114 du fichier CaseDocument.cc.

◆ fragment()

ICaseDocumentFragment * Arcane::CaseDocument::fragment ( )

inlineoverridevirtual

Fragment correspondant à ce document.

Implémente Arcane::ICaseDocument.

Définition à la ligne 159 du fichier CaseDocument.cc.

◆ functionsElement()

XmlNode Arcane::CaseDocument::functionsElement ( )

inlineoverridevirtual

Retourne l'élément racine des fonctions.

Implémente Arcane::ICaseDocument.

Définition à la ligne 143 du fichier CaseDocument.cc.

◆ hasError()

bool Arcane::CaseDocument::hasError ( ) const

inlineoverridevirtual

Implémente Arcane::ICaseDocumentFragment.

Définition à la ligne 121 du fichier CaseDocument.cc.

◆ hasWarnings()

bool Arcane::CaseDocument::hasWarnings ( ) const

inlineoverridevirtual

Implémente Arcane::ICaseDocumentFragment.

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

◆ language()

String Arcane::CaseDocument::language ( ) const

inlineoverridevirtual

Langage utilisé dans le jeu de données.

Implémente Arcane::ICaseDocumentFragment.

Définition à la ligne 116 du fichier CaseDocument.cc.

◆ meshElements()

const XmlNodeList & Arcane::CaseDocument::meshElements ( )

inlineoverridevirtual

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

Implémente Arcane::ICaseDocument.

Définition à la ligne 139 du fichier CaseDocument.cc.

◆ meshesElement()

XmlNode Arcane::CaseDocument::meshesElement ( )

inlineoverridevirtual

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

Implémente Arcane::ICaseDocument.

Définition à la ligne 141 du fichier CaseDocument.cc.

◆ modulesElement()

XmlNode Arcane::CaseDocument::modulesElement ( )

inlineoverridevirtual

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

Implémente Arcane::ICaseDocument.

Définition à la ligne 136 du fichier CaseDocument.cc.

◆ printErrors()

void Arcane::CaseDocument::printErrors ( std::ostream & o )

inlineoverridevirtual

Ecrit les erreurs dans le flot o.

Implémente Arcane::ICaseDocumentFragment.

Définition à la ligne 123 du fichier CaseDocument.cc.

Références Arcane::CaseDocumentFragment::printErrors().

◆ printWarnings()

void Arcane::CaseDocument::printWarnings ( std::ostream & o )

inlineoverridevirtual

Ecrit les avertissements dans le flot o.

Implémente Arcane::ICaseDocumentFragment.

Définition à la ligne 124 du fichier CaseDocument.cc.

Références Arcane::CaseDocumentFragment::printWarnings().

◆ rootElement()

XmlNode Arcane::CaseDocument::rootElement ( )

inlineoverridevirtual

Retourne l'élément racine.

Implémente Arcane::ICaseDocumentFragment.

Définition à la ligne 115 du fichier CaseDocument.cc.

◆ servicesElement()

XmlNode Arcane::CaseDocument::servicesElement ( )

inlineoverridevirtual

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

Implémente Arcane::ICaseDocument.

Définition à la ligne 137 du fichier CaseDocument.cc.

◆ setCodeName()

void Arcane::CaseDocument::setCodeName ( const String & value )

overridevirtual

Positionne le nom du code du cas.

Implémente Arcane::ICaseDocument.

Définition à la ligne 372 du fichier CaseDocument.cc.

Références caseNodeNames(), et Arcane::XmlNode::setAttrValue().

◆ setCodeUnitSystem()

void Arcane::CaseDocument::setCodeUnitSystem ( const String & value )

overridevirtual

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

Implémente Arcane::ICaseDocument.

Définition à la ligne 392 du fichier CaseDocument.cc.

Références caseNodeNames(), et Arcane::XmlNode::setAttrValue().

◆ setCodeVersion()

void Arcane::CaseDocument::setCodeVersion ( const String & value )

overridevirtual

Positionne le numéro de version du code.

Implémente Arcane::ICaseDocument.

Définition à la ligne 382 du fichier CaseDocument.cc.

Références caseNodeNames(), et Arcane::XmlNode::setAttrValue().

◆ setDefaultCategory()

void Arcane::CaseDocument::setDefaultCategory ( const String & v )

inlineoverridevirtual

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

Implémente Arcane::ICaseDocument.

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

◆ setLanguage()

void Arcane::CaseDocument::setLanguage ( const String & language )

inline

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

◆ setUserClass()

void Arcane::CaseDocument::setUserClass ( const String & value )

overridevirtual

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

Implémente Arcane::ICaseDocument.

Définition à la ligne 362 du fichier CaseDocument.cc.

Références caseNodeNames(), et Arcane::XmlNode::setAttrValue().

◆ timeloopElement()

XmlNode Arcane::CaseDocument::timeloopElement ( )

inlineoverridevirtual

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

Implémente Arcane::ICaseDocument.

Définition à la ligne 133 du fichier CaseDocument.cc.

◆ titleElement()

XmlNode Arcane::CaseDocument::titleElement ( )

inlineoverridevirtual

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

Implémente Arcane::ICaseDocument.

Définition à la ligne 134 du fichier CaseDocument.cc.

◆ userClass()

String Arcane::CaseDocument::userClass ( ) const

inlineoverridevirtual

Nom de la classe d'utilisation du cas.

Implémente Arcane::ICaseDocument.

Définition à la ligne 145 du fichier CaseDocument.cc.

Documentation des données membres

◆ m_arcane_elem

XmlNode Arcane::CaseDocument::m_arcane_elem

private

Définition à la ligne 175 du fichier CaseDocument.cc.

◆ m_code_name

String Arcane::CaseDocument::m_code_name

private

Définition à la ligne 187 du fichier CaseDocument.cc.

◆ m_code_unit_system

String Arcane::CaseDocument::m_code_unit_system

private

Définition à la ligne 189 du fichier CaseDocument.cc.

◆ m_code_version

String Arcane::CaseDocument::m_code_version

private

Définition à la ligne 188 du fichier CaseDocument.cc.

◆ m_configuration_elem

XmlNode Arcane::CaseDocument::m_configuration_elem

private

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

◆ m_description_elem

XmlNode Arcane::CaseDocument::m_description_elem

private

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

◆ m_fragment

CaseDocumentFragment Arcane::CaseDocument::m_fragment

private

Définition à la ligne 173 du fichier CaseDocument.cc.

◆ m_functions_elem

XmlNode Arcane::CaseDocument::m_functions_elem

private

Définition à la ligne 183 du fichier CaseDocument.cc.

◆ m_mesh_elems

XmlNodeList Arcane::CaseDocument::m_mesh_elems

private

Définition à la ligne 182 du fichier CaseDocument.cc.

◆ m_meshes_elem

XmlNode Arcane::CaseDocument::m_meshes_elem

private

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

◆ m_modules_elem

XmlNode Arcane::CaseDocument::m_modules_elem

private

Définition à la ligne 180 du fichier CaseDocument.cc.

◆ m_services_elem

XmlNode Arcane::CaseDocument::m_services_elem

private

Définition à la ligne 181 du fichier CaseDocument.cc.

◆ m_timeloop_elem

XmlNode Arcane::CaseDocument::m_timeloop_elem

private

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

◆ m_title_elem

XmlNode Arcane::CaseDocument::m_title_elem

private

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

◆ m_user_class

String Arcane::CaseDocument::m_user_class

private

Définition à la ligne 186 du fichier CaseDocument.cc.

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

CaseDocument.cc

Attributs privés
CaseDocumentFragment	m_fragment

XmlNode	m_arcane_elem

XmlNode	m_configuration_elem

XmlNode	m_timeloop_elem

XmlNode	m_title_elem

XmlNode	m_description_elem

XmlNode	m_modules_elem

XmlNode	m_services_elem

XmlNodeList	m_mesh_elems

XmlNode	m_functions_elem

XmlNode	m_meshes_elem

String	m_user_class

String	m_code_name

String	m_code_version

String	m_code_unit_system

Fonctions membres publiques

Fonctions membres privées

Attributs privés

Membres hérités additionnels

Description détaillée

Documentation des constructeurs et destructeur

◆ CaseDocument()

◆ ~CaseDocument()

Documentation des fonctions membres

◆ _forceCreateChild()

◆ addError()

◆ addWarning()

◆ arcaneElement()

◆ build()

◆ caseNodeNames()

◆ clearErrorsAndWarnings()

◆ clone()

◆ codeName()

◆ codeUnitSystem()

◆ codeVersion()

◆ configurationElement()

◆ defaultCategory()

◆ descriptionElement()

◆ documentHolder()

◆ documentNode()

◆ fragment()

◆ functionsElement()

◆ hasError()

◆ hasWarnings()

◆ language()

◆ meshElements()

◆ meshesElement()

◆ modulesElement()

◆ printErrors()

◆ printWarnings()

◆ rootElement()

◆ servicesElement()

◆ setCodeName()

◆ setCodeUnitSystem()

◆ setCodeVersion()

◆ setDefaultCategory()

◆ setLanguage()

◆ setUserClass()

◆ timeloopElement()

◆ titleElement()

◆ userClass()

Documentation des données membres

◆ m_arcane_elem

◆ m_code_name

◆ m_code_unit_system

◆ m_code_version

◆ m_configuration_elem

◆ m_description_elem

◆ m_fragment

◆ m_functions_elem

◆ m_mesh_elems

◆ m_meshes_elem

◆ m_modules_elem

◆ m_services_elem

◆ m_timeloop_elem

◆ m_title_elem

◆ m_user_class