vtkXMLPartitionedDataSetCollectionReader.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 vtkXMLPartitionedDataSetCollectionReader_h
#define vtkXMLPartitionedDataSetCollectionReader_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 vtkXMLPartitionedDataSetCollectionReader : public vtkXMLCompositeDataReader
{
public:
  static vtkXMLPartitionedDataSetCollectionReader* New();
  vtkTypeMacro(vtkXMLPartitionedDataSetCollectionReader, vtkXMLCompositeDataReader);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  vtkGetNewMacro(Assembly, vtkDataAssembly);

  vtkGetMacro(AssemblyTag, int);


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


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

protected:
  vtkXMLPartitionedDataSetCollectionReader();
  ~vtkXMLPartitionedDataSetCollectionReader() 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;

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

  int FillOutputPortInformation(int, vtkInformation* info) override;

  virtual const char* GetXMLPartitionsName() { return "Partitions"; }

  virtual const char* GetXMLPartitionIndexName() { return "index"; }

  void CreateMetaData(vtkXMLDataElement* ePrimary) override;

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

  virtual bool IsBlockSelected(unsigned int compositeIndex);

  virtual bool CanReadDataObject(vtkDataObject* dataObject);

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

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

VTK_ABI_NAMESPACE_END
#endif