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


  vtkSetMacro(NumberOfPieces, int);
  vtkGetMacro(NumberOfPieces, int);


  vtkSetMacro(WritePiece, int);
  vtkGetMacro(WritePiece, int);


  vtkSetMacro(GhostLevel, int);
  vtkGetMacro(GhostLevel, int);


  vtkSetVector6Macro(WriteExtent, int);
  vtkGetVector6Macro(WriteExtent, int);
 
protected:
  vtkXMLStructuredDataWriter();
  ~vtkXMLStructuredDataWriter() override;
 
  // Writing drivers defined by subclasses.
  void WritePrimaryElementAttributes(ostream& os, vtkIndent indent) override;
  virtual void WriteAppendedPiece(int index, vtkIndent indent);
  virtual void WriteAppendedPieceData(int index);
  virtual void WriteInlinePiece(vtkIndent indent);
  virtual void GetInputExtent(int* extent) = 0;
 
  virtual int WriteHeader();
  virtual int WriteAPiece();
  virtual int WriteFooter();
 
  virtual void AllocatePositionArrays();
  virtual void DeletePositionArrays();
 
  virtual int WriteInlineMode(vtkIndent indent);
  vtkIdType GetStartTuple(
    VTK_FUTURE_CONST int extent[6], vtkIdType* increments, int i, int j, int k);
  void CalculatePieceFractions(float* fractions);
 
  void SetInputUpdateExtent(int piece);
  vtkTypeBool ProcessRequest(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
 
  vtkSetVector6Macro(InternalWriteExtent, int);
 
  static vtkIdType GetNumberOfValues(vtkDataSet* input);
 
  // The extent of the input to write, as specified by user
  int WriteExtent[6];
 
  // The actual extent of the input to write.
  int InternalWriteExtent[6];
 
  // Number of pieces used for streaming.
  int NumberOfPieces;
 
  int WritePiece;
 
  float* ProgressFractions;
 
  int CurrentPiece;
 
  int GhostLevel;
 
  vtkTypeInt64* ExtentPositions;
 
  // Appended data offsets of point and cell data arrays.
  // Store offset position (add TimeStep support)
  OffsetsManagerArray* PointDataOM;
  OffsetsManagerArray* CellDataOM;
 
private:
  vtkXMLStructuredDataWriter(const vtkXMLStructuredDataWriter&) = delete;
  void operator=(const vtkXMLStructuredDataWriter&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif