vtkDataArrayDispatcher.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkDataArrayDispatcher.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
 
#ifndef vtkDataArrayDispatcher_h
#define vtkDataArrayDispatcher_h
 
#ifndef __VTK_WRAP__
 
#include "vtkDataArray.h"   //required for constructor of the vtkDataArrayFunctor
#include "vtkDeprecation.h" // for VTK_DEPRECATED_IN_9_0_0
#include "vtkType.h"        //Required for vtkIdType
#include <map>              //Required for the storage of template params to runtime params
 
// Object that is passed to all functor that are used with this class
// This allows the user the ability to find info about the size
template <typename T>
VTK_DEPRECATED_IN_9_0_0("Use vtkArrayDispatch")
struct vtkDataArrayDispatcherPointer
{
  typedef T ValueType;
 
  vtkIdType NumberOfTuples;
  vtkIdType NumberOfComponents;
  ValueType* RawPointer;
 
  explicit vtkDataArrayDispatcherPointer(vtkDataArray* array)
    : NumberOfTuples(array->GetNumberOfTuples())
    , NumberOfComponents(array->GetNumberOfComponents())
    , RawPointer(static_cast<ValueType*>(array->GetVoidPointer(0)))
  {
  }
};
 
// class template FunctorDispatcher
template <class DefaultFunctorType, typename ReturnType = void>
VTK_DEPRECATED_IN_9_0_0("Use vtkArrayDispatch")
class vtkDataArrayDispatcher
{
public:
  vtkDataArrayDispatcher(DefaultFunctorType& f);
 
  vtkDataArrayDispatcher();
 
  virtual ~vtkDataArrayDispatcher();
 
  ReturnType Go(vtkDataArray* lhs);
 
protected:
  DefaultFunctorType* DefaultFunctor;
  bool OwnsFunctor;
};
 
// We are making all these method non-inline to reduce compile time overhead
 
//----------------------------------------------------------------------------
template <class DefaultFunctorType, typename ReturnType>
VTK_DEPRECATED_IN_9_0_0("Use vtkArrayDispatch")
vtkDataArrayDispatcher<DefaultFunctorType, ReturnType>::vtkDataArrayDispatcher(
  DefaultFunctorType& fun)
  : DefaultFunctor(&fun)
  , OwnsFunctor(false)
{
  VTK_LEGACY_BODY(vtkDataArrayDispatcher, "VTK 9.0");
}
 
//----------------------------------------------------------------------------
template <class DefaultFunctorType, typename ReturnType>
VTK_DEPRECATED_IN_9_0_0("Use vtkArrayDispatch")
vtkDataArrayDispatcher<DefaultFunctorType, ReturnType>::vtkDataArrayDispatcher()
  : DefaultFunctor(new DefaultFunctorType())
  , OwnsFunctor(true)
{
  VTK_LEGACY_BODY(vtkDataArrayDispatcher, "VTK 9.0");
}
 
//----------------------------------------------------------------------------
template <class DefaultFunctorType, typename ReturnType>
VTK_DEPRECATED_IN_9_0_0("Use vtkArrayDispatch")
vtkDataArrayDispatcher<DefaultFunctorType, ReturnType>::~vtkDataArrayDispatcher()
{
  if (OwnsFunctor)
  {
    delete this->DefaultFunctor;
  }
}
 
//----------------------------------------------------------------------------
template <class DefaultFunctorType, typename ReturnType>
VTK_DEPRECATED_IN_9_0_0("Use vtkArrayDispatch")
ReturnType vtkDataArrayDispatcher<DefaultFunctorType, ReturnType>::Go(vtkDataArray* lhs)
{
  switch (lhs->GetDataType())
  {
    vtkTemplateMacro(return (*this->DefaultFunctor)(vtkDataArrayDispatcherPointer<VTK_TT>(lhs)));
  }
  return ReturnType();
}
 
#endif // __VTK_WRAP__
#endif // vtkDataArrayDispatcher_h
// VTK-HeaderTest-Exclude: vtkDataArrayDispatcher.h