ITK  6.0.0
Insight Toolkit
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::DataObjectError Class Reference

#include <itkDataObject.h>

Detailed Description

Exception object for DataObject exceptions.

Definition at line 51 of file itkDataObject.h.

+ Inheritance diagram for itk::DataObjectError:
+ Collaboration diagram for itk::DataObjectError:

Public Member Functions

 DataObjectError () noexcept
 
 DataObjectError (const char *file, unsigned int lineNumber)
 
 DataObjectError (const DataObjectError &orig) noexcept
 
 DataObjectError (const std::string &file, unsigned int lineNumber)
 
const char * GetNameOfClass () const override
 
DataObjectErroroperator= (const DataObjectError &orig) noexcept
 
void SetDataObject (DataObject *dobj) noexcept
 
 ~DataObjectError () noexcept override=default
 
const DataObjectGetDataObject () const noexcept
 
- Public Member Functions inherited from itk::ExceptionObject
 ExceptionObject () noexcept=default
 
 ExceptionObject (const char *file, unsigned int lineNumber=0, const char *desc="None", const char *loc="Unknown")
 
 ExceptionObject (const ExceptionObject &) noexcept=default
 
 ExceptionObject (ExceptionObject &&) noexcept=default
 
 ExceptionObject (std::string file, unsigned int lineNumber=0, std::string desc="None", std::string loc="Unknown")
 
virtual const char * GetDescription () const
 
virtual const char * GetFile () const
 
virtual unsigned int GetLine () const
 
virtual const char * GetLocation () const
 
ExceptionObjectoperator= (const ExceptionObject &) noexcept=default
 
ExceptionObjectoperator= (ExceptionObject &&) noexcept=default
 
virtual bool operator== (const ExceptionObject &orig) const
 
virtual void Print (std::ostream &os) const
 
virtual void SetDescription (const char *s)
 
virtual void SetDescription (const std::string &s)
 
virtual void SetLocation (const char *s)
 
virtual void SetLocation (const std::string &s)
 
const char * what () const noexcept override
 
 ~ExceptionObject () override
 

Protected Member Functions

virtual void PrintSelf (std::ostream &os, Indent indent) const
 

Private Attributes

DataObjectm_DataObject { nullptr }
 

Additional Inherited Members

- Public Types inherited from itk::ExceptionObject
using Superclass = std::exception
 
- Static Public Attributes inherited from itk::ExceptionObject
static constexpr const char *const default_exception_message = "Generic ExceptionObject"
 

Constructor & Destructor Documentation

◆ DataObjectError() [1/4]

itk::DataObjectError::DataObjectError ( )
noexcept

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

◆ ~DataObjectError()

itk::DataObjectError::~DataObjectError ( )
overridedefaultnoexcept

Destructor. Need to specify empty throw() to avoid warnings.

◆ DataObjectError() [2/4]

itk::DataObjectError::DataObjectError ( const char *  file,
unsigned int  lineNumber 
)

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

◆ DataObjectError() [3/4]

itk::DataObjectError::DataObjectError ( const std::string &  file,
unsigned int  lineNumber 
)

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

◆ DataObjectError() [4/4]

itk::DataObjectError::DataObjectError ( const DataObjectError orig)
noexcept

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

Member Function Documentation

◆ GetDataObject()

const DataObject* itk::DataObjectError::GetDataObject ( ) const
noexcept

Get the data object that is throwing this exception.

◆ GetNameOfClass()

const char* itk::DataObjectError::GetNameOfClass ( ) const
overridevirtual

◆ operator=()

DataObjectError& itk::DataObjectError::operator= ( const DataObjectError orig)
noexcept

Operator=. Needed to ensure the exception object can be copied.

◆ PrintSelf()

virtual void itk::DataObjectError::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

Print exception information. This method can be overridden by specific exception subtypes. The default is to print out the location where the exception was first thrown and any description provided by the "thrower".

Reimplemented in itk::InvalidRequestedRegionError.

◆ SetDataObject()

void itk::DataObjectError::SetDataObject ( DataObject dobj)
noexcept

Set the data object that is throwing this exception.

Member Data Documentation

◆ m_DataObject

DataObject* itk::DataObjectError::m_DataObject { nullptr }
private

Definition at line 101 of file itkDataObject.h.


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