vtkXMLStructuredDataReader.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 vtkXMLStructuredDataReader_h
#define vtkXMLStructuredDataReader_h
 
#include "vtkIOXMLModule.h"   // For export macro
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
#include "vtkXMLDataReader.h"
 
VTK_ABI_NAMESPACE_BEGIN
class VTKIOXML_EXPORT VTK_MARSHALAUTO vtkXMLStructuredDataReader : public vtkXMLDataReader
{
public:
  vtkTypeMacro(vtkXMLStructuredDataReader, vtkXMLDataReader);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  vtkIdType GetNumberOfPoints() override;

  vtkIdType GetNumberOfCells() override;


  vtkSetMacro(WholeSlices, vtkTypeBool);
  vtkGetMacro(WholeSlices, vtkTypeBool);
  vtkBooleanMacro(WholeSlices, vtkTypeBool);

  void CopyOutputInformation(vtkInformation* outInfo, int port) override;
 
protected:
  vtkXMLStructuredDataReader();
  ~vtkXMLStructuredDataReader() override;
 
  virtual void SetOutputExtent(VTK_FUTURE_CONST int extent[6]) = 0;
  int ReadPrimaryElement(vtkXMLDataElement* ePrimary) override;
 
  // Pipeline execute data driver.  Called by vtkXMLReader.
  void ReadXMLData() override;
 
  void SetupOutputInformation(vtkInformation* outInfo) override;
 
  // Internal representation of pieces in the file that may have come
  // from a streamed write.
  int* PieceExtents;
  int* PiecePointDimensions;
  vtkIdType* PiecePointIncrements;
  int* PieceCellDimensions;
  vtkIdType* PieceCellIncrements;
 
  // Whether to read in whole slices mode.
  vtkTypeBool WholeSlices;
 
  // The update extent and corresponding increments and dimensions.
  int UpdateExtent[6];
  int PointDimensions[3];
  int CellDimensions[3];
  vtkIdType PointIncrements[3];
  vtkIdType CellIncrements[3];
 
  int WholeExtent[6];
 
  // The extent currently being read.
  int SubExtent[6];
  int SubPointDimensions[3];
  int SubCellDimensions[3];
 
  // Override methods from superclass.
  void SetupEmptyOutput() override;
  void SetupPieces(int numPieces) override;
  void DestroyPieces() override;
  int ReadArrayForPoints(vtkXMLDataElement* da, vtkAbstractArray* outArray) override;
  int ReadArrayForCells(vtkXMLDataElement* da, vtkAbstractArray* outArray) override;
 
  // Internal utility methods.
  int ReadPiece(vtkXMLDataElement* ePiece) override;
  virtual int ReadSubExtent(int* inExtent, int* inDimensions, vtkIdType* inIncrements,
    int* outExtent, int* outDimensions, vtkIdType* outIncrements, int* subExtent,
    int* subDimensions, vtkXMLDataElement* da, vtkAbstractArray* array, FieldType type);
 
private:
  vtkXMLStructuredDataReader(const vtkXMLStructuredDataReader&) = delete;
  void operator=(const vtkXMLStructuredDataReader&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif