itkOpenCLPlatform.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 __itkOpenCLPlatform_h
#define __itkOpenCLPlatform_h
 
#include "itkOpenCL.h"
 
#include <string>
#include <list>
 
namespace itk
{
class ITKOpenCL_EXPORT OpenCLPlatform
{
public:
 
  typedef OpenCLPlatform Self;
 
  OpenCLPlatform() : m_Id( 0 ), m_Version( 0 ) {}
 
  OpenCLPlatform( cl_platform_id id ) : m_Id( id ), m_Version( 0 ) {}
 
  enum VendorType {
    Default,
    Intel,
    NVidia,
    AMD,
    IBM
  };
 
  bool IsNull() const { return this->m_Id == 0; }
 
  cl_platform_id GetPlatformId() const { return this->m_Id; }
 
  OpenCLVersion GetOpenCLVersion() const;
 
  std::string GetVersion() const;
 
  bool IsFullProfile() const;
 
  bool IsEmbeddedProfile() const;
 
  std::string GetProfile() const;
 
  std::string GetName() const;
 
  std::string GetVendor() const;
 
  VendorType GetVendorType() const;
 
  std::string GetExtensionSuffix() const;
 
  std::list< std::string > GetExtensions() const;
 
  bool HasExtension( const std::string & name ) const;
 
  static std::list< OpenCLPlatform > GetAllPlatforms();
 
  static OpenCLPlatform GetPlatform( const OpenCLPlatform::VendorType vendor );
 
private:
 
  cl_platform_id m_Id;
  mutable int    m_Version;
};
 
bool ITKOpenCL_EXPORT operator==( const OpenCLPlatform & lhs, const OpenCLPlatform & rhs );
 
bool ITKOpenCL_EXPORT operator!=( const OpenCLPlatform & lhs, const OpenCLPlatform & rhs );
 
template< typename charT, typename traits >
inline
std::basic_ostream< charT, traits > &
operator<<( std::basic_ostream< charT, traits > & strm,
  const OpenCLPlatform & platform )
{
  if( platform.IsNull() )
  {
    strm << "OpenCLPlatform(null)";
    return strm;
  }
 
  const char indent = ' ';
 
  strm << "OpenCLPlatform" << std::endl
       << indent << "Id: " << platform.GetPlatformId() << std::endl;
 
  strm << indent << "OpenCL version: ";
  switch( platform.GetOpenCLVersion() )
  {
    case VERSION_1_0:
      strm << "1.0"; break;
    case VERSION_1_1:
      strm << "1.1"; break;
    case VERSION_1_2:
      strm << "1.2"; break;
    case VERSION_2_0:
      strm << "2.0"; break;
    case VERSION_2_1:
      strm << "2.1"; break;
    default:
      strm << "Unknown"; break;
  }
 
  strm << std::endl << indent << "Full profile: " << ( platform.IsFullProfile() ? "On" : "Off" ) << std::endl
       << indent << "Embedded profile: " << ( platform.IsEmbeddedProfile() ? "On" : "Off" ) << std::endl
       << indent << "Profile: " << platform.GetProfile() << std::endl
       << indent << "Version: " << platform.GetVersion() << std::endl
       << indent << "Name: " << platform.GetName() << std::endl
       << indent << "Vendor: " << platform.GetVendor() << std::endl
       << indent << "Extension suffix: " << platform.GetExtensionSuffix() << std::endl;
 
  const std::list< std::string > extensions     = platform.GetExtensions();
  const std::size_t              extensionsSize = extensions.size();
  strm << indent << "Extensions(" << extensionsSize << "): ";
  if( extensions.empty() )
  {
    strm << "none";
  }
  else
  {
    strm << std::endl;
    for( std::list< std::string >::const_iterator it = extensions.begin(); it != extensions.end(); ++it )
    {
      strm << indent << indent << "- " << *it << std::endl;
    }
  }
 
  return strm;
}
 
 
} // end namespace itk
 
#endif /* __itkOpenCLPlatform_h */