vtkXMLMultiBlockDataReader.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 vtkXMLMultiBlockDataReader_h
#define vtkXMLMultiBlockDataReader_h

#include "vtkIOXMLModule.h" // For export macro
#include "vtkXMLCompositeDataReader.h"

#include <set>    // For std::set
#include <vector> // For std::vector

VTK_ABI_NAMESPACE_BEGIN
class vtkDataAssembly;

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

  vtkGetNewMacro(Assembly, vtkDataAssembly);

  vtkGetMacro(AssemblyTag, int);


  bool AddSelector(const char* selector);
  void ClearSelectors();
  void SetSelector(const char* selector);


  int GetNumberOfSelectors() const;
  const char* GetSelector(int index) const;

protected:
  vtkXMLMultiBlockDataReader();
  ~vtkXMLMultiBlockDataReader() override;

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

  int FillOutputPortInformation(int, vtkInformation* info) 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;

  // Reads file version < 1.0.
  virtual void ReadVersion0(vtkXMLDataElement* element, vtkCompositeDataSet* composite,
    const char* filePath, unsigned int& dataSetIndex);

  void PrepareToCreateMetaData(vtkXMLDataElement* ePrimary) override;

  void CreateMetaData(vtkXMLDataElement* ePrimary) override;

  void SyncCompositeDataArraySelections(vtkCompositeDataSet* composite, vtkXMLDataElement* element,
    const std::string& filePath) override;

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

  virtual int FillMetaData(vtkCompositeDataSet* composite, vtkXMLDataElement* element);

  void ReadCompositeInternal(vtkXMLDataElement* element, vtkCompositeDataSet* composite,
    const char* filePath, unsigned int& dataSetIndex, unsigned int& compositeIndex);

  bool IsBlockSelected(unsigned int compositeIndex);

  int AssemblyTag = 0;
  vtkNew<vtkDataAssembly> Assembly;
  std::set<std::string> Selectors;
  std::vector<unsigned int> SelectedCompositeIds;
  bool DistributePiecesInMultiPieces;
};

VTK_ABI_NAMESPACE_END
#endif