VTK  9.7.1
vtkXMLPMultiBlockDataWriter.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
16 #ifndef vtkXMLPMultiBlockDataWriter_h
17 #define vtkXMLPMultiBlockDataWriter_h
18 
19 #include "vtkIOParallelXMLModule.h" // For export macro
21 
22 VTK_ABI_NAMESPACE_BEGIN
25 
26 class VTKIOPARALLELXML_EXPORT vtkXMLPMultiBlockDataWriter : public vtkXMLMultiBlockDataWriter
27 {
28 public:
31  void PrintSelf(ostream& os, vtkIndent indent) override;
32 
34 
37  vtkSetMacro(NumberOfPieces, int);
38  vtkGetMacro(NumberOfPieces, int);
40 
42 
45  vtkSetMacro(StartPiece, int);
46  vtkGetMacro(StartPiece, int);
48 
50 
57  virtual void SetController(vtkMultiProcessController*);
58  vtkGetObjectMacro(Controller, vtkMultiProcessController);
60 
66  void SetWriteMetaFile(int flag) override;
67 
68  // See the vtkAlgorithm for a description of what these do
71 
72 protected:
74  ~vtkXMLPMultiBlockDataWriter() override;
75 
84  void FillDataTypes(vtkCompositeDataSet*) override;
85 
87 
97  int WriteComposite(
98  vtkCompositeDataSet* compositeData, vtkXMLDataElement* parent, int& currentFileIndex) override;
99 
111  int ParallelWriteNonCompositeData(
112  vtkDataObject* dObj, vtkXMLDataElement* parentXML, int currentFileIndex);
113 
119  virtual vtkStdString CreatePieceFileName(int currentFileIndex, int procId, int dataSetType);
120 
125  void MakeDirectory(const char* name) override;
126 
131  void RemoveWrittenFiles(const char* subDirectory) override;
132 
134 
140 
141 private:
143  void operator=(const vtkXMLPMultiBlockDataWriter&) = delete;
144 
145  class vtkInternal;
146  vtkInternal* XMLPMultiBlockDataWriterInternal;
147 };
148 
149 VTK_ABI_NAMESPACE_END
150 #endif
vtkMultiProcessController * Controller
parallel writer for vtkMultiBlockDataSet.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:27
writer for vtkMultiBlockDataSet.
Represents an XML element and those nested inside.
vtkTypeBool ProcessRequest(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
See the vtkAlgorithm for a description of what these do.
Store vtkAlgorithm input/output information.
virtual void RemoveWrittenFiles(const char *SubDirectory)
Utility function to remove any already written files in case writer failed.
virtual void FillDataTypes(vtkCompositeDataSet *)
Determine the data types for each of the leaf nodes.
static vtkXMLMultiBlockDataWriter * New()
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int vtkTypeBool
Definition: vtkABI.h:64
virtual void MakeDirectory(const char *name)
abstract superclass for composite (multi-block or AMR) datasets
a simple class to control print indentation
Definition: vtkIndent.h:28
vtkStdString CreatePieceFileName(int Piece)
Create a filename for the given index.
virtual void SetWriteMetaFile(int flag)
Get/Set whether this instance will write the meta-file.
Store zero or more vtkInformation instances.
int WriteComposite(vtkCompositeDataSet *compositeData, vtkXMLDataElement *parent, int &writerIdx) override
Internal method called recursively to create the xml tree for the children of compositeData as well a...
general representation of visualization data
Definition: vtkDataObject.h:55
Multiprocessing communication superclass.