itkOpenCLEventList.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 __itkOpenCLEventList_h
#define __itkOpenCLEventList_h
 
#include "itkOpenCLEvent.h"
#include <vector>
 
namespace itk
{
class ITKOpenCL_EXPORT OpenCLEventList
{
public:
 
  typedef OpenCLEventList Self;
 
  typedef std::vector< cl_event > OpenCLEventListArrayType;
 
  OpenCLEventList() {}
 
  OpenCLEventList( const OpenCLEvent & event );
 
  OpenCLEventList( const OpenCLEventList & other );
 
  ~OpenCLEventList();
 
  OpenCLEventList & operator=( const OpenCLEventList & other );
 
  bool IsEmpty() const { return this->m_Events.empty(); }
 
  std::size_t GetSize() const { return this->m_Events.size(); }
 
  void Append( const OpenCLEvent & event );
 
  void Append( const OpenCLEventList & other );
 
  void Remove( const OpenCLEvent & event );
 
  OpenCLEvent Get( const std::size_t index ) const;
 
  bool Contains( const OpenCLEvent & event ) const;
 
  const cl_event * GetEventData() const;
 
  const OpenCLEventListArrayType & GetEventArray() const;
 
  OpenCLEventList & operator+=( const OpenCLEvent & event );
 
  OpenCLEventList & operator+=( const OpenCLEventList & other );
 
  OpenCLEventList & operator<<( const OpenCLEvent & event );
 
  OpenCLEventList & operator<<( const OpenCLEventList & other );
 
  cl_int WaitForFinished();
 
private:
 
  OpenCLEventListArrayType m_Events;
};
 
bool ITKOpenCL_EXPORT operator==( const OpenCLEventList & lhs, const OpenCLEventList & rhs );
 
bool ITKOpenCL_EXPORT operator!=( const OpenCLEventList & lhs, const OpenCLEventList & rhs );
 
template< typename charT, typename traits >
inline
std::basic_ostream< charT, traits > &
operator<<( std::basic_ostream< charT, traits > & strm,
  const OpenCLEventList & eventlist )
{
  if( !eventlist.GetSize() )
  {
    strm << "OpenCLEventList()";
    return strm;
  }
 
  OpenCLEventList::OpenCLEventListArrayType::const_iterator it;
  const OpenCLEventList::OpenCLEventListArrayType &         eventsArray = eventlist.GetEventArray();
 
  std::size_t id = 0;
  strm << "OpenCLEventList contains:" << std::endl;
  for( it = eventsArray.begin(); it < eventsArray.end(); ++it )
  {
    // const OpenCLEvent &event = *it;
    // strm << "array id: " << id << " " << event << std::endl;
 
    // Let's print only address, printing the OpenCLEvent
    // could halt execution of the program
    strm << "array id: " << id << " " << *it << std::endl;
    ++id;
  }
 
  return strm;
}
 
 
} // end namespace itk
 
#endif /* __itkOpenCLEventList_h */