vtkIdTypeArray.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 vtkIdTypeArray_h
#define vtkIdTypeArray_h

#include "vtkAOSDataArrayTemplate.h" // Real Superclass
#include "vtkCommonCoreModule.h"     // For export macro
#include "vtkDataArray.h"

// Fake the superclass for non-Python wrappers.
// Python can handle the templated superclass; Java and others cannot.
#if !defined(__VTK_WRAP__) || defined(__VTK_WRAP_PYTHON__) || defined(__VTK_WRAP_HIERARCHY__)
#define vtkDataArray vtkAOSDataArrayTemplate<vtkIdType>
#endif
VTK_ABI_NAMESPACE_BEGIN
class VTKCOMMONCORE_EXPORT vtkIdTypeArray : public vtkDataArray
{
public:
  vtkTypeMacro(vtkIdTypeArray, vtkDataArray);
#if !defined(__VTK_WRAP__) || defined(__VTK_WRAP_PYTHON__) || defined(__VTK_WRAP_HIERARCHY__)
#undef vtkDataArray
#endif
  using DataTypeTag = std::integral_constant<int, VTK_ID_TYPE>;
  static vtkIdTypeArray* New();
  static vtkIdTypeArray* ExtendedNew();
  void PrintSelf(ostream& os, vtkIndent indent) override;

  // This macro expands to the set of method declarations that
  // make up the interface of vtkAOSDataArrayTemplate, which is ignored
  // by the wrappers.
#if (defined(__VTK_WRAP__) || defined(__WRAP_GCCXML__)) && !defined(__VTK_WRAP_PYTHON__)
  vtkCreateWrappedArrayInterface(vtkIdType);
#else

  int GetDataType() const override
  {
    // This needs to overwritten from superclass because
    // the templated superclass is not able to differentiate
    // vtkIdType from a long long or an int since vtkIdType
    // is simply a typedef. This means that
    // vtkAOSDataArrayTemplate<vtkIdType> != vtkIdTypeArray.
    return vtkIdTypeArray::DataTypeTag::value;
  }
#endif

  static vtkIdTypeArray* FastDownCast(vtkAbstractArray* source)
  {
    return static_cast<vtkIdTypeArray*>(Superclass::FastDownCast(source));
  }

protected:
  vtkIdTypeArray();
  ~vtkIdTypeArray() override;

private:
  typedef vtkAOSDataArrayTemplate<vtkIdType> RealSuperclass;

  vtkIdTypeArray(const vtkIdTypeArray&) = delete;
  void operator=(const vtkIdTypeArray&) = delete;
};

// Define vtkArrayDownCast implementation:
vtkArrayDownCast_FastCastMacro(vtkIdTypeArray);

VTK_ABI_NAMESPACE_END
#endif