Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::CaseOptionException Class Reference

Exception related to the dataset. More...

#include <arcane/core/CaseOptionException.h>

Inheritance diagram for Arcane::CaseOptionException:
Collaboration diagram for Arcane::CaseOptionException:

Public Member Functions

 CaseOptionException (const String &where, const String &node_name, const XmlNode &parent, const String &value, const String &type)
 Exception when a dataset option is not valid.
 CaseOptionException (const String &where, const String &node_name, const XmlNode &parent)
 Exception when a dataset option is not found.
 CaseOptionException (const String &where, const String &message, bool is_collective=false)
 Generic exception.
 CaseOptionException (const TraceInfo &where, const String &message, bool is_collective=false)
 Generic exception.
 CaseOptionException (const CaseOptionException &rhs) ARCANE_NOEXCEPT
void explain (std::ostream &m) const override
 Explains the cause of the exception in the stream o.
Public Member Functions inherited from Arcane::Exception
Exceptionoperator= (const Exception &)=delete
 Exception (const String &name, const String &where)
 Exception (const String &name, const TraceInfo &where)
 Exception (const String &name, const String &awhere, const String &message)
 Exception (const String &name, const TraceInfo &trace, const String &message)
 Exception (const String &name, const String &where, const StackTrace &stack_trace)
 Exception (const String &name, const TraceInfo &where, const StackTrace &stack_trace)
 Exception (const String &name, const String &where, const String &message, const StackTrace &stack_trace)
 Exception (const String &name, const TraceInfo &trace, const String &message, const StackTrace &stack_trace)
 Exception (const Exception &)
 Copy constructor.
 ~Exception () ARCCORE_NOEXCEPT override
 Releases resources.
virtual void write (std::ostream &o) const
bool isCollective () const
 True if it is a collective error (concerns all processors).
void setCollective (bool v)
 Sets the collective state of the expression.
void setAdditionalInfo (const String &v)
 Sets the additional information.
const StringadditionalInfo () const
 Returns the additional information.
const StackTracestackTrace () const
 Call stack at the moment of the exception (requires a stacktrace service).
const StringstackTraceString () const
 Call stack at the moment of the exception (requires a stacktrace service).
const Stringmessage () const
 Exception message.
const Stringwhere () const
 Location of the exception.
const Stringname () const
 Name of the exception.

Private Attributes

String m_node_name
XmlNode m_parent
String m_value
String m_type
String m_message

Additional Inherited Members

Static Public Member Functions inherited from Arcane::Exception
static bool hasPendingException ()
 Indicates if there are pending exceptions.
static void staticInit ()
Protected Member Functions inherited from Arcane::Exception
void setMessage (const String &msg)
 Sets the exception message.

Detailed Description

Exception related to the dataset.

Definition at line 35 of file CaseOptionException.h.

Constructor & Destructor Documentation

◆ CaseOptionException() [1/5]

Arcane::CaseOptionException::CaseOptionException ( const String & where,
const String & node_name,
const XmlNode & parent,
const String & value,
const String & type )

Exception when a dataset option is not valid.

This exception is collective.

Definition at line 52 of file CaseOptionException.cc.

References Arcane::Exception::Exception(), Arcane::Exception::setCollective(), Arcane::StringBuilder::toString(), and Arcane::Exception::where().

Here is the call graph for this function:

◆ CaseOptionException() [2/5]

Arcane::CaseOptionException::CaseOptionException ( const String & where,
const String & node_name,
const XmlNode & parent )

Exception when a dataset option is not found.

This exception is collective.

Definition at line 30 of file CaseOptionException.cc.

References Arcane::Exception::Exception(), Arcane::Exception::setCollective(), Arcane::StringBuilder::toString(), and Arcane::Exception::where().

Here is the call graph for this function:

◆ CaseOptionException() [3/5]

Arcane::CaseOptionException::CaseOptionException ( const String & where,
const String & message,
bool is_collective = false )

Generic exception.

Definition at line 77 of file CaseOptionException.cc.

References Arcane::Exception::Exception(), Arcane::Exception::message(), Arcane::Exception::setCollective(), and Arcane::Exception::where().

Here is the call graph for this function:

◆ CaseOptionException() [4/5]

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

Generic exception.

Definition at line 88 of file CaseOptionException.cc.

References Arcane::Exception::Exception(), Arcane::Exception::message(), Arcane::Exception::setCollective(), and Arcane::Exception::where().

Here is the call graph for this function:

◆ CaseOptionException() [5/5]

Arcane::CaseOptionException::CaseOptionException ( const CaseOptionException & rhs)

Definition at line 99 of file CaseOptionException.cc.

◆ ~CaseOptionException()

Arcane::CaseOptionException::~CaseOptionException ( )
override

Definition at line 113 of file CaseOptionException.cc.

Member Function Documentation

◆ explain()

void Arcane::CaseOptionException::explain ( std::ostream & o) const
overridevirtual

Explains the cause of the exception in the stream o.

This method allows adding additional information to the exception message.

Reimplemented from Arcane::Exception.

Definition at line 121 of file CaseOptionException.cc.

Member Data Documentation

◆ m_message

String Arcane::CaseOptionException::m_message
private

Definition at line 73 of file CaseOptionException.h.

◆ m_node_name

String Arcane::CaseOptionException::m_node_name
private

Definition at line 69 of file CaseOptionException.h.

◆ m_parent

XmlNode Arcane::CaseOptionException::m_parent
private

Definition at line 70 of file CaseOptionException.h.

◆ m_type

String Arcane::CaseOptionException::m_type
private

Definition at line 72 of file CaseOptionException.h.

◆ m_value

String Arcane::CaseOptionException::m_value
private

Definition at line 71 of file CaseOptionException.h.


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