Inheritance diagram for Arcane::CaseDocumentFragment:

Collaboration diagram for Arcane::CaseDocumentFragment:

Public Member Functions
	CaseDocumentFragment (ITraceMng tm, IXmlDocumentHolder document)
void	init ()
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.
ICaseDocumentFragment *	fragment ()
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

Public Attributes
CaseNodeNames *	m_case_node_names = nullptr
ScopedPtrT< IXmlDocumentHolder >	m_doc_holder
XmlNode	m_document_node
XmlNode	m_root_elem
String	m_language
String	m_default_category
UniqueArray< CaseOptionError >	m_errors
UniqueArray< CaseOptionError >	m_warnings

Private Member Functions
void	_assignLanguage (const String &langname)
void	_printErrorsOrWarnings (std::ostream &o, ConstArrayView< CaseOptionError > errors)

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

Detailed Description

Definition at line 36 of file CaseDocument.cc.

Constructor & Destructor Documentation

◆ CaseDocumentFragment()

Arcane::CaseDocumentFragment::CaseDocumentFragment	(	ITraceMng *	tm,
		IXmlDocumentHolder *	document )

Definition at line 236 of file CaseDocument.cc.

◆ ~CaseDocumentFragment()

Arcane::CaseDocumentFragment::~CaseDocumentFragment ( )

inline

Definition at line 44 of file CaseDocument.cc.

Member Function Documentation

◆ _assignLanguage()

void Arcane::CaseDocumentFragment::_assignLanguage ( const String & langname )

private

Definition at line 341 of file CaseDocument.cc.

◆ _printErrorsOrWarnings()

void Arcane::CaseDocumentFragment::_printErrorsOrWarnings	(	std::ostream &	o,
		ConstArrayView< CaseOptionError >	errors )

private

Definition at line 470 of file CaseDocument.cc.

◆ addError()

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

overridevirtual

Adds an error to the dataset.

Implements Arcane::ICaseDocumentFragment.

Definition at line 406 of file CaseDocument.cc.

◆ addWarning()

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

overridevirtual

Adds a warning to the dataset.

Implements Arcane::ICaseDocumentFragment.

Definition at line 415 of file CaseDocument.cc.

◆ caseNodeNames()

CaseNodeNames * Arcane::CaseDocumentFragment::caseNodeNames ( )

inlineoverridevirtual

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

Implements Arcane::ICaseDocumentFragment.

Definition at line 60 of file CaseDocument.cc.

◆ clearErrorsAndWarnings()

void Arcane::CaseDocumentFragment::clearErrorsAndWarnings ( )

overridevirtual

Clears the recorded error and warning messages.

Implements Arcane::ICaseDocumentFragment.

Definition at line 460 of file CaseDocument.cc.

◆ defaultCategory()

String Arcane::CaseDocumentFragment::defaultCategory ( ) const

inlineoverridevirtual

Category used for default values.

Implements Arcane::ICaseDocumentFragment.

Definition at line 59 of file CaseDocument.cc.

◆ documentHolder()

IXmlDocumentHolder * Arcane::CaseDocumentFragment::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 55 of file CaseDocument.cc.

◆ documentNode()

XmlNode Arcane::CaseDocumentFragment::documentNode ( )

inlineoverridevirtual

Returns the document node.

Implements Arcane::ICaseDocumentFragment.

Definition at line 56 of file CaseDocument.cc.

◆ fragment()

ICaseDocumentFragment * Arcane::CaseDocumentFragment::fragment ( )

inline

Definition at line 74 of file CaseDocument.cc.

◆ hasError()

bool Arcane::CaseDocumentFragment::hasError ( ) const

overridevirtual

Implements Arcane::ICaseDocumentFragment.

Definition at line 424 of file CaseDocument.cc.

◆ hasWarnings()

bool Arcane::CaseDocumentFragment::hasWarnings ( ) const

overridevirtual

Implements Arcane::ICaseDocumentFragment.

Definition at line 433 of file CaseDocument.cc.

◆ init()

void Arcane::CaseDocumentFragment::init ( )

Definition at line 266 of file CaseDocument.cc.

◆ language()

String Arcane::CaseDocumentFragment::language ( ) const

inlineoverridevirtual

Language used in the dataset.

Implements Arcane::ICaseDocumentFragment.

Definition at line 58 of file CaseDocument.cc.

◆ printErrors()

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

overridevirtual

Writes the errors to the stream o.

Implements Arcane::ICaseDocumentFragment.

Definition at line 442 of file CaseDocument.cc.

◆ printWarnings()

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

overridevirtual

Writes the warnings to the stream o.

Implements Arcane::ICaseDocumentFragment.

Definition at line 451 of file CaseDocument.cc.

◆ rootElement()

XmlNode Arcane::CaseDocumentFragment::rootElement ( )

inlineoverridevirtual

Returns the root element.

Implements Arcane::ICaseDocumentFragment.

Definition at line 57 of file CaseDocument.cc.

Member Data Documentation

◆ m_case_node_names

CaseNodeNames* Arcane::CaseDocumentFragment::m_case_node_names = nullptr

Definition at line 78 of file CaseDocument.cc.

◆ m_default_category

String Arcane::CaseDocumentFragment::m_default_category

Definition at line 83 of file CaseDocument.cc.

◆ m_doc_holder

ScopedPtrT<IXmlDocumentHolder> Arcane::CaseDocumentFragment::m_doc_holder

Definition at line 79 of file CaseDocument.cc.

◆ m_document_node

XmlNode Arcane::CaseDocumentFragment::m_document_node

Definition at line 80 of file CaseDocument.cc.

◆ m_errors

UniqueArray<CaseOptionError> Arcane::CaseDocumentFragment::m_errors

Definition at line 84 of file CaseDocument.cc.

◆ m_language

String Arcane::CaseDocumentFragment::m_language

Definition at line 82 of file CaseDocument.cc.

◆ m_root_elem

XmlNode Arcane::CaseDocumentFragment::m_root_elem

Definition at line 81 of file CaseDocument.cc.

◆ m_warnings

UniqueArray<CaseOptionError> Arcane::CaseDocumentFragment::m_warnings

Definition at line 85 of file CaseDocument.cc.

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

CaseDocument.cc

Public Member Functions

Public Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CaseDocumentFragment()

◆ ~CaseDocumentFragment()

Member Function Documentation

◆ _assignLanguage()

◆ _printErrorsOrWarnings()

◆ addError()

◆ addWarning()

◆ caseNodeNames()

◆ clearErrorsAndWarnings()

◆ defaultCategory()

◆ documentHolder()

◆ documentNode()

◆ fragment()

◆ hasError()

◆ hasWarnings()

◆ init()

◆ language()

◆ printErrors()

◆ printWarnings()

◆ rootElement()

Member Data Documentation

◆ m_case_node_names

◆ m_default_category

◆ m_doc_holder

◆ m_document_node

◆ m_errors

◆ m_language

◆ m_root_elem

◆ m_warnings