sitkExceptionObject.h

Go to the documentation of this file.

/*=========================================================================
*
*  Copyright NumFOCUS
*
*  Licensed under the Apache License, Version 2.0 (the "License");
*  you may not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*         http://www.apache.org/licenses/LICENSE-2.0.txt
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS,
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
*=========================================================================*/
#ifndef sitkExceptionObject_h
#define sitkExceptionObject_h
 
#include "sitkMacro.h"
#include "sitkCommon.h"
 
#include <memory> // For shared_ptr.
 
#ifndef sitkMacro_h
#error "sitkMacro.h must be included before sitkExceptionObject.h"
#endif // sitkMacro_h
#ifndef sitkCommon_h
#error "sitkCommon.h must be included before sitkExceptionObject.h"
#endif // sitkCommon_h
 
 
namespace itk
{
 
// forward declaration for encapsulation
class ExceptionObject;
 
namespace simple
{
 
#ifdef _MSC_VER
// Ignore the following warning:
// sitkExceptionObject.h(46,1): warning C4275: non dll-interface class
// 'std::exception' used as base for dll-interface class
// 'itk::simple::GenericException'
#pragma warning( push )
#pragma warning(disable:4275)
#endif
 
class SITKCommon_EXPORT GenericException :
    public std::exception
{
public:
  GenericException()  noexcept;
  GenericException( const GenericException &e )  noexcept;
 
  GenericException(const char *file, unsigned int lineNumber) noexcept;
 
  GenericException(const std::string & file, unsigned int lineNumber) noexcept;
 
  GenericException(const std::string & file,
                   unsigned int lineNumber,
                   const std::string & desc) noexcept;
 
  ~GenericException() noexcept override;
 
  GenericException & operator=(const GenericException & orig);
 
  virtual bool operator==(const GenericException & orig) const;
 
 
  std::string ToString() const;
 
  const char * what() const noexcept override;
 
  virtual const char * GetNameOfClass() const;
 
  virtual const char * GetLocation()    const;
 
  virtual const char * GetDescription() const;
 
  virtual const char * GetFile()    const;
 
  virtual unsigned int GetLine() const;
 
private:
  std::shared_ptr<const ExceptionObject> m_PimpleException;
};
 
#ifdef _MSC_VER
#pragma warning( pop )
#endif
 
}
}
 
#endif // sitkExceptionObject_h