itk::ExceptionObject Class Reference

#include <itkExceptionObject.h>

Detailed Description

Standard exception handling object.

ExceptionObject provides standard methods for throwing and managing exceptions in itk. Specific exceptions should be derived from this class. Note that this class is derived from std::exception, so an application can catch ITK exceptions as std::exception if desired.

ExceptionObject maintains two types of information: a location and description (both of which are strings). The location is the point in the code where the exception was thrown; the description is an error message that describes the exception. The ExceptionObject can be thrown explicitly in code, or more conveniently, the itkExceptionMacro (found in Common/itkMacro.h) can be used.

Examples

Examples/DataRepresentation/Image/Image5.cxx, Examples/DataRepresentation/Image/ImageAdaptor2.cxx, Examples/DataRepresentation/Mesh/ImageToPointSet.cxx, Examples/DataRepresentation/Path/PolyLineParametricPath1.cxx, Examples/Filtering/AntiAliasBinaryImageFilter.cxx, Examples/Filtering/CannyEdgeDetectionImageFilter.cxx, Examples/Filtering/CompositeFilterExample.cxx, Examples/Filtering/DanielssonDistanceMapImageFilter.cxx, Examples/Filtering/DiffusionTensor3DReconstructionImageFilter.cxx, Examples/Filtering/DigitallyReconstructedRadiograph1.cxx, Examples/Filtering/FFTImageFilter.cxx, Examples/Filtering/FFTImageFilterFourierDomainFiltering.cxx, Examples/Filtering/GrayscaleFunctionDilateImageFilter.cxx, Examples/Filtering/LaplacianImageFilter.cxx, Examples/Filtering/LaplacianRecursiveGaussianImageFilter1.cxx, Examples/Filtering/LaplacianRecursiveGaussianImageFilter2.cxx, Examples/Filtering/LaplacianSharpeningImageFilter.cxx, Examples/Filtering/MorphologicalImageEnhancement.cxx, Examples/Filtering/OtsuMultipleThresholdImageFilter.cxx, Examples/Filtering/OtsuThresholdImageFilter.cxx, Examples/Filtering/RGBToGrayscale.cxx, Examples/Filtering/ResampleImageFilter3.cxx, Examples/Filtering/ResampleImageFilter4.cxx, Examples/Filtering/ResampleImageFilter5.cxx, Examples/Filtering/ResampleImageFilter6.cxx, Examples/Filtering/ResampleImageFilter7.cxx, Examples/Filtering/ResampleImageFilter8.cxx, Examples/Filtering/ResampleImageFilter9.cxx, Examples/Filtering/ResampleVolumesToBeIsotropic.cxx, Examples/Filtering/SecondDerivativeRecursiveGaussianImageFilter.cxx, Examples/Filtering/SignedDanielssonDistanceMapImageFilter.cxx, Examples/Filtering/SpatialObjectToImage1.cxx, Examples/Filtering/SpatialObjectToImage2.cxx, Examples/Filtering/SpatialObjectToImage3.cxx, Examples/Filtering/SubsampleVolume.cxx, Examples/Filtering/SurfaceExtraction.cxx, Examples/Filtering/VectorIndexSelection.cxx, Examples/Filtering/WarpImageFilter1.cxx, Examples/Filtering/ZeroCrossingBasedEdgeDetectionImageFilter.cxx, Examples/IO/ComplexImageReadWrite.cxx, Examples/IO/CovariantVectorImageExtractComponent.cxx, Examples/IO/CovariantVectorImageRead.cxx, Examples/IO/CovariantVectorImageWrite.cxx, Examples/IO/DicomImageReadChangeHeaderWrite.cxx, Examples/IO/DicomImageReadPrintTags.cxx, Examples/IO/DicomImageReadWrite.cxx, Examples/IO/DicomPrintPatientInformation.cxx, Examples/IO/DicomSeriesReadGaussianImageWrite.cxx, Examples/IO/DicomSeriesReadImageWrite.cxx, Examples/IO/DicomSeriesReadImageWrite2.cxx, Examples/IO/DicomSeriesReadPrintTags.cxx, Examples/IO/DicomSeriesReadSeriesWrite.cxx, Examples/IO/IOPlugin.cxx, Examples/IO/ImageReadCastWrite.cxx, Examples/IO/ImageReadDicomSeriesWrite.cxx, Examples/IO/ImageReadExportVTK.cxx, Examples/IO/ImageReadExtractFilterInsertWrite.cxx, Examples/IO/ImageReadExtractWrite.cxx, Examples/IO/ImageReadImageSeriesWrite.cxx, Examples/IO/ImageReadRegionOfInterestWrite.cxx, Examples/IO/ImageReadWrite.cxx, Examples/IO/ImageSeriesReadWrite.cxx, Examples/IO/ImageSeriesReadWrite2.cxx, Examples/IO/RGBImageSeriesReadWrite.cxx, Examples/IO/TransformReadWrite.cxx, Examples/IO/VectorImageReadWrite.cxx, Examples/IO/VisibleHumanPasteWrite.cxx, Examples/IO/VisibleHumanStreamReadWrite.cxx, Examples/IO/XML/DOMFindDemo.cxx, Examples/IO/XML/ParticleSwarmOptimizerReadWrite.cxx, Examples/Iterators/ImageLinearIteratorWithIndex.cxx, Examples/Iterators/ImageLinearIteratorWithIndex2.cxx, Examples/Iterators/ImageRandomConstIteratorWithIndex.cxx, Examples/Iterators/ImageRegionIterator.cxx, Examples/Iterators/ImageRegionIteratorWithIndex.cxx, Examples/Iterators/ImageSliceIteratorWithIndex.cxx, Examples/Iterators/NeighborhoodIterators1.cxx, Examples/Iterators/NeighborhoodIterators2.cxx, Examples/Iterators/NeighborhoodIterators3.cxx, Examples/Iterators/NeighborhoodIterators4.cxx, Examples/Iterators/NeighborhoodIterators5.cxx, Examples/Iterators/NeighborhoodIterators6.cxx, Examples/Iterators/ShapedNeighborhoodIterators1.cxx, Examples/Iterators/ShapedNeighborhoodIterators2.cxx, Examples/RegistrationITKv4/BSplineWarping1.cxx, Examples/RegistrationITKv4/BSplineWarping2.cxx, Examples/RegistrationITKv4/ChangeInformationImageFilter.cxx, Examples/RegistrationITKv4/DeformableRegistration1.cxx, Examples/RegistrationITKv4/DeformableRegistration10.cxx, Examples/RegistrationITKv4/DeformableRegistration11.cxx, Examples/RegistrationITKv4/DeformableRegistration12.cxx, Examples/RegistrationITKv4/DeformableRegistration13.cxx, Examples/RegistrationITKv4/DeformableRegistration14.cxx, Examples/RegistrationITKv4/DeformableRegistration15.cxx, Examples/RegistrationITKv4/DeformableRegistration16.cxx, Examples/RegistrationITKv4/DeformableRegistration17.cxx, Examples/RegistrationITKv4/DeformableRegistration2.cxx, Examples/RegistrationITKv4/DeformableRegistration4.cxx, Examples/RegistrationITKv4/DeformableRegistration5.cxx, Examples/RegistrationITKv4/DeformableRegistration6.cxx, Examples/RegistrationITKv4/DeformableRegistration7.cxx, Examples/RegistrationITKv4/DeformableRegistration8.cxx, Examples/RegistrationITKv4/DeformableRegistration9.cxx, Examples/RegistrationITKv4/DisplacementFieldInitialization.cxx, Examples/RegistrationITKv4/ImageRegistration1.cxx, Examples/RegistrationITKv4/ImageRegistration10.cxx, Examples/RegistrationITKv4/ImageRegistration11.cxx, Examples/RegistrationITKv4/ImageRegistration12.cxx, Examples/RegistrationITKv4/ImageRegistration13.cxx, Examples/RegistrationITKv4/ImageRegistration14.cxx, Examples/RegistrationITKv4/ImageRegistration15.cxx, Examples/RegistrationITKv4/ImageRegistration16.cxx, Examples/RegistrationITKv4/ImageRegistration17.cxx, Examples/RegistrationITKv4/ImageRegistration18.cxx, Examples/RegistrationITKv4/ImageRegistration19.cxx, Examples/RegistrationITKv4/ImageRegistration2.cxx, Examples/RegistrationITKv4/ImageRegistration20.cxx, Examples/RegistrationITKv4/ImageRegistration3.cxx, Examples/RegistrationITKv4/ImageRegistration4.cxx, Examples/RegistrationITKv4/ImageRegistration5.cxx, Examples/RegistrationITKv4/ImageRegistration6.cxx, Examples/RegistrationITKv4/ImageRegistration7.cxx, Examples/RegistrationITKv4/ImageRegistration8.cxx, Examples/RegistrationITKv4/ImageRegistration9.cxx, Examples/RegistrationITKv4/ImageRegistrationHistogramPlotter.cxx, Examples/RegistrationITKv4/IterativeClosestPoint1.cxx, Examples/RegistrationITKv4/IterativeClosestPoint2.cxx, Examples/RegistrationITKv4/IterativeClosestPoint3.cxx, Examples/RegistrationITKv4/LandmarkWarping2.cxx, Examples/RegistrationITKv4/MeanSquaresImageMetric1.cxx, Examples/RegistrationITKv4/ModelToImageRegistration1.cxx, Examples/RegistrationITKv4/ModelToImageRegistration2.cxx, Examples/RegistrationITKv4/MultiResImageRegistration1.cxx, Examples/RegistrationITKv4/MultiResImageRegistration2.cxx, Examples/RegistrationITKv4/MultiResImageRegistration3.cxx, Examples/RegistrationITKv4/MultiStageImageRegistration1.cxx, Examples/RegistrationITKv4/MultiStageImageRegistration2.cxx, Examples/RegistrationITKv4/ThinPlateSplineWarp.cxx, Examples/Segmentation/CannySegmentationLevelSetImageFilter.cxx, Examples/Segmentation/ConfidenceConnected.cxx, Examples/Segmentation/ConfidenceConnected3D.cxx, Examples/Segmentation/ConnectedThresholdImageFilter.cxx, Examples/Segmentation/CurvesLevelSetImageFilter.cxx, Examples/Segmentation/FastMarchingImageFilter.cxx, Examples/Segmentation/GeodesicActiveContourImageFilter.cxx, Examples/Segmentation/GeodesicActiveContourShapePriorLevelSetImageFilter.cxx, Examples/Segmentation/HoughTransform2DCirclesImageFilter.cxx, Examples/Segmentation/HoughTransform2DLinesImageFilter.cxx, Examples/Segmentation/IsolatedConnectedImageFilter.cxx, Examples/Segmentation/LaplacianSegmentationLevelSetImageFilter.cxx, Examples/Segmentation/NeighborhoodConnectedImageFilter.cxx, Examples/Segmentation/ShapeDetectionLevelSetFilter.cxx, Examples/Segmentation/ThresholdSegmentationLevelSetImageFilter.cxx, Examples/Segmentation/VectorConfidenceConnected.cxx, Examples/Segmentation/WatershedSegmentation1.cxx, Examples/Segmentation/WatershedSegmentation2.cxx, Examples/SpatialObjects/BoundingBoxFromImageMaskSpatialObject.cxx, Examples/Statistics/BayesianClassifier.cxx, Examples/Statistics/BayesianClassifierInitializer.cxx, Examples/Statistics/ImageEntropy1.cxx, Examples/Statistics/ImageHistogram1.cxx, Examples/Statistics/ImageHistogram2.cxx, Examples/Statistics/ImageHistogram3.cxx, Examples/Statistics/ImageHistogram4.cxx, Examples/Statistics/ImageMutualInformation1.cxx, Examples/Statistics/ScalarImageKmeansClassifier.cxx, Examples/Statistics/ScalarImageKmeansModelEstimator.cxx, and Examples/Statistics/ScalarImageMarkovRandomField1.cxx.

