vtkmDataArrayFactory.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkmDataArrayFactory_h
#define vtkmDataArrayFactory_h
 
#include "vtkAcceleratorsVTKmCoreModule.h" // For export macro
#include "vtkObject.h"
#include "vtkmlib/vtkmInitializer.h" // Need for initializing viskores
 
#include <vector> // For std::vector
 
VTK_ABI_NAMESPACE_BEGIN
 
class vtkDataArray;
class vtkMemoryDescriptor;
 
class VTKACCELERATORSVTKMCORE_EXPORT vtkmDataArrayFactory : public vtkObject
{
public:
  static vtkmDataArrayFactory* New();
  vtkTypeMacro(vtkmDataArrayFactory, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetMacro(NumberOfTuples, vtkIdType);
  vtkGetMacro(NumberOfTuples, vtkIdType);


  vtkSetMacro(NumberOfComponents, int);
  vtkGetMacro(NumberOfComponents, int);


  vtkSetMacro(DataType, int);
  vtkGetMacro(DataType, int);

  void AddBuffer(vtkMemoryDescriptor* descriptor);

  void ClearBuffers();

  int GetNumberOfBuffers() const;

  VTK_NEWINSTANCE
  vtkDataArray* CreateArray();
 
protected:
  vtkmDataArrayFactory();
  ~vtkmDataArrayFactory() override;
 
  vtkIdType NumberOfTuples = 0;
  int NumberOfComponents = 1;
  int DataType = 10; // VTK_FLOAT
 
  std::vector<vtkMemoryDescriptor*> Buffers;
 
private:
  vtkmDataArrayFactory(const vtkmDataArrayFactory&) = delete;
  void operator=(const vtkmDataArrayFactory&) = delete;
 
  // Viskores has to be initialized before any of its devices is touched, and
  // this class is the one place in Core that hands it device memory. Every
  // vtkm *filter* carries this member; nothing in Core did, so a program that
  // only wrapped external memory -- which is exactly what the DLPack import
  // path does -- never initialized it. On a Kokkos-backed build that is not a
  // warning: the first host read of a device array calls Kokkos::HIP::HIP(),
  // which calls host_abort(). The process dies with no exception to catch.
  vtkmInitializer Initializer;
};
 
VTK_ABI_NAMESPACE_END
#endif // vtkmDataArrayFactory_h