Class managing an XML document of the dataset. More...

Inheritance diagram for Arcane::CaseDocument:

Collaboration diagram for Arcane::CaseDocument:

Public Member Functions
	CaseDocument (ITraceMng sm, IXmlDocumentHolder document)
void	build () override
	Constructs the instance.
ICaseDocument *	clone () override
	Clones the document.
IXmlDocumentHolder *	documentHolder () override
	Returns the XML document of the dataset. This pointer remains the property of this class and is destroyed when this instance is destroyed.
XmlNode	documentNode () override
	Returns the document node.
XmlNode	rootElement () override
	Returns the root element.
String	language () const override
	Language used in the dataset.
String	defaultCategory () const override
	Category used for default values.
CaseNodeNames *	caseNodeNames () override
	Returns the instance containing the names of XML nodes by language.
void	addError (const CaseOptionError &case_error) override
	Adds an error to the dataset.
void	addWarning (const CaseOptionError &case_error) override
	Adds a warning to the dataset.
bool	hasError () const override
bool	hasWarnings () const override
void	printErrors (std::ostream &o) override
	Writes the errors to the stream o.
void	printWarnings (std::ostream &o) override
	Writes the warnings to the stream o.
void	clearErrorsAndWarnings () override
	Clears the recorded error and warning messages.
XmlNode	arcaneElement () override
	Returns the information element for Arcane.
XmlNode	configurationElement () override
	Returns the configuration information element.
XmlNode	timeloopElement () override
	Returns the element containing the time loop choice.
XmlNode	titleElement () override
	Returns the element containing the case title.
XmlNode	descriptionElement () override
	Returns the element containing the case description.
XmlNode	modulesElement () override
	Returns the element containing the module descriptions.
XmlNode	servicesElement () override
	Returns the element containing the service descriptions.
const XmlNodeList &	meshElements () override
	Returns the root element of the mesh information.
XmlNode	meshesElement () override
	Element containing the list of meshes (new mechanism) (can be null).
XmlNode	functionsElement () override
	Returns the root element of the functions.
String	userClass () const override
	Name of the case usage class.
void	setUserClass (const String &value) override
	Sets the name of the case usage class.
String	codeName () const override
	Name of the case code.
void	setCodeName (const String &value) override
	Sets the name of the case code.
String	codeVersion () const override
	Version number of the code corresponding to the case.
void	setCodeVersion (const String &value) override
	Sets the version number of the code.
String	codeUnitSystem () const override
	Name of the document's unit system.
void	setCodeUnitSystem (const String &value) override
	Sets the name of the document's unit system.
void	setDefaultCategory (const String &v) override
	Sets the category used for default values.
ICaseDocumentFragment *	fragment () override
	Fragment corresponding to this document.
void	setLanguage (const String &language)
Public Member Functions inherited from Arcane::TraceAccessor
	TraceAccessor (ITraceMng *m)
	Constructs an accessor via the trace manager m.
	TraceAccessor (const TraceAccessor &rhs)
	Copy constructor.
TraceAccessor &	operator= (const TraceAccessor &rhs)
	Copy assignment operator.
virtual	~TraceAccessor ()
	Frees resources.
ITraceMng *	traceMng () const
	Trace manager.
TraceMessage	info () const
	Flow for an information message.
TraceMessage	pinfo () const
	Flow for a parallel information message.
TraceMessage	info (char category) const
	Flow for an information message of a given category.
TraceMessage	pinfo (char category) const
	Flow for a parallel information message of a given category.
TraceMessage	info (bool v) const
	Flow for an information message.
TraceMessage	warning () const
	Flow for a warning message.
TraceMessage	pwarning () const
TraceMessage	error () const
	Flow for an error message.
TraceMessage	perror () const
TraceMessage	log () const
	Flow for a log message.
TraceMessage	plog () const
	Flow for a log message.
TraceMessage	logdate () const
	Flow for a log message preceded by the date.
TraceMessage	fatal () const
	Flow for a fatal error message.
TraceMessage	pfatal () const
	Flow for a parallel fatal error message.
