Error in the dataset. More...

#include <arcane/core/CaseOptionError.h>

Collaboration diagram for Arcane::CaseOptionError:

Public Member Functions
	CaseOptionError (const TraceInfo &where, const String &node_name, const String &message, bool is_collective=false)
	Generic error.
const String &	nodeName () const
const String &	message () const
bool	isCollective () const
const TraceInfo &	trace () const

Static Public Member Functions
static void	addInvalidTypeError (ICaseDocumentFragment *document, const TraceInfo &where, const String &node_name, const XmlNode &parent, const String &value, const String &expected_type)
	Error when a dataset value is not of the correct type. This error is collective.
static void	addInvalidTypeError (ICaseDocumentFragment *document, const TraceInfo &where, const String &node_name, const XmlNode &parent, const String &value, const String &expected_type, StringConstArrayView valid_values)
	Error when a dataset value is not of the correct type. This error is collective.
static void	addOptionNotFoundError (ICaseDocumentFragment *document, const TraceInfo &where, const String &node_name, const XmlNode &parent)
	Error when a dataset option is not found. This error is collective.
static void	addError (ICaseDocumentFragment *document, const TraceInfo &where, const String &node_name, const String &message, bool is_collective=false)
	Generic error.
static void	addWarning (ICaseDocumentFragment *document, const TraceInfo &where, const String &node_name, const String &message, bool is_collective=false)
	Generic error.

Private Attributes
TraceInfo	m_func_info
String	m_node_name
String	m_message
bool	m_is_collective

Detailed Description

Error in the dataset.

Definition at line 41 of file CaseOptionError.h.

Constructor & Destructor Documentation

◆ CaseOptionError()

Arcane::CaseOptionError::CaseOptionError	(	const TraceInfo &	where,
		const String &	node_name,
		const String &	message,
		bool	is_collective = false )

Generic error.

Definition at line 29 of file CaseOptionError.cc.

Referenced by addError(), addInvalidTypeError(), addInvalidTypeError(), addOptionNotFoundError(), and addWarning().

Here is the caller graph for this function:

Member Function Documentation

◆ addError()

void Arcane::CaseOptionError::addError	(	ICaseDocumentFragment *	document,
		const TraceInfo &	where,
		const String &	node_name,
		const String &	message,
		bool	is_collective = false )

static

Generic error.

Definition at line 94 of file CaseOptionError.cc.

References Arcane::ICaseDocumentFragment::addError(), and CaseOptionError().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addInvalidTypeError() [1/2]

void Arcane::CaseOptionError::addInvalidTypeError	(	ICaseDocumentFragment *	document,
		const TraceInfo &	where,
		const String &	node_name,
		const XmlNode &	parent,
		const String &	value,
		const String &	expected_type )

static

Error when a dataset value is not of the correct type. This error is collective.

Definition at line 57 of file CaseOptionError.cc.

References Arcane::ICaseDocumentFragment::addError(), CaseOptionError(), and Arcane::XmlNode::xpathFullName().

Referenced by Arcane::CaseOptionExtended::_search(), Arcane::CaseOptionMultiExtended::_search(), Arcane::CaseOptionMultiSimpleT< T >::_search(), and Arcane::CaseOptionSimpleT< T >::_search().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addInvalidTypeError() [2/2]

void Arcane::CaseOptionError::addInvalidTypeError	(	ICaseDocumentFragment *	document,
		const TraceInfo &	where,
		const String &	node_name,
		const XmlNode &	parent,
		const String &	value,
		const String &	expected_type,
		StringConstArrayView	valid_values )

static

Error when a dataset value is not of the correct type. This error is collective.

Definition at line 75 of file CaseOptionError.cc.

References Arcane::ICaseDocumentFragment::addError(), CaseOptionError(), and Arcane::XmlNode::xpathFullName().

Here is the call graph for this function:

◆ addOptionNotFoundError()

void Arcane::CaseOptionError::addOptionNotFoundError	(	ICaseDocumentFragment *	document,
		const TraceInfo &	where,
		const String &	node_name,
		const XmlNode &	parent )

static

Error when a dataset option is not found. This error is collective.

Definition at line 42 of file CaseOptionError.cc.

References Arcane::ICaseDocumentFragment::addError(), CaseOptionError(), and Arcane::XmlNode::xpathFullName().

Referenced by Arcane::CaseOptionExtended::_search(), Arcane::CaseOptionMultiExtended::_search(), Arcane::CaseOptionMultiSimpleT< T >::_search(), and Arcane::CaseOptionSimpleT< T >::_search().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addWarning()

void Arcane::CaseOptionError::addWarning	(	ICaseDocumentFragment *	document,
		const TraceInfo &	where,
		const String &	node_name,
		const String &	message,
		bool	is_collective = false )

static

Generic error.

Definition at line 105 of file CaseOptionError.cc.

References Arcane::ICaseDocumentFragment::addWarning(), and CaseOptionError().

Referenced by Arcane::XmlElementContentChecker::check(), and Arcane::CaseOptionList::readChildren().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isCollective()

bool Arcane::CaseOptionError::isCollective ( ) const

inline

Definition at line 99 of file CaseOptionError.h.

◆ message()

const String & Arcane::CaseOptionError::message ( ) const

inline

Definition at line 97 of file CaseOptionError.h.

◆ nodeName()

const String & Arcane::CaseOptionError::nodeName ( ) const

inline

Definition at line 95 of file CaseOptionError.h.

◆ trace()

const TraceInfo & Arcane::CaseOptionError::trace ( ) const

inline

Definition at line 101 of file CaseOptionError.h.

Member Data Documentation

◆ m_func_info

TraceInfo Arcane::CaseOptionError::m_func_info

private

Definition at line 105 of file CaseOptionError.h.

◆ m_is_collective

bool Arcane::CaseOptionError::m_is_collective

private

Definition at line 108 of file CaseOptionError.h.

◆ m_message

String Arcane::CaseOptionError::m_message

private

Definition at line 107 of file CaseOptionError.h.

◆ m_node_name

String Arcane::CaseOptionError::m_node_name

private

Definition at line 106 of file CaseOptionError.h.

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

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CaseOptionError()

Member Function Documentation

◆ addError()

◆ addInvalidTypeError() [1/2]

◆ addInvalidTypeError() [2/2]

◆ addOptionNotFoundError()

◆ addWarning()

◆ isCollective()

◆ message()

◆ nodeName()

◆ trace()

Member Data Documentation

◆ m_func_info

◆ m_is_collective

◆ m_message

◆ m_node_name