itkFloatingPointExceptions.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
 *
 *         https://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 itkFloatingPointExceptions_h
#define itkFloatingPointExceptions_h
 
#include "itkMacro.h" // for ITKCommon_EXPORT
#include "itkSingletonMacro.h"
 
namespace itk
{
class FloatingPointExceptionsEnums
{
public:
  enum class ExceptionAction : uint8_t
  {
    ABORT,
    EXIT
  };
};
// Define how to print enumeration
extern ITKCommon_EXPORT std::ostream &
                        operator<<(std::ostream & out, const FloatingPointExceptionsEnums::ExceptionAction value);
 
struct ExceptionGlobals;
 
class ITKCommon_EXPORT FloatingPointExceptions
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(FloatingPointExceptions);
  // default constructor required for wrapping to succeed
  FloatingPointExceptions() = default;
  virtual ~FloatingPointExceptions() = default;
 
  using ExceptionActionEnum = FloatingPointExceptionsEnums::ExceptionAction;
#if !defined(ITK_LEGACY_REMOVE)
  using ExceptionAction = ExceptionActionEnum;
  static constexpr ExceptionActionEnum ABORT = ExceptionActionEnum::ABORT;
  static constexpr ExceptionActionEnum EXIT = ExceptionActionEnum::EXIT;
#endif
 
  static void
  Enable();
 
  static void
  Disable();
 
  static bool
  GetEnabled();
 
  static void
  SetEnabled(bool val);
 
  static void
  SetExceptionAction(ExceptionActionEnum a);
 
  static ExceptionActionEnum
  GetExceptionAction();
 
  static bool
  HasFloatingPointExceptionsSupport();
 
private:
  itkGetGlobalDeclarationMacro(ExceptionGlobals, PimplGlobals);
  static ExceptionGlobals * m_PimplGlobals;
};
} // namespace itk
 
#endif