VTK  9.1.0
vtkXMLPMultiBlockDataWriter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkXMLPMultiBlockDataWriter.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
26 #ifndef vtkXMLPMultiBlockDataWriter_h
27 #define vtkXMLPMultiBlockDataWriter_h
28 
29 #include "vtkIOParallelXMLModule.h" // For export macro
31 
34 
35 class VTKIOPARALLELXML_EXPORT vtkXMLPMultiBlockDataWriter : public vtkXMLMultiBlockDataWriter
36 {
37 public:
40  void PrintSelf(ostream& os, vtkIndent indent) override;
41 
43 
46  vtkSetMacro(NumberOfPieces, int);
47  vtkGetMacro(NumberOfPieces, int);
49 
51 
54  vtkSetMacro(StartPiece, int);
55  vtkGetMacro(StartPiece, int);
57 
59 
67  vtkGetObjectMacro(Controller, vtkMultiProcessController);
69 
75  void SetWriteMetaFile(int flag) override;
76 
77  // See the vtkAlgorithm for a description of what these do
80 
81 protected:
84 
94 
96 
107  vtkCompositeDataSet* compositeData, vtkXMLDataElement* parent, int& currentFileIndex) override;
108 
121  vtkDataObject* dObj, vtkXMLDataElement* parentXML, int currentFileIndex);
122 
128  virtual vtkStdString CreatePieceFileName(int currentFileIndex, int procId, int dataSetType);
129 
134  void RemoveWrittenFiles(const char* subDirectory) override;
135 
137 
143 
144 private:
146  void operator=(const vtkXMLPMultiBlockDataWriter&) = delete;
147 
148  class vtkInternal;
149  vtkInternal* XMLPMultiBlockDataWriterInternal;
150 };
151 
152 #endif
abstract superclass for composite (multi-block or AMR) datasets
general representation of visualization data
Definition: vtkDataObject.h:60
a simple class to control print indentation
Definition: vtkIndent.h:34
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:36
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:69