vtkXMLCompositeDataReader.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 vtkXMLCompositeDataReader_h
#define vtkXMLCompositeDataReader_h

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

VTK_ABI_NAMESPACE_BEGIN
class vtkCompositeDataSet;
class vtkInformationIntegerKey;
class vtkInformationIntegerVectorKey;
struct vtkXMLCompositeDataReaderInternals;

VTK_ABI_NAMESPACE_END
#include <set>    // for std::set
#include <string> // for std::string

VTK_ABI_NAMESPACE_BEGIN
class VTKIOXML_EXPORT vtkXMLCompositeDataReader : public vtkXMLReader
{
public:
  vtkTypeMacro(vtkXMLCompositeDataReader, vtkXMLReader);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  enum
  {
    Block,
    Interleave
  };

  vtkSetClampMacro(PieceDistribution, int, Block, Interleave);
  vtkGetMacro(PieceDistribution, int);

  vtkCompositeDataSet* GetOutput();
  vtkCompositeDataSet* GetOutput(int);

  void SetFileName(VTK_FILEPATH const char*) override;

protected:
  vtkXMLCompositeDataReader();
  ~vtkXMLCompositeDataReader() override;

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

  // Returns the primary element pass to ReadPrimaryElement().
  vtkXMLDataElement* GetPrimaryElement();

  void ReadXMLData() override;
  int ReadPrimaryElement(vtkXMLDataElement* ePrimary) override;

  // Setup the output with no data available.  Used in error cases.
  void SetupEmptyOutput() override;

  int FillOutputPortInformation(int, vtkInformation* info) override;

  // Create a default executive.
  vtkExecutive* CreateDefaultExecutive() override;

  // Find the path to this file in case the internal files are
  // specified as relative paths.
  std::string GetFilePath();

  std::string GetFileNameFromXML(vtkXMLDataElement* xmlElem, const std::string& filePath);

  vtkXMLReader* GetReaderOfType(const char* type);
  vtkXMLReader* GetReaderForFile(const std::string& filename);

  int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;

  void SyncDataArraySelections(
    vtkXMLReader* accum, vtkXMLDataElement* xmlElem, const std::string& filePath);

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

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

  // Read the vtkDataObject (a leaf) in the composite dataset.
  virtual vtkDataObject* ReadDataObject(vtkXMLDataElement* xmlElem, const char* filePath);
  // Sets the file name or the input data for the reader
  // The default function simply calls SetFileName on the reader. In this case
  // the reader opens the file and reads the data from it.
  // An override, could specify that data is read from an input string using
  // ReadFromInputStringOn and SetInputString. In this case the data is read
  // by the function and then set to the reader.
  virtual bool ReaderSetFileNameOrData(vtkXMLReader* reader, const char* fileName);

  int ShouldReadDataSet(
    unsigned int datasetIndex, unsigned int pieceIndex = 0, unsigned int numPieces = 0);

#ifndef __VTK_WRAP__

  static unsigned int CountNestedElements(vtkXMLDataElement* element, const std::string& tagName,
    const std::set<std::string>& exclusions = std::set<std::string>());

#endif

  virtual void PrepareToCreateMetaData(vtkXMLDataElement* vtkNotUsed(ePrimary)) {}

  virtual void CreateMetaData(vtkXMLDataElement* ePrimary) = 0;

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

  vtkSmartPointer<vtkCompositeDataSet> Metadata;

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


  static int GetPieceAssignmentForBlockStrategy(
    unsigned int datasetIndex, unsigned int numDatasets, int numPieces);
  static int GetPieceAssignmentForInterleaveStrategy(
    unsigned int datasetIndex, unsigned int numDatasets, int numPieces);

  int PieceDistribution;

  vtkXMLCompositeDataReaderInternals* Internal;
};

VTK_ABI_NAMESPACE_END
#endif