itkOpenCLCommandQueue.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 itkOpenCLCommandQueue_h
#define itkOpenCLCommandQueue_h
 
#include "itkOpenCL.h"
#include <ostream>
 
namespace itk
{
// Forward declaration
class OpenCLContext;
 
class ITKOpenCL_EXPORT OpenCLCommandQueue
{
public:
  using Self = OpenCLCommandQueue;
 
  OpenCLCommandQueue()
    : m_Context(0)
    , m_Id(0)
  {}
 
  OpenCLCommandQueue(OpenCLContext * context, cl_command_queue id)
    : m_Context(context)
    , m_Id(id)
  {}
 
  OpenCLCommandQueue(const OpenCLCommandQueue & other);
 
  ~OpenCLCommandQueue();
 
  OpenCLCommandQueue &
  operator=(const OpenCLCommandQueue & other);
 
  bool
  IsNull() const
  {
    return this->m_Id == 0;
  }
 
  bool
  IsOutOfOrder() const;
 
  bool
  IsProfilingEnabled() const;
 
  cl_command_queue
  GetQueueId() const
  {
    return this->m_Id;
  }
 
  OpenCLContext *
  GetContext() const
  {
    return this->m_Context;
  }
 
private:
  OpenCLContext *  m_Context;
  cl_command_queue m_Id;
};
 
bool ITKOpenCL_EXPORT
     operator==(const OpenCLCommandQueue & lhs, const OpenCLCommandQueue & rhs);
 
bool ITKOpenCL_EXPORT
     operator!=(const OpenCLCommandQueue & lhs, const OpenCLCommandQueue & rhs);
 
template <typename charT, typename traits>
inline std::basic_ostream<charT, traits> &
operator<<(std::basic_ostream<charT, traits> & strm, const OpenCLCommandQueue & queue)
{
  if (queue.IsNull())
  {
    strm << "OpenCLCommandQueue(null)";
    return strm;
  }
 
  const char indent = ' ';
 
  strm << "OpenCLCommandQueue\n"
       << indent << "Id: " << queue.GetQueueId() << '\n'
       << indent << "Out of order: " << (queue.IsOutOfOrder() ? "Yes" : "No") << '\n'
       << indent << "Profiling enabled: " << (queue.IsProfilingEnabled() ? "Yes" : "No") << std::endl;
 
  return strm;
}
 
 
} // end namespace itk
 
#endif /* itkOpenCLCommandQueue_h */