/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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 itkGPUObjectFactoryBase_h
#define itkGPUObjectFactoryBase_h

#include "itkGPUSupportedImages.h"

// ITK includes
#include "itkVersion.h"
#include "itkObjectFactoryBase.h"

namespace itk
{
/** \class GPUObjectFactoryBase
 * \brief Base class for all GPU factory classes.
 *
 * \author Denis P. Shamonin and Marius Staring. Division of Image Processing,
 * Department of Radiology, Leiden, The Netherlands
 *
 * \note This work was funded by the Netherlands Organisation for
 * Scientific Research (NWO NRG-2010.02 and NWO 639.021.124).
 *
 */
template <typename NDimensions>
class ITK_TEMPLATE_EXPORT GPUObjectFactoryBase : public ObjectFactoryBase
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(GPUObjectFactoryBase);

  using Self = GPUObjectFactoryBase;
  using Superclass = ObjectFactoryBase;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  /** Class methods used to interface with the registered factories. */
  const char *
  GetITKSourceVersion() const override
  {
    return ITK_SOURCE_VERSION;
  }

  /** Run-time type information (and related methods). */
  itkOverrideGetNameOfClassMacro(GPUObjectFactoryBase);

  /** Supported dimensions. */
  itkStaticConstMacro(Support1D, bool, NDimensions::Support1D);
  itkStaticConstMacro(Support2D, bool, NDimensions::Support2D);
  itkStaticConstMacro(Support3D, bool, NDimensions::Support3D);

  /** Main register method. This method is usually called by the derived
   * class in the constructor or after UnRegisterAllFactories() was called. */
  virtual void
  RegisterAll();

protected:
  GPUObjectFactoryBase() = default;
  ~GPUObjectFactoryBase() override = default;

  /** Register methods for 1D. */
  virtual void
  Register1D()
  {}

  /** Register methods for 2D. */
  virtual void
  Register2D()
  {}

  /** Register methods for 3D. */
  virtual void
  Register3D()
  {}
};

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkGPUObjectFactoryBase.hxx"
#endif

#endif // end #ifndef itkGPUObjectFactoryBase_h
