itkOpenCLProgram.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  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 itkOpenCLProgram_h
#define itkOpenCLProgram_h
 
#include "itkOpenCLDevice.h"
#include "itkOpenCLKernel.h"
 
#include <string>
 
namespace itk
{
// Forward declaration
class OpenCLContext;
 
class ITKOpenCL_EXPORT OpenCLProgram
{
public:
  using Self = OpenCLProgram;
 
  OpenCLProgram();
 
  OpenCLProgram(OpenCLContext * context, cl_program id, const std::string & fileName = std::string());
 
  OpenCLProgram(const OpenCLProgram & other);
 
  ~OpenCLProgram();
 
  OpenCLProgram &
  operator=(const OpenCLProgram & other);
 
  bool
  IsNull() const
  {
    return this->m_Id == 0;
  }
 
  OpenCLContext *
  GetContext() const
  {
    return this->m_Context;
  }
 
  cl_program
  GetProgramId() const
  {
    return this->m_Id;
  }
 
  std::string
  GetFileName() const
  {
    return this->m_FileName;
  }
 
  bool
  Build(const std::string & extraBuildOptions = std::string());
 
  bool
  Build(const std::list<OpenCLDevice> & devices, const std::string & extraBuildOptions = std::string());
 
  std::string
  GetLog() const;
 
  std::list<OpenCLDevice>
  GetDevices() const;
 
  OpenCLKernel
  CreateKernel(const std::string & name) const;
 
  std::list<OpenCLKernel>
  CreateKernels() const;
 
private:
  OpenCLContext * m_Context;
  cl_program      m_Id;
  std::string     m_FileName;
};
 
bool ITKOpenCL_EXPORT
     operator==(const OpenCLProgram & lhs, const OpenCLProgram & rhs);
 
bool ITKOpenCL_EXPORT
     operator!=(const OpenCLProgram & lhs, const OpenCLProgram & rhs);
 
template <typename charT, typename traits>
inline std::basic_ostream<charT, traits> &
operator<<(std::basic_ostream<charT, traits> & strm, const OpenCLProgram & program)
{
  if (program.IsNull())
  {
    strm << "OpenCLProgram(null)";
    return strm;
  }
 
  const char indent = ' ';
 
  strm << "OpenCLProgram\n" << indent << "Id: " << program.GetProgramId() << std::endl;
 
  return strm;
}
 
 
} // end namespace itk
 
#endif /* itkOpenCLProgram_h */