vtkCompositeDataSet.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 vtkCompositeDataSet_h
#define vtkCompositeDataSet_h
 
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkDataObject.h"
#include "vtkDeprecation.h"   // For VTK_DEPRECATED_IN_9_3_0
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
 
#include <vector> // For GetDataSets
 
VTK_ABI_NAMESPACE_BEGIN
class vtkCompositeDataIterator;
class vtkCompositeDataSetInternals;
class vtkDataSet;
class vtkInformation;
class vtkInformationStringKey;
class vtkInformationIntegerKey;
 
class VTKCOMMONDATAMODEL_EXPORT VTK_MARSHALAUTO vtkCompositeDataSet : public vtkDataObject
{
public:
  vtkTypeMacro(vtkCompositeDataSet, vtkDataObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual VTK_NEWINSTANCE vtkCompositeDataIterator* NewIterator() = 0;

  int GetDataObjectType() override { return VTK_COMPOSITE_DATA_SET; }

  virtual void CopyStructure(vtkCompositeDataSet* input);

  virtual void SetDataSet(vtkCompositeDataIterator* iter, vtkDataObject* dataObj) = 0;

  virtual vtkDataObject* GetDataSet(vtkCompositeDataIterator* iter) = 0;

  virtual vtkDataObject* GetDataSet(unsigned int flatIndex);

  unsigned long GetActualMemorySize() override;


  static vtkCompositeDataSet* GetData(vtkInformation* info);
  static vtkCompositeDataSet* GetData(vtkInformationVector* v, int i = 0);

  void Initialize() override;

  virtual void CompositeShallowCopy(vtkCompositeDataSet* src);

  VTK_DEPRECATED_IN_9_3_0("Use ShallowCopy instead.")
  virtual void RecursiveShallowCopy(vtkDataObject* src);

  virtual vtkIdType GetNumberOfPoints();

  virtual vtkIdType GetNumberOfCells();

  vtkIdType GetNumberOfElements(int type) override;

  void GetBounds(double bounds[6]);

  static vtkInformationStringKey* NAME();

  static vtkInformationIntegerKey* CURRENT_PROCESS_CAN_LOAD_BLOCK();

  template <class DataSetT = vtkDataSet>
  static std::vector<DataSetT*> GetDataSets(vtkDataObject* dobj, bool preserveNull = false);

  bool SupportsGhostArray(int type) override;
 
protected:
  vtkCompositeDataSet();
  ~vtkCompositeDataSet() override;
 
private:
  vtkCompositeDataSet(const vtkCompositeDataSet&) = delete;
  void operator=(const vtkCompositeDataSet&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#include "vtkCompositeDataSet.txx" // for template implementations
 
#endif