Arcane::ICaseDocumentFragment Class Reference

Interface of a part of a dataset. More...

#include <arcane/core/ICaseDocument.h>

Inheritance diagram for Arcane::ICaseDocumentFragment:

Collaboration diagram for Arcane::ICaseDocumentFragment:

Public Member Functions
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 CaseNodeNames *	caseNodeNames ()=0
	Returns the instance containing the names of XML nodes by language.
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 part of a dataset.

Definition at line 40 of file ICaseDocument.h.

Member Function Documentation

addError()

virtual void Arcane::ICaseDocumentFragment::addError ( const CaseOptionError & case_error )

pure virtual

Adds an error to the dataset.

Implemented in Arcane::CaseDocument, and Arcane::CaseDocumentFragment.

Referenced by Arcane::CaseOptionError::addError(), Arcane::CaseOptionError::addInvalidTypeError(), Arcane::CaseOptionError::addInvalidTypeError(), and Arcane::CaseOptionError::addOptionNotFoundError().

Here is the caller graph for this function:

addWarning()

virtual void Arcane::ICaseDocumentFragment::addWarning ( const CaseOptionError & case_error )

pure virtual

Adds a warning to the dataset.

Implemented in Arcane::CaseDocument, and Arcane::CaseDocumentFragment.

Referenced by Arcane::CaseOptionError::addWarning().

Here is the caller graph for this function:

caseNodeNames()

virtual CaseNodeNames * Arcane::ICaseDocumentFragment::caseNodeNames ( )

pure virtual

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

Implemented in Arcane::CaseDocument, Arcane::CaseDocumentFragment, and Arcane::ICaseDocument.

Referenced by Arcane::CaseOptions::read().

Here is the caller graph for this function:

clearErrorsAndWarnings()

virtual void Arcane::ICaseDocumentFragment::clearErrorsAndWarnings ( )

pure virtual

Clears the recorded error and warning messages.

Implemented in Arcane::CaseDocument, and Arcane::CaseDocumentFragment.

Referenced by Arcane::CaseMng::internalReadOneOption(), and Arcane::CaseMng::readOptions().

Here is the caller graph for this function:

defaultCategory()

virtual String Arcane::ICaseDocumentFragment::defaultCategory ( ) const

pure virtual

Category used for default values.

Implemented in Arcane::CaseDocument, and Arcane::CaseDocumentFragment.

documentHolder()

virtual IXmlDocumentHolder * Arcane::ICaseDocumentFragment::documentHolder ( )

pure virtual

Returns the XML document of the dataset. This pointer remains the property of this class and is destroyed when this instance is destroyed.

Implemented in Arcane::CaseDocument, and Arcane::CaseDocumentFragment.

documentNode()

virtual XmlNode Arcane::ICaseDocumentFragment::documentNode ( )

pure virtual

Returns the document node.

Implemented in Arcane::CaseDocument, and Arcane::CaseDocumentFragment.

language()

virtual String Arcane::ICaseDocumentFragment::language ( ) const

pure virtual

Language used in the dataset.

Implemented in Arcane::CaseDocument, and Arcane::CaseDocumentFragment.

Referenced by Arcane::TimeLoopMng::_fillModuleFactoryMap(), Arcane::LimaMeshReaderService::readMeshFromFile(), and Arcane::CaseMng::readOptions().

Here is the caller graph for this function:

printErrors()

virtual void Arcane::ICaseDocumentFragment::printErrors ( std::ostream & o )

pure virtual

Writes the errors to the stream o.

Implemented in Arcane::CaseDocument, and Arcane::CaseDocumentFragment.

printWarnings()

virtual void Arcane::ICaseDocumentFragment::printWarnings ( std::ostream & o )

pure virtual

Writes the warnings to the stream o.

Implemented in Arcane::CaseDocument, and Arcane::CaseDocumentFragment.

rootElement()

virtual XmlNode Arcane::ICaseDocumentFragment::rootElement ( )

pure virtual

Returns the root element.

Implemented in Arcane::CaseDocument, and Arcane::CaseDocumentFragment.

Referenced by Arcane::CaseMng::_searchInvalidOptions(), and Arcane::mesh::DynamicMesh::initializeVariables().

Here is the caller graph for this function:

---

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

• ICaseDocument.h