Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::ICaseDocument Class Referenceabstract

Interface of a class managing an XML document of the dataset. More...

#include <arcane/core/ICaseDocument.h>

Inheritance diagram for Arcane::ICaseDocument:
Collaboration diagram for Arcane::ICaseDocument:

Public Member Functions

virtual void build ()=0
 Constructs the instance.
virtual ICaseDocument * clone ()=0
 Clones the document.
virtual CaseNodeNames * caseNodeNames ()=0
 Returns the instance containing the names of XML nodes by language.
virtual XmlNode arcaneElement ()=0
 Returns the information element for Arcane.
virtual XmlNode configurationElement ()=0
 Returns the configuration information element.
virtual XmlNode timeloopElement ()=0
 Returns the element containing the time loop choice.
virtual XmlNode titleElement ()=0
 Returns the element containing the case title.
virtual XmlNode descriptionElement ()=0
 Returns the element containing the case description.
virtual XmlNode modulesElement ()=0
 Returns the element containing the module descriptions.
virtual XmlNode servicesElement ()=0
 Returns the element containing the service descriptions.
virtual XmlNode functionsElement ()=0
 Returns the root element of the functions.
virtual const XmlNodeList & meshElements ()=0
 Returns the root element of the mesh information.
virtual XmlNode meshesElement ()=0
 Element containing the list of meshes (new mechanism) (can be null).
virtual String userClass () const =0
 Name of the case usage class.
virtual void setUserClass (const String &value)=0
 Sets the name of the case usage class.
virtual String codeName () const =0
 Name of the case code.
virtual void setCodeName (const String &value)=0
 Sets the name of the case code.
virtual String codeVersion () const =0
 Version number of the code corresponding to the case.
virtual void setCodeVersion (const String &value)=0
 Sets the version number of the code.
virtual String codeUnitSystem () const =0
 Name of the document's unit system.
virtual void setCodeUnitSystem (const String &value)=0
 Sets the name of the document's unit system.
virtual void setDefaultCategory (const String &v)=0
 Sets the category used for default values.
virtual ICaseDocumentFragment * fragment ()=0
 Fragment corresponding to this document.
Public Member Functions inherited from Arcane::ICaseDocumentFragment
virtual IXmlDocumentHolder * documentHolder ()=0
 Returns the XML document of the dataset. This pointer remains the property of this class and is destroyed when this instance is destroyed.
virtual XmlNode documentNode ()=0
 Returns the document node.
virtual XmlNode rootElement ()=0
 Returns the root element.
virtual String language () const =0
 Language used in the dataset.
virtual String defaultCategory () const =0
 Category used for default values.
virtual void addError (const CaseOptionError &case_error)=0
 Adds an error to the dataset.
virtual void addWarning (const CaseOptionError &case_error)=0
 Adds a warning to the dataset.
virtual bool hasError () const =0
virtual bool hasWarnings () const =0
virtual void printErrors (std::ostream &o)=0
 Writes the errors to the stream o.
virtual void printWarnings (std::ostream &o)=0
 Writes the warnings to the stream o.
virtual void clearErrorsAndWarnings ()=0
 Clears the recorded error and warning messages.

Detailed Description

Interface of a class managing an XML document of the dataset.

Todo
Stop inheriting from ICaseDocumentFragment (use the fragment() method instead)

Definition at line 102 of file ICaseDocument.h.

Member Function Documentation

◆ arcaneElement()

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

Returns the information element for Arcane.

Implemented in Arcane::CaseDocument.

Referenced by Arcane::CaseMng::_searchInvalidOptions().

Here is the caller graph for this function:

◆ build()

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

Constructs the instance.

Implemented in Arcane::CaseDocument.

◆ caseNodeNames()

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

Returns the instance containing the names of XML nodes by language.

Implements Arcane::ICaseDocumentFragment.

Implemented in Arcane::CaseDocument.

Referenced by Arcane::SubDomain::allocateMeshes().

Here is the caller graph for this function:

◆ clone()

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

Clones the document.

Implemented in Arcane::CaseDocument.

◆ codeName()

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

Name of the case code.

Implemented in Arcane::CaseDocument.

◆ codeUnitSystem()

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

Name of the document's unit system.

Implemented in Arcane::CaseDocument.

◆ codeVersion()

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

Version number of the code corresponding to the case.

Implemented in Arcane::CaseDocument.

◆ configurationElement()

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

Returns the configuration information element.

Implemented in Arcane::CaseDocument.

Referenced by Arcane::SubDomain::initialize().

Here is the caller graph for this function:

◆ descriptionElement()

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

Returns the element containing the case description.

Implemented in Arcane::CaseDocument.

◆ fragment()

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

Fragment corresponding to this document.

Implemented in Arcane::CaseDocument.

Referenced by Arcane::CaseMng::_searchInvalidOptions(), and Arcane::CaseMng::caseDocumentFragment().

Here is the caller graph for this function:

◆ functionsElement()

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

Returns the root element of the functions.

Implemented in Arcane::CaseDocument.

Referenced by Arcane::CaseMng::_searchInvalidOptions().

Here is the caller graph for this function:

◆ meshElements()

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

Returns the root element of the mesh information.

Implemented in Arcane::CaseDocument.

Referenced by Arcane::CaseMng::_searchInvalidOptions().

Here is the caller graph for this function:

◆ meshesElement()

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

Element containing the list of meshes (new mechanism) (can be null).

Implemented in Arcane::CaseDocument.

Referenced by Arcane::SubDomain::initialize().

Here is the caller graph for this function:

◆ modulesElement()

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

Returns the element containing the module descriptions.

Implemented in Arcane::CaseDocument.

Referenced by Arcane::TimeLoopMng::_fillModuleStateMap().

Here is the caller graph for this function:

◆ servicesElement()

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

Returns the element containing the service descriptions.

Implemented in Arcane::CaseDocument.

◆ setCodeName()

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

Sets the name of the case code.

Implemented in Arcane::CaseDocument.

◆ setCodeUnitSystem()

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

Sets the name of the document's unit system.

Implemented in Arcane::CaseDocument.

◆ setCodeVersion()

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

Sets the version number of the code.

Implemented in Arcane::CaseDocument.

◆ setDefaultCategory()

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

Sets the category used for default values.

Implemented in Arcane::CaseDocument.

◆ setUserClass()

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

Sets the name of the case usage class.

Implemented in Arcane::CaseDocument.

◆ timeloopElement()

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

Returns the element containing the time loop choice.

Implemented in Arcane::CaseDocument.

Referenced by Arcane::TimeLoopReader::setUsedTimeLoop().

Here is the caller graph for this function:

◆ titleElement()

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

Returns the element containing the case title.

Implemented in Arcane::CaseDocument.

◆ userClass()

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

Name of the case usage class.

Implemented in Arcane::CaseDocument.

The documentation for this class was generated from the following file: