SimpleITK  
Public Member Functions | Private Attributes | List of all members
itk::simple::GenericException Class Reference

The base SimpleITK exception class. More...

#include <sitkExceptionObject.h>

+ Inheritance diagram for itk::simple::GenericException:
+ Collaboration diagram for itk::simple::GenericException:

Public Member Functions

 GenericException () noexcept
 
 GenericException (const char *file, unsigned int lineNumber) noexcept
 
 GenericException (const GenericException &e) noexcept
 
 GenericException (const std::string &file, unsigned int lineNumber) noexcept
 
 GenericException (const std::string &file, unsigned int lineNumber, const std::string &desc) noexcept
 
virtual const char * GetDescription () const
 
virtual const char * GetFile () const
 
virtual unsigned int GetLine () const
 
virtual const char * GetLocation () const
 
virtual const char * GetNameOfClass () const
 
GenericExceptionoperator= (const GenericException &orig)
 
virtual bool operator== (const GenericException &orig) const
 
std::string ToString () const
 
const char * what () const noexcept override
 
 ~GenericException () noexcept override
 

Private Attributes

std::shared_ptr< const ExceptionObject > m_PimpleException
 

Detailed Description

The base SimpleITK exception class.

Definition at line 55 of file sitkExceptionObject.h.

Constructor & Destructor Documentation

◆ GenericException() [1/5]

itk::simple::GenericException::GenericException ( )
noexcept

Default constructor. Needed to ensure the exception object can be copied.

◆ GenericException() [2/5]

itk::simple::GenericException::GenericException ( const GenericException e)
noexcept

◆ GenericException() [3/5]

itk::simple::GenericException::GenericException ( const char *  file,
unsigned int  lineNumber 
)
noexcept

Constructor. Needed to ensure the exception object can be copied.

◆ GenericException() [4/5]

itk::simple::GenericException::GenericException ( const std::string &  file,
unsigned int  lineNumber 
)
noexcept

Constructor. Needed to ensure the exception object can be copied.

◆ GenericException() [5/5]

itk::simple::GenericException::GenericException ( const std::string &  file,
unsigned int  lineNumber,
const std::string &  desc 
)
noexcept

Constructor. Needed to ensure the exception object can be copied.

◆ ~GenericException()

itk::simple::GenericException::~GenericException ( )
overridenoexcept

Virtual destructor needed for subclasses. Has to have empty noexcept.

Member Function Documentation

◆ GetDescription()

virtual const char* itk::simple::GenericException::GetDescription ( ) const
virtual

◆ GetFile()

virtual const char* itk::simple::GenericException::GetFile ( ) const
virtual

What file did the exception occur in?

◆ GetLine()

virtual unsigned int itk::simple::GenericException::GetLine ( ) const
virtual

What line did the exception occur in?

◆ GetLocation()

virtual const char* itk::simple::GenericException::GetLocation ( ) const
virtual

◆ GetNameOfClass()

virtual const char* itk::simple::GenericException::GetNameOfClass ( ) const
virtual

◆ operator=()

GenericException& itk::simple::GenericException::operator= ( const GenericException orig)

Assignment operator.

◆ operator==()

virtual bool itk::simple::GenericException::operator== ( const GenericException orig) const
virtual

Equivalence operator.

◆ ToString()

std::string itk::simple::GenericException::ToString ( ) const

Return a description of the error

◆ what()

const char* itk::simple::GenericException::what ( ) const
overridenoexcept

Member Data Documentation

◆ m_PimpleException

std::shared_ptr<const ExceptionObject> itk::simple::GenericException::m_PimpleException
private

Definition at line 103 of file sitkExceptionObject.h.


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