vtkXMLUniformGridAMRReader.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright (c) Kitware, Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkXMLUniformGridAMRReader_h
#define vtkXMLUniformGridAMRReader_h

#include "vtkIOXMLModule.h"  // For export macro
#include "vtkSmartPointer.h" // needed for vtkSmartPointer.
#include "vtkXMLPartitionedDataSetCollectionReader.h"

#include <map> // std::map

VTK_ABI_NAMESPACE_BEGIN
class vtkOverlappingAMR;
class vtkUniformGridAMR;

class VTKIOXML_EXPORT vtkXMLUniformGridAMRReader : public vtkXMLPartitionedDataSetCollectionReader
{
public:
  static vtkXMLUniformGridAMRReader* New();
  vtkTypeMacro(vtkXMLUniformGridAMRReader, vtkXMLPartitionedDataSetCollectionReader);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetMacro(MaximumLevelsToReadByDefault, unsigned int);
  vtkGetMacro(MaximumLevelsToReadByDefault, unsigned int);

protected:
  vtkXMLUniformGridAMRReader();
  ~vtkXMLUniformGridAMRReader() override;

  // Get the name of the data set being read.
  const char* GetDataSetName() override;

  int CanReadFileWithDataType(const char* dsname) override;

  int ReadVTKFile(vtkXMLDataElement* eVTKFile) override;

  const char* GetXMLPartitionsName() override { return "Block"; }

  const char* GetXMLPartitionIndexName() override { return "level"; }

  void CreateMetaData(vtkXMLDataElement* ePrimary) override;

  void SyncCompositeDataArraySelections(vtkCompositeDataSet* composite, vtkXMLDataElement* element,
    const std::string& filePath) override
  {
    this->Superclass::SyncCompositeDataArraySelections(composite, element, filePath);
  }

  int RequestDataObject(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

  bool IsBlockSelected(unsigned int compositeIndex) override;

  bool CanReadDataObject(vtkDataObject* dataObject) override;

  // Read the vtkDataSet (a leaf) in the composite dataset.
  vtkDataObject* ReadDataObject(vtkXMLDataElement* xmlElem, const char* filePath) override;

  // Read the XML element for the subtree of a composite dataset.
  // dataSetIndex is used to rank the leaf nodes in an inorder traversal.
  void ReadComposite(vtkXMLDataElement* element, vtkCompositeDataSet* composite,
    const char* filePath, unsigned int& dataSetIndex) override;

private:
  vtkXMLUniformGridAMRReader(const vtkXMLUniformGridAMRReader&) = delete;
  void operator=(const vtkXMLUniformGridAMRReader&) = delete;

  bool HasBlockRequests = true;
  unsigned int MaximumLevelsToReadByDefault = 0;
  std::map<unsigned int, unsigned int> CompositeIdToLevel;

  // Hide Selection functionality since, AMR only support levels
  vtkDataAssembly* GetAssembly() override { return nullptr; }
  int GetAssemblyTag() VTK_FUTURE_CONST override { return 0; }
  bool AddSelector(const char* vtkNotUsed(selector)) override { return false; }
  void ClearSelectors() override {}
  void SetSelector(const char* vtkNotUsed(selector)) override {}
  int GetNumberOfSelectors() const override { return 0; }
  const char* GetSelector(int vtkNotUsed(index)) const override { return nullptr; }

  char* OutputDataType = nullptr;
  vtkSetStringMacro(OutputDataType);
};

VTK_ABI_NAMESPACE_END
#endif