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

Exception for an invalid identifier. More...

#include <arcane/core/ArcaneException.h>

Inheritance diagram for Arcane::BadIDException:
Collaboration diagram for Arcane::BadIDException:

Public Member Functions

 BadIDException (const String &where, const String &invalid_name)
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_invalid_name
 Invalid identifier.

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 for an invalid identifier.

This exception is thrown whenever an invalid identifier is used in the architecture.

The following rules must be respected for an identifier to be valid:

  • it must contain at least one character.
  • it must start with an alphabetic character (a-zA-Z),
  • it must be followed by a sequence of alphabetic characters, digits, or the underscore character '_'.

Definition at line 46 of file ArcaneException.h.

Constructor & Destructor Documentation

◆ BadIDException()

Arcane::BadIDException::BadIDException ( const String & where,
const String & invalid_name )

Constructs an exception related to the manager m, originating from the function where and with the invalid name invalid_name.

Definition at line 29 of file ArcaneException.cc.

References Arcane::Exception::Exception(), m_invalid_name, and Arcane::Exception::where().

Here is the call graph for this function:

◆ ~BadIDException()

Arcane::BadIDException::~BadIDException ( )
inlineoverride

Definition at line 56 of file ArcaneException.h.

Member Function Documentation

◆ explain()

void Arcane::BadIDException::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 39 of file ArcaneException.cc.

References m_invalid_name.

Member Data Documentation

◆ m_invalid_name

String Arcane::BadIDException::m_invalid_name
private

Invalid identifier.

Definition at line 64 of file ArcaneException.h.

Referenced by BadIDException(), and explain().


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