Definition at line 50 of file itkExceptionObject.h.

Inheritance diagram for itk::ExceptionObject:

Collaboration diagram for itk::ExceptionObject:

Public Types
using	Superclass = std::exception

Public Member Functions
	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
virtual const char *	GetNameOfClass () const
ExceptionObject &	operator= (const ExceptionObject &) noexcept=default
ExceptionObject &	operator= (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

Static Public Attributes
static constexpr const char *const	default_exception_message = "Generic ExceptionObject"

Private Attributes
std::shared_ptr< const ExceptionData >	m_ExceptionData {}

Member Typedef Documentation

Superclass

using itk::ExceptionObject::Superclass = std::exception

Definition at line 54 of file itkExceptionObject.h.

Constructor & Destructor Documentation

ExceptionObject() [1/5]

itk::ExceptionObject::ExceptionObject ( )

defaultnoexcept

Explicitly-defaulted default-constructor. Creates an empty exception object.

Referenced by ExceptionObject(), ExceptionObject(), ExceptionObject(), ExceptionObject(), GetNameOfClass(), itk::ImageFileWriterException::ImageFileWriterException(), itk::ImageFileWriterException::ImageFileWriterException(), itk::ImageSeriesWriterException::ImageSeriesWriterException(), itk::ImageSeriesWriterException::ImageSeriesWriterException(), operator=(), operator=(), operator==(), itk::ProcessAborted::ProcessAborted(), itk::ProcessAborted::ProcessAborted(), itk::ProcessAborted::ProcessAborted(), and ~ExceptionObject().

ExceptionObject() [2/5]

itk::ExceptionObject::ExceptionObject ( const char * file, unsigned int lineNumber = 0, const char * desc = "None", const char * loc = "Unknown" )

explicit

References ExceptionObject().

ExceptionObject() [3/5]

itk::ExceptionObject::ExceptionObject ( std::string file, unsigned int lineNumber = 0, std::string desc = "None", std::string loc = "Unknown" )

explicit

References ExceptionObject().

ExceptionObject() [4/5]

itk::ExceptionObject::ExceptionObject ( const ExceptionObject & )

defaultnoexcept

Copy-constructor.

References ExceptionObject().

ExceptionObject() [5/5]

itk::ExceptionObject::ExceptionObject ( ExceptionObject && )

defaultnoexcept

Move-constructor.

References ExceptionObject().

~ExceptionObject()

itk::ExceptionObject::~ExceptionObject ( )

override

Destructor.

Note

It appears necessary to define the destructor "out-of-line" for external linkage.

References ExceptionObject().

Member Function Documentation

GetDescription()

virtual const char * itk::ExceptionObject::GetDescription ( ) const

virtual

Examples

Examples/IO/DicomImageReadChangeHeaderWrite.cxx.

References GetDescription().

Referenced by GetDescription().

GetFile()

virtual const char * itk::ExceptionObject::GetFile ( ) const

virtual

What file did the exception occur in?

References GetFile().

Referenced by GetFile().

GetLine()

virtual unsigned int itk::ExceptionObject::GetLine ( ) const

virtual

What line did the exception occur in?

References GetLine().

Referenced by GetLine().

GetLocation()

virtual const char * itk::ExceptionObject::GetLocation ( ) const

virtual

Examples

Examples/IO/DicomImageReadChangeHeaderWrite.cxx.

References GetLocation().

Referenced by GetLocation().

GetNameOfClass()

virtual const char * itk::ExceptionObject::GetNameOfClass ( ) const

virtual

See also

LightObject::GetNameOfClass()

Reimplemented in itk::DataObjectError, itk::DerefError, itk::HistogramWrongNumberOfComponents, itk::ImageFileWriterException, itk::ImageSeriesWriterException, itk::IncompatibleOperandsError, itk::InvalidArgumentError, itk::InvalidRequestedRegionError, itk::MemoryAllocationError, itk::MeshFileReaderException, itk::MeshFileWriterException, itk::MissingHistogramBinMaximumInput, itk::MissingHistogramBinMinimumInput, itk::MissingHistogramMarginalScaleInput, itk::MissingHistogramSizeInput, itk::NullSizeHistogramInputMeasurementVectorSize, itk::ProcessAborted, itk::RangeError, and itk::SampleToHistogramFilterException.

References ExceptionObject().

operator=() [1/2]

ExceptionObject & itk::ExceptionObject::operator= ( const ExceptionObject & )

defaultnoexcept

Copy-assignment operator.

References ExceptionObject().

operator=() [2/2]

ExceptionObject & itk::ExceptionObject::operator= ( ExceptionObject && )

defaultnoexcept

Move-assignment operator.

References ExceptionObject().

operator==()

virtual bool itk::ExceptionObject::operator== ( const ExceptionObject & orig ) const

virtual

Equivalence operator.

References ExceptionObject().

Print()

virtual void itk::ExceptionObject::Print ( std::ostream & os ) const

virtual

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".

Examples

Examples/IO/XML/DOMFindDemo.cxx, Examples/IO/XML/ParticleSwarmOptimizerReadWrite.cxx, Examples/RegistrationITKv4/DeformableRegistration10.cxx, Examples/RegistrationITKv4/DeformableRegistration9.cxx, Examples/RegistrationITKv4/MultiStageImageRegistration1.cxx, and Examples/RegistrationITKv4/MultiStageImageRegistration2.cxx.

References Print().

Referenced by itk::operator<<(), and Print().

SetDescription() [1/2]

virtual void itk::ExceptionObject::SetDescription ( const char * s )

virtual

References SetDescription().

SetDescription() [2/2]

virtual void itk::ExceptionObject::SetDescription ( const std::string & s )

virtual

References SetDescription().

Referenced by itk::ProgressReporter::CheckAbortGenerateData(), itk::TotalProgressReporter::CheckAbortGenerateData(), itk::ImageSeriesWriterException::ImageSeriesWriterException(), itk::ImageSeriesWriterException::ImageSeriesWriterException(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::IsAtEnd(), itk::ProcessAborted::ProcessAborted(), itk::ProcessAborted::ProcessAborted(), itk::ProcessAborted::ProcessAborted(), SetDescription(), SetDescription(), and itk::RegularStepGradientDescentBaseOptimizer::StepAlongGradient().

SetLocation() [1/2]

virtual void itk::ExceptionObject::SetLocation ( const char * s )

virtual

References SetLocation().

SetLocation() [2/2]

virtual void itk::ExceptionObject::SetLocation ( const std::string & s )

virtual

Methods to get and set the Location and Description fields. The Set methods are overloaded to support both std::string and const char array types. Get methods return const char arrays.

References SetLocation().

Referenced by SetLocation(), SetLocation(), and itk::RegularStepGradientDescentBaseOptimizer::StepAlongGradient().

what()

const char * itk::ExceptionObject::what ( ) const

overridenoexcept

Provide std::exception::what() implementation.

References what().

Referenced by what().

Member Data Documentation

default_exception_message

const char* const itk::ExceptionObject::default_exception_message = "Generic ExceptionObject"

staticconstexpr

Definition at line 53 of file itkExceptionObject.h.

m_ExceptionData

std::shared_ptr<const ExceptionData> itk::ExceptionObject::m_ExceptionData {}

private

Definition at line 136 of file itkExceptionObject.h.

---

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

• itkExceptionObject.h