VTK  9.0.1
vtkXMLCompositeDataWriter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: vtkXMLCompositeDataWriter.h
5 
6  Copyright (c) Kitware, Inc.
7  All rights reserved.
8  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html 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 vtkXMLCompositeDataWriter_h
27 #define vtkXMLCompositeDataWriter_h
28 
29 #include "vtkIOXMLModule.h" // For export macro
30 #include "vtkStdString.h" // needed for vtkStdString.
31 #include "vtkXMLWriter.h"
32 
33 class vtkCallbackCommand;
35 class vtkXMLDataElement;
36 class vtkXMLCompositeDataWriterInternals;
37 
38 class VTKIOXML_EXPORT vtkXMLCompositeDataWriter : public vtkXMLWriter
39 {
40 public:
42  void PrintSelf(ostream& os, vtkIndent indent) override;
43 
47  const char* GetDefaultFileExtension() override;
48 
57  vtkGetMacro(GhostLevel, int);
58  vtkSetMacro(GhostLevel, int);
60 
62 
65  vtkGetMacro(WriteMetaFile, int);
66  virtual void SetWriteMetaFile(int flag);
68 
74 
75 protected:
77  ~vtkXMLCompositeDataWriter() override;
78 
84  int GetDataSetMajorVersion() override { return 1; }
85  int GetDataSetMinorVersion() override { return 0; }
86 
90  vtkStdString CreatePieceFileName(int Piece);
91 
92  // see algorithm for more info
94 
96  int RequestUpdateExtent(vtkInformation*, vtkInformationVector**, vtkInformationVector*);
97 
98  int WriteData() override;
99  const char* GetDataSetName() override;
100 
101  // Create a default executive.
103 
105 
109  virtual void FillDataTypes(vtkCompositeDataSet*);
110 
114  unsigned int GetNumberOfDataTypes();
115 
119  int* GetDataTypesPointer();
120 
121  // Methods to create the set of writers matching the set of inputs.
122  void CreateWriters(vtkCompositeDataSet*);
123  vtkXMLWriter* GetWriter(int index);
124 
125  // Methods to help construct internal file names.
126  void SplitFileName();
127  const char* GetFilePrefix();
128  const char* GetFilePath();
129 
134  const char* GetDefaultFileExtensionForDataSet(int dataset_type);
135 
141  int WriteMetaFileIfRequested();
142 
143  // Make a directory.
144  void MakeDirectory(const char* name);
145 
146  // Remove a directory.
147  void RemoveADirectory(const char* name);
148 
149  // Internal implementation details.
150  vtkXMLCompositeDataWriterInternals* Internal;
151 
152  // The number of ghost levels to write for unstructured data.
154 
161 
162  // Callback registered with the InternalProgressObserver.
163  static void ProgressCallbackFunction(vtkObject*, unsigned long, void*, void*);
164  // Progress callback from internal writer.
165  virtual void ProgressCallback(vtkAlgorithm* w);
166 
167  // The observer to report progress from the internal writer.
169 
179  virtual int WriteComposite(
180  vtkCompositeDataSet* compositeData, vtkXMLDataElement* element, int& writerIdx) = 0;
181 
192  virtual int WriteNonCompositeData(
193  vtkDataObject* dObj, vtkXMLDataElement* element, int& writerIdx, const char* fileName);
194 
199  virtual void RemoveWrittenFiles(const char* SubDirectory);
200 
201 private:
203  void operator=(const vtkXMLCompositeDataWriter&) = delete;
204 };
205 
206 #endif
virtual const char * GetDataSetName()=0
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:34
abstract base class for most VTK objects
Definition: vtkObject.h:62
Represents an XML element and those nested inside.
virtual vtkExecutive * CreateDefaultExecutive()
Create a default executive.
Store vtkAlgorithm input/output information.
int GetDataSetMajorVersion() override
Methods to define the file's major and minor version numbers.
Superclass for all pipeline executives in VTK.
Definition: vtkExecutive.h:46
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkTypeBool ProcessRequest(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
Upstream/Downstream requests form the generalized interface through which executives invoke a algorit...
virtual int WriteData()
Definition: vtkXMLWriter.h:359
int vtkTypeBool
Definition: vtkABI.h:69
supports function callbacks
Superclass for all sources, filters, and sinks in VTK.
Definition: vtkAlgorithm.h:62
abstract superclass for composite (multi-block or AMR) datasets
Superclass for VTK's XML file writers.
Definition: vtkXMLWriter.h:61
a simple class to control print indentation
Definition: vtkIndent.h:33
virtual const char * GetDefaultFileExtension()=0
Get the default file extension for files written by this writer.
virtual int FillInputPortInformation(int port, vtkInformation *info)
Fill the input port information objects for this algorithm.
Writer for multi-group datasets.
virtual int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
vtkXMLCompositeDataWriterInternals * Internal
Store zero or more vtkInformation instances.
int WriteMetaFile
Whether to write the collection file on this node.
std::map< DataSetType, DataSet > Piece
Definition: VTXTypes.h:54
vtkCallbackCommand * InternalProgressObserver
general representation of visualization data
Definition: vtkDataObject.h:59