|
|
Arcane
4.1.12.0
User documentation
|
|
|
|
Arcane
4.1.12.0
User documentation
|
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. | |
Definition at line 102 of file ICaseDocument.h.
|
pure virtual |
Returns the instance containing the names of XML nodes by language.
Implements Arcane::ICaseDocumentFragment.
1.16.1