TraceMessageDbg	debug (Trace::eDebugLevel=Trace::Medium) const
	Flow for a debug message.
Trace::eDebugLevel	configDbgLevel () const
	Debug level of the configuration file.
TraceMessage	info (Int32 verbose_level) const
	Flow for an information message of a given level.
TraceMessage	linfo () const
	Flow for an information message with the local information level of this instance.
TraceMessage	linfo (Int32 relative_level) const
	Flow for an information message with the local information level of this instance.
void	fatalMessage (const StandaloneTraceMessage &o) const

Private Member Functions
XmlNode	_forceCreateChild (XmlNode &parent, const String &us)

Additional Inherited Members
Protected Member Functions inherited from Arcane::TraceAccessor
void	_setLocalVerboseLevel (Int32 v)
Int32	_localVerboseLevel () const

Detailed Description

Class managing an XML document of the dataset.

Definition at line 99 of file CaseDocument.cc.

Constructor & Destructor Documentation

◆ CaseDocument()

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

Definition at line 248 of file CaseDocument.cc.

◆ ~CaseDocument()

Arcane::CaseDocument::~CaseDocument ( )

override

Definition at line 258 of file CaseDocument.cc.

Member Function Documentation

◆ _forceCreateChild()

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

private

Definition at line 351 of file CaseDocument.cc.

◆ addError()

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

inlineoverridevirtual

Adds an error to the dataset.

Implements Arcane::ICaseDocumentFragment.

Definition at line 120 of file CaseDocument.cc.

◆ addWarning()

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

inlineoverridevirtual

Adds a warning to the dataset.

Implements Arcane::ICaseDocumentFragment.

Definition at line 121 of file CaseDocument.cc.

◆ arcaneElement()

XmlNode Arcane::CaseDocument::arcaneElement ( )

inlineoverridevirtual

Returns the information element for Arcane.

Implements Arcane::ICaseDocument.

Definition at line 131 of file CaseDocument.cc.

◆ build()

void Arcane::CaseDocument::build ( )

overridevirtual

Constructs the instance.

Implements Arcane::ICaseDocument.

Definition at line 295 of file CaseDocument.cc.

References Arcane::XmlNode::attrValue(), caseNodeNames(), Arcane::XmlNode::child(), and Arcane::XmlNode::children().

Here is the call graph for this function:

◆ caseNodeNames()

CaseNodeNames * Arcane::CaseDocument::caseNodeNames ( )

inlineoverridevirtual

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

Implements Arcane::ICaseDocument.

Definition at line 119 of file CaseDocument.cc.

Referenced by build(), setCodeName(), setCodeUnitSystem(), setCodeVersion(), and setUserClass().

Here is the caller graph for this function:

◆ clearErrorsAndWarnings()

void Arcane::CaseDocument::clearErrorsAndWarnings ( )

inlineoverridevirtual

Clears the recorded error and warning messages.

Implements Arcane::ICaseDocumentFragment.

Definition at line 126 of file CaseDocument.cc.

◆ clone()

ICaseDocument * Arcane::CaseDocument::clone ( )

overridevirtual

Clones the document.

Implements Arcane::ICaseDocument.

Definition at line 332 of file CaseDocument.cc.

◆ codeName()

String Arcane::CaseDocument::codeName ( ) const

inlineoverridevirtual

Name of the case code.

Implements Arcane::ICaseDocument.

Definition at line 149 of file CaseDocument.cc.

◆ codeUnitSystem()

String Arcane::CaseDocument::codeUnitSystem ( ) const

inlineoverridevirtual

Name of the document's unit system.

Implements Arcane::ICaseDocument.

Definition at line 155 of file CaseDocument.cc.

◆ codeVersion()

String Arcane::CaseDocument::codeVersion ( ) const

inlineoverridevirtual

Version number of the code corresponding to the case.

Implements Arcane::ICaseDocument.

Definition at line 152 of file CaseDocument.cc.

◆ configurationElement()

XmlNode Arcane::CaseDocument::configurationElement ( )

inlineoverridevirtual

Returns the configuration information element.

