VTK
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 =========================================================================*/
29 #ifndef vtkXMLPMultiBlockDataWriter_h
30 #define vtkXMLPMultiBlockDataWriter_h
31 
32 #include "vtkIOParallelXMLModule.h" // For export macro
34 
37 
38 class VTKIOPARALLELXML_EXPORT vtkXMLPMultiBlockDataWriter : public vtkXMLMultiBlockDataWriter
39 {
40 public:
43  void PrintSelf(ostream& os, vtkIndent indent) override;
44 
46 
49  vtkSetMacro(NumberOfPieces, int);
50  vtkGetMacro(NumberOfPieces, int);
52 
54 
57  vtkSetMacro(StartPiece, int);
58  vtkGetMacro(StartPiece, int);
60 
62 
69  virtual void SetController(vtkMultiProcessController*);
70  vtkGetObjectMacro(Controller, vtkMultiProcessController);
72 
78  void SetWriteMetaFile(int flag) override;
79 
80  // See the vtkAlgorithm for a description of what these do
83  vtkInformationVector*) override;
84 
85 protected:
87  ~vtkXMLPMultiBlockDataWriter() override;
88 
97  void FillDataTypes(vtkCompositeDataSet*) override;
98 
100 
110  int WriteComposite(vtkCompositeDataSet* compositeData,
111  vtkXMLDataElement* parent, int &currentFileIndex) override;
112 
124  int ParallelWriteNonCompositeData(
125  vtkDataObject* dObj, vtkXMLDataElement* parentXML,
126  int currentFileIndex);
127 
134  int currentFileIndex, int procId, int dataSetType);
135 
140  void RemoveWrittenFiles(const char* subDirectory) override;
141 
143 
149 
150 private:
152  void operator=(const vtkXMLPMultiBlockDataWriter&) = delete;
153 
154  class vtkInternal;
155  vtkInternal* XMLPMultiBlockDataWriterInternal;
156 };
157 
158 #endif
vtkXMLCompositeDataWriter::FillDataTypes
virtual void FillDataTypes(vtkCompositeDataSet *)
Determine the data types for each of the leaf nodes.
vtkXMLPMultiBlockDataWriter::StartPiece
int StartPiece
Piece information.
Definition: vtkXMLPMultiBlockDataWriter.h:146
vtkXMLCompositeDataWriter::RemoveWrittenFiles
virtual void RemoveWrittenFiles(const char *SubDirectory)
Utility function to remove any already written files in case writer failed.
vtkXMLMultiBlockDataWriter::WriteComposite
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...
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:41
vtkXMLPMultiBlockDataWriter::Controller
vtkMultiProcessController * Controller
Definition: vtkXMLPMultiBlockDataWriter.h:99
vtkCompositeDataSet
abstract superclass for composite (multi-block or AMR) datasets
Definition: vtkCompositeDataSet.h:51
vtkXMLCompositeDataWriter::ProcessRequest
int ProcessRequest(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
See the vtkAlgorithm for a description of what these do.
vtkXMLCompositeDataWriter::CreatePieceFileName
vtkStdString CreatePieceFileName(int Piece)
Create a filename for the given index.
vtkMultiProcessController
Multiprocessing communication superclass.
Definition: vtkMultiProcessController.h:82
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkXMLDataElement
Represents an XML element and those nested inside.
Definition: vtkXMLDataElement.h:36
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:86
vtkXMLMultiBlockDataWriter::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkXMLMultiBlockDataWriter.h
vtkXMLMultiBlockDataWriter
writer for vtkMultiBlockDataSet.
Definition: vtkXMLMultiBlockDataWriter.h:32
vtkXMLCompositeDataWriter::SetWriteMetaFile
virtual void SetWriteMetaFile(int flag)
vtkXMLPMultiBlockDataWriter::NumberOfPieces
int NumberOfPieces
Definition: vtkXMLPMultiBlockDataWriter.h:147
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:40
vtkXMLMultiBlockDataWriter::New
static vtkXMLMultiBlockDataWriter * New()
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:64
vtkXMLPMultiBlockDataWriter
parallel writer for vtkHierarchicalBoxDataSet.
Definition: vtkXMLPMultiBlockDataWriter.h:38