VTK  9.3.20240327
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
17 #ifndef vtkXMLPMultiBlockDataWriter_h
18 #define vtkXMLPMultiBlockDataWriter_h
19 
20 #include "vtkIOParallelXMLModule.h" // For export macro
22 
23 VTK_ABI_NAMESPACE_BEGIN
26 
27 class VTKIOPARALLELXML_EXPORT vtkXMLPMultiBlockDataWriter : public vtkXMLMultiBlockDataWriter
28 {
29 public:
32  void PrintSelf(ostream& os, vtkIndent indent) override;
33 
35 
38  vtkSetMacro(NumberOfPieces, int);
39  vtkGetMacro(NumberOfPieces, int);
41 
43 
46  vtkSetMacro(StartPiece, int);
47  vtkGetMacro(StartPiece, int);
49 
51 
59  vtkGetObjectMacro(Controller, vtkMultiProcessController);
61 
67  void SetWriteMetaFile(int flag) override;
68 
69  // See the vtkAlgorithm for a description of what these do
72 
73 protected:
76 
86 
88 
99  vtkCompositeDataSet* compositeData, vtkXMLDataElement* parent, int& currentFileIndex) override;
100 
113  vtkDataObject* dObj, vtkXMLDataElement* parentXML, int currentFileIndex);
114 
120  virtual vtkStdString CreatePieceFileName(int currentFileIndex, int procId, int dataSetType);
121 
126  void RemoveWrittenFiles(const char* subDirectory) override;
127 
129 
135 
136 private:
138  void operator=(const vtkXMLPMultiBlockDataWriter&) = delete;
139 
140  class vtkInternal;
141  vtkInternal* XMLPMultiBlockDataWriterInternal;
142 };
143 
144 VTK_ABI_NAMESPACE_END
145 #endif
abstract superclass for composite (multi-block or AMR) datasets
general representation of visualization data
a simple class to control print indentation
Definition: vtkIndent.h:108
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Multiprocessing communication superclass.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:78
Represents an XML element and those nested inside.
writer for vtkMultiBlockDataSet.
parallel writer for vtkHierarchicalBoxDataSet.
static vtkXMLPMultiBlockDataWriter * New()
~vtkXMLPMultiBlockDataWriter() override
void RemoveWrittenFiles(const char *subDirectory) override
Utility function to remove any already written files in case writer failed.
vtkMultiProcessController * Controller
int WriteComposite(vtkCompositeDataSet *compositeData, vtkXMLDataElement *parent, int &currentFileIndex) override
Internal method called recursively to create the xml tree for the children of compositeData as well a...
virtual void SetController(vtkMultiProcessController *)
Controller used to communicate data type of blocks.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual vtkStdString CreatePieceFileName(int currentFileIndex, int procId, int dataSetType)
Return the name of the file given the currentFileIndex (also the current globally numbered piece inde...
void SetWriteMetaFile(int flag) override
Set whether this instance will write the meta-file.
void FillDataTypes(vtkCompositeDataSet *) override
Determine the data types for each of the leaf nodes.
vtkTypeBool ProcessRequest(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
Upstream/Downstream requests form the generalized interface through which executives invoke a algorit...
int ParallelWriteNonCompositeData(vtkDataObject *dObj, vtkXMLDataElement *parentXML, int currentFileIndex)
Internal method to write a non vtkCompositeDataSet subclass as well as add in the file name to the me...
int vtkTypeBool
Definition: vtkABI.h:64