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 
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:
88 
98 
100 
111  vtkXMLDataElement* parent, int &currentFileIndex) override;
112 
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
vtkXMLPMultiBlockDataWriter::WriteComposite
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...
vtkXMLPMultiBlockDataWriter::~vtkXMLPMultiBlockDataWriter
~vtkXMLPMultiBlockDataWriter() override
vtkXMLPMultiBlockDataWriter::StartPiece
int StartPiece
Piece information.
Definition: vtkXMLPMultiBlockDataWriter.h:146
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:42
vtkXMLPMultiBlockDataWriter::Controller
vtkMultiProcessController * Controller
Definition: vtkXMLPMultiBlockDataWriter.h:99
vtkXMLPMultiBlockDataWriter::New
static vtkXMLPMultiBlockDataWriter * New()
vtkCompositeDataSet
abstract superclass for composite (multi-block or AMR) datasets
Definition: vtkCompositeDataSet.h:52
vtkMultiProcessController
Multiprocessing communication superclass.
Definition: vtkMultiProcessController.h:83
vtkXMLPMultiBlockDataWriter::vtkXMLPMultiBlockDataWriter
vtkXMLPMultiBlockDataWriter()
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkXMLPMultiBlockDataWriter::ProcessRequest
int ProcessRequest(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
Upstream/Downstream requests form the generalized interface through which executives invoke a algorit...
vtkXMLPMultiBlockDataWriter::CreatePieceFileName
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...
vtkXMLDataElement
Represents an XML element and those nested inside.
Definition: vtkXMLDataElement.h:37
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkXMLMultiBlockDataWriter.h
vtkXMLMultiBlockDataWriter
writer for vtkMultiBlockDataSet.
Definition: vtkXMLMultiBlockDataWriter.h:33
vtkXMLPMultiBlockDataWriter::SetController
virtual void SetController(vtkMultiProcessController *)
Controller used to communicate data type of blocks.
vtkXMLPMultiBlockDataWriter::RemoveWrittenFiles
void RemoveWrittenFiles(const char *subDirectory) override
Utility function to remove any already written files in case writer failed.
vtkXMLPMultiBlockDataWriter::FillDataTypes
void FillDataTypes(vtkCompositeDataSet *) override
Determine the data types for each of the leaf nodes.
vtkXMLPMultiBlockDataWriter::SetWriteMetaFile
void SetWriteMetaFile(int flag) override
Set whether this instance will write the meta-file.
vtkXMLPMultiBlockDataWriter::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkXMLPMultiBlockDataWriter::NumberOfPieces
int NumberOfPieces
Definition: vtkXMLPMultiBlockDataWriter.h:147
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:41
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:65
vtkXMLPMultiBlockDataWriter::ParallelWriteNonCompositeData
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...
vtkXMLPMultiBlockDataWriter
parallel writer for vtkHierarchicalBoxDataSet.
Definition: vtkXMLPMultiBlockDataWriter.h:39