OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
EarlyLeaveException Class Reference

#include <EarlyLeaveException.h>

Inheritance diagram for EarlyLeaveException:
Inheritance graph
Collaboration diagram for EarlyLeaveException:
Collaboration graph

Public Member Functions

 EarlyLeaveException (const std::string &meth, const std::string &msg)
 The usual constructor. More...
 
 EarlyLeaveException (const EarlyLeaveException &)
 
virtual ~EarlyLeaveException ()
 
virtual const std::string & what () const
 Return the message string for the exception. More...
 
virtual const std::string & where () const
 Return the name of the method or function which detected the exception. More...
 

Protected Attributes

const std::string message
 
const std::string method
 

Private Member Functions

 EarlyLeaveException ()=delete
 

Detailed Description

This exception class is used to inentionally exit OPAL when no error occurred.

Definition at line 21 of file EarlyLeaveException.h.

Constructor & Destructor Documentation

◆ EarlyLeaveException() [1/3]

EarlyLeaveException::EarlyLeaveException ( const std::string &  meth,
const std::string &  msg 
)
explicit

The usual constructor.

Parameters
[in]meththe name of the method or function detecting the exception
[in]msgthe message string identifying the exception

Definition at line 14 of file EarlyLeaveException.cpp.

◆ EarlyLeaveException() [2/3]

EarlyLeaveException::EarlyLeaveException ( const EarlyLeaveException rhs)

Definition at line 19 of file EarlyLeaveException.cpp.

◆ ~EarlyLeaveException()

EarlyLeaveException::~EarlyLeaveException ( )
virtual

Definition at line 24 of file EarlyLeaveException.cpp.

◆ EarlyLeaveException() [3/3]

EarlyLeaveException::EarlyLeaveException ( )
privatedelete

Member Function Documentation

◆ what()

const std::string & ClassicException::what ( ) const
virtual

Return the message string for the exception.

Reimplemented from ClassicException.

Definition at line 34 of file ClassicException.cpp.

Referenced by opalMain().

◆ where()

const std::string & ClassicException::where ( ) const
virtual

Return the name of the method or function which detected the exception.

Reimplemented from ClassicException.

Definition at line 37 of file ClassicException.cpp.

Referenced by opalMain().

Member Data Documentation

◆ message

const std::string ClassicException::message
protectedinherited

Definition at line 60 of file ClassicException.h.

Referenced by ClassicException::what().

◆ method

const std::string ClassicException::method
protectedinherited

Definition at line 61 of file ClassicException.h.

Referenced by ClassicException::where().


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