Implements Arcane::ICaseDocument.

Definition at line 132 of file CaseDocument.cc.

◆ defaultCategory()

String Arcane::CaseDocument::defaultCategory ( ) const

inlineoverridevirtual

Category used for default values.

Implements Arcane::ICaseDocumentFragment.

Definition at line 118 of file CaseDocument.cc.

◆ descriptionElement()

XmlNode Arcane::CaseDocument::descriptionElement ( )

inlineoverridevirtual

Returns the element containing the case description.

Implements Arcane::ICaseDocument.

Definition at line 136 of file CaseDocument.cc.

◆ documentHolder()

IXmlDocumentHolder * Arcane::CaseDocument::documentHolder ( )

inlineoverridevirtual

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

Implements Arcane::ICaseDocumentFragment.

Definition at line 114 of file CaseDocument.cc.

◆ documentNode()

XmlNode Arcane::CaseDocument::documentNode ( )

inlineoverridevirtual

Returns the document node.

Implements Arcane::ICaseDocumentFragment.

Definition at line 115 of file CaseDocument.cc.

◆ fragment()

ICaseDocumentFragment * Arcane::CaseDocument::fragment ( )

inlineoverridevirtual

Fragment corresponding to this document.

Implements Arcane::ICaseDocument.

Definition at line 160 of file CaseDocument.cc.

◆ functionsElement()

XmlNode Arcane::CaseDocument::functionsElement ( )

inlineoverridevirtual

Returns the root element of the functions.

Implements Arcane::ICaseDocument.

Definition at line 144 of file CaseDocument.cc.

◆ hasError()

bool Arcane::CaseDocument::hasError ( ) const

inlineoverridevirtual

Implements Arcane::ICaseDocumentFragment.

Definition at line 122 of file CaseDocument.cc.

◆ hasWarnings()

bool Arcane::CaseDocument::hasWarnings ( ) const

inlineoverridevirtual

Implements Arcane::ICaseDocumentFragment.

Definition at line 123 of file CaseDocument.cc.

◆ language()

String Arcane::CaseDocument::language ( ) const

inlineoverridevirtual

Language used in the dataset.

Implements Arcane::ICaseDocumentFragment.

Definition at line 117 of file CaseDocument.cc.

◆ meshElements()

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

inlineoverridevirtual

Returns the root element of the mesh information.

Implements Arcane::ICaseDocument.

Definition at line 140 of file CaseDocument.cc.

◆ meshesElement()

XmlNode Arcane::CaseDocument::meshesElement ( )

inlineoverridevirtual

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

Implements Arcane::ICaseDocument.

Definition at line 142 of file CaseDocument.cc.

◆ modulesElement()

XmlNode Arcane::CaseDocument::modulesElement ( )

inlineoverridevirtual

Returns the element containing the module descriptions.

Implements Arcane::ICaseDocument.

Definition at line 137 of file CaseDocument.cc.

◆ printErrors()

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

inlineoverridevirtual

Writes the errors to the stream o.

Implements Arcane::ICaseDocumentFragment.

Definition at line 124 of file CaseDocument.cc.

◆ printWarnings()

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

inlineoverridevirtual

Writes the warnings to the stream o.

Implements Arcane::ICaseDocumentFragment.

Definition at line 125 of file CaseDocument.cc.

◆ rootElement()

XmlNode Arcane::CaseDocument::rootElement ( )

inlineoverridevirtual

Returns the root element.

Implements Arcane::ICaseDocumentFragment.

Definition at line 116 of file CaseDocument.cc.

◆ servicesElement()

XmlNode Arcane::CaseDocument::servicesElement ( )

inlineoverridevirtual

Returns the element containing the service descriptions.

Implements Arcane::ICaseDocument.

Definition at line 138 of file CaseDocument.cc.

◆ setCodeName()

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

overridevirtual

Sets the name of the case code.

Implements Arcane::ICaseDocument.

Definition at line 373 of file CaseDocument.cc.

References caseNodeNames().

Here is the call graph for this function:

◆ setCodeUnitSystem()

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

