vtkXMLPDataObjectWriter.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 vtkXMLPDataObjectWriter_h
#define vtkXMLPDataObjectWriter_h

#include "vtkIOParallelXMLModule.h" // For export macro
#include "vtkXMLWriter.h"

VTK_ABI_NAMESPACE_BEGIN
class vtkCallbackCommand;
class vtkMultiProcessController;

class VTKIOPARALLELXML_EXPORT vtkXMLPDataObjectWriter : public vtkXMLWriter
{
public:
  vtkTypeMacro(vtkXMLPDataObjectWriter, vtkXMLWriter);
  void PrintSelf(ostream& os, vtkIndent indent) override;


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


  vtkSetMacro(StartPiece, int);
  vtkGetMacro(StartPiece, int);
  vtkSetMacro(EndPiece, int);
  vtkGetMacro(EndPiece, int);


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


  vtkSetMacro(UseSubdirectory, bool);
  vtkGetMacro(UseSubdirectory, bool);


  virtual void SetWriteSummaryFile(int flag);
  vtkGetMacro(WriteSummaryFile, int);
  vtkBooleanMacro(WriteSummaryFile, int);


  virtual void SetController(vtkMultiProcessController*);
  vtkGetObjectMacro(Controller, vtkMultiProcessController);

  vtkTypeBool ProcessRequest(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

protected:
  vtkXMLPDataObjectWriter();
  ~vtkXMLPDataObjectWriter() override;

  int WriteInternal() override;

  int WriteData() override;

  virtual void WritePData(vtkIndent indent) = 0;

  virtual int WritePiece(int index) = 0;

  virtual int WritePieceInternal() = 0;

  virtual int RequestUpdateExtent(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector);

  virtual void PrepareSummaryFile();

  virtual void WritePPieceAttributes(int index);


  char* CreatePieceFileName(int index, const char* path = nullptr);
  void SplitFileName();

  static void ProgressCallbackFunction(vtkObject*, unsigned long, void*, void*);

  vtkGetMacro(ContinuingExecution, bool);

  vtkGetMacro(CurrentPiece, int);

  virtual void ProgressCallback(vtkAlgorithm* w);

  void DeleteFiles();

  vtkCallbackCommand* InternalProgressObserver;

  vtkMultiProcessController* Controller;

  int StartPiece;
  int EndPiece;
  int NumberOfPieces;
  int GhostLevel;
  int WriteSummaryFile;
  bool UseSubdirectory;

  char* PathName;
  char* FileNameBase;
  char* FileNameExtension;
  char* PieceFileNameExtension;

  unsigned char* PieceWrittenFlags;

  virtual void SetupPieceFileNameExtension();

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

  int CurrentPiece;

  bool ContinuingExecution;
};

VTK_ABI_NAMESPACE_END
#endif