vtkXMLWriter2.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 vtkXMLWriter2_h
#define vtkXMLWriter2_h
 
#include "vtkIOParallelXMLModule.h" // For export macro
#include "vtkXMLWriterBase.h"
 
#include <string>  // for std::string
#include <tuple>   // for std::tuple
#include <utility> // for std::pair
#include <vector>  // for std::vector
 
VTK_ABI_NAMESPACE_BEGIN
class vtkMultiProcessController;
 
class VTKIOPARALLELXML_EXPORT vtkXMLWriter2 : public vtkXMLWriterBase
{
public:
  vtkTypeMacro(vtkXMLWriter2, vtkXMLWriterBase);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  void SetController(vtkMultiProcessController* controller);
  vtkGetObjectMacro(Controller, vtkMultiProcessController);
 
 
  vtkSetClampMacro(NumberOfGhostLevels, int, 0, VTK_INT_MAX);
  vtkGetMacro(NumberOfGhostLevels, int);
 
  vtkTypeBool ProcessRequest(
    vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo) override;
 
protected:
  vtkXMLWriter2();
  ~vtkXMLWriter2() override;
 
 
  virtual int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*)
  {
    return 1;
  }
  virtual int RequestDataObject(vtkInformation*, vtkInformationVector**, vtkInformationVector*)
  {
    return 1;
  }
  virtual int RequestUpdateExtent(vtkInformation*, vtkInformationVector**, vtkInformationVector*);
  virtual int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) = 0;
 
  static std::tuple<std::string, std::string, std::string> SplitFileName(const std::string& fname);
 
  void AddArtifact(const std::string& fname, bool isDir = false);
 
  void AddRootArtifact(const std::string& fname, bool isDir = false);
 
  bool MakeDirectory(const std::string& dirname) const;
 
  static int ExclusiveScanSum(vtkMultiProcessController* controller, int value);
 
  std::vector<std::string> Gather(vtkMultiProcessController* controller,
    const std::vector<std::string>& values, int destinationRank);
 
private:
  vtkXMLWriter2(const vtkXMLWriter2&) = delete;
  void operator=(const vtkXMLWriter2&) = delete;
 
  void DeleteArtifacts();
 
  vtkMultiProcessController* Controller;
  int NumberOfGhostLevels;
  std::vector<std::pair<std::string, bool>> Artifacts;
};
 
VTK_ABI_NAMESPACE_END
#endif