overridevirtual

Sets the name of the document's unit system.

Implements Arcane::ICaseDocument.

Definition at line 393 of file CaseDocument.cc.

References caseNodeNames().

Here is the call graph for this function:

◆ setCodeVersion()

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

overridevirtual

Sets the version number of the code.

Implements Arcane::ICaseDocument.

Definition at line 383 of file CaseDocument.cc.

References caseNodeNames().

Here is the call graph for this function:

◆ setDefaultCategory()

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

inlineoverridevirtual

Sets the category used for default values.

Implements Arcane::ICaseDocument.

Definition at line 158 of file CaseDocument.cc.

◆ setLanguage()

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

inline

Definition at line 165 of file CaseDocument.cc.

◆ setUserClass()

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

overridevirtual

Sets the name of the case usage class.

Implements Arcane::ICaseDocument.

Definition at line 363 of file CaseDocument.cc.

References caseNodeNames().

Here is the call graph for this function:

◆ timeloopElement()

XmlNode Arcane::CaseDocument::timeloopElement ( )

inlineoverridevirtual

Returns the element containing the time loop choice.

Implements Arcane::ICaseDocument.

Definition at line 134 of file CaseDocument.cc.

◆ titleElement()

XmlNode Arcane::CaseDocument::titleElement ( )

inlineoverridevirtual

Returns the element containing the case title.

Implements Arcane::ICaseDocument.

Definition at line 135 of file CaseDocument.cc.

◆ userClass()

String Arcane::CaseDocument::userClass ( ) const

inlineoverridevirtual

Name of the case usage class.

Implements Arcane::ICaseDocument.

Definition at line 146 of file CaseDocument.cc.

Member Data Documentation

◆ m_arcane_elem

XmlNode Arcane::CaseDocument::m_arcane_elem

private

Definition at line 176 of file CaseDocument.cc.

◆ m_code_name

String Arcane::CaseDocument::m_code_name

private

Definition at line 188 of file CaseDocument.cc.

◆ m_code_unit_system

String Arcane::CaseDocument::m_code_unit_system

private

Definition at line 190 of file CaseDocument.cc.

◆ m_code_version

String Arcane::CaseDocument::m_code_version

private

Definition at line 189 of file CaseDocument.cc.

◆ m_configuration_elem

XmlNode Arcane::CaseDocument::m_configuration_elem

private

Definition at line 177 of file CaseDocument.cc.

◆ m_description_elem

XmlNode Arcane::CaseDocument::m_description_elem

private

Definition at line 180 of file CaseDocument.cc.

◆ m_fragment

CaseDocumentFragment Arcane::CaseDocument::m_fragment

private

Definition at line 174 of file CaseDocument.cc.

◆ m_functions_elem

XmlNode Arcane::CaseDocument::m_functions_elem

private

Definition at line 184 of file CaseDocument.cc.

◆ m_mesh_elems

XmlNodeList Arcane::CaseDocument::m_mesh_elems

private

Definition at line 183 of file CaseDocument.cc.

◆ m_meshes_elem

XmlNode Arcane::CaseDocument::m_meshes_elem

private

Definition at line 185 of file CaseDocument.cc.

◆ m_modules_elem

XmlNode Arcane::CaseDocument::m_modules_elem

private

Definition at line 181 of file CaseDocument.cc.

◆ m_services_elem

XmlNode Arcane::CaseDocument::m_services_elem

private

Definition at line 182 of file CaseDocument.cc.

◆ m_timeloop_elem

XmlNode Arcane::CaseDocument::m_timeloop_elem

private

Definition at line 178 of file CaseDocument.cc.

◆ m_title_elem

XmlNode Arcane::CaseDocument::m_title_elem

private

Definition at line 179 of file CaseDocument.cc.

◆ m_user_class

String Arcane::CaseDocument::m_user_class

private

Definition at line 187 of file CaseDocument.cc.

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

CaseDocument.cc

Private Attributes
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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CaseDocument()

◆ ~CaseDocument()

Member Function Documentation

◆ _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()

Member Data Documentation

◆ 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