Exception to request a backward step in the time loop. More...

#include <arcane/utils/GoBackwardException.h>

Inheritance diagram for Arcane::GoBackwardException:

Collaboration diagram for Arcane::GoBackwardException:

Public Member Functions
	GoBackwardException (const String &where)
	GoBackwardException (const String &where, const String &message)
	GoBackwardException (const TraceInfo &where)
	GoBackwardException (const TraceInfo &where, const String &message)
virtual void	explain (std::ostream &m) const
	Explains the cause of the exception in the stream o.
Public Member Functions inherited from Arcane::Exception
Exception &	operator= (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 String &	additionalInfo () const
	Returns the additional information.
const StackTrace &	stackTrace () const
	Call stack at the moment of the exception (requires a stacktrace service).
const String &	stackTraceString () const
	Call stack at the moment of the exception (requires a stacktrace service).
const String &	message () const
	Exception message.
const String &	where () const
	Location of the exception.
const String &	name () const
	Name of the exception.

Private Attributes
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 to request a backward step in the time loop.

Definition at line 32 of file GoBackwardException.h.

Constructor & Destructor Documentation

◆ GoBackwardException() [1/4]

Arcane::GoBackwardException::GoBackwardException ( const String & where )

Definition at line 29 of file GoBackwardException.cc.

◆ GoBackwardException() [2/4]

Arcane::GoBackwardException::GoBackwardException	(	const String &	where,
		const String &	message )

Definition at line 38 of file GoBackwardException.cc.

◆ GoBackwardException() [3/4]

Arcane::GoBackwardException::GoBackwardException ( const TraceInfo & where )

Definition at line 48 of file GoBackwardException.cc.

◆ GoBackwardException() [4/4]

Arcane::GoBackwardException::GoBackwardException	(	const TraceInfo &	where,
		const String &	message )

Definition at line 57 of file GoBackwardException.cc.

◆ ~GoBackwardException()

Arcane::GoBackwardException::~GoBackwardException ( )

inline

Definition at line 41 of file GoBackwardException.h.

Member Function Documentation

◆ explain()

void Arcane::GoBackwardException::explain ( std::ostream & o ) const

virtual

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 67 of file GoBackwardException.cc.

Member Data Documentation

◆ m_message

String Arcane::GoBackwardException::m_message

private

Definition at line 49 of file GoBackwardException.h.

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

Public Member Functions

Private Attributes

Additional Inherited Members