VTK  9.3.1
vtkXMLCompositeDataWriter.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-FileCopyrightText: Copyright (c) Kitware, Inc.
3 // SPDX-License-Identifier: BSD-3-Clause
15 #ifndef vtkXMLCompositeDataWriter_h
16 #define vtkXMLCompositeDataWriter_h
17 
18 #include "vtkIOXMLModule.h" // For export macro
19 #include "vtkStdString.h" // needed for vtkStdString.
20 #include "vtkXMLWriter.h"
21 
22 VTK_ABI_NAMESPACE_BEGIN
23 class vtkCallbackCommand;
25 class vtkXMLDataElement;
26 class vtkXMLCompositeDataWriterInternals;
27 
28 class VTKIOXML_EXPORT vtkXMLCompositeDataWriter : public vtkXMLWriter
29 {
30 public:
32  void PrintSelf(ostream& os, vtkIndent indent) override;
33 
37  const char* GetDefaultFileExtension() override;
38 
43 
47  vtkGetMacro(GhostLevel, int);
48  vtkSetMacro(GhostLevel, int);
50 
52 
55  vtkGetMacro(WriteMetaFile, int);
56  virtual void SetWriteMetaFile(int flag);
58 
64 
65 protected:
67  ~vtkXMLCompositeDataWriter() override;
68 
74  int GetDataSetMajorVersion() override { return 1; }
75  int GetDataSetMinorVersion() override { return 0; }
76 
80  vtkStdString CreatePieceFileName(int Piece);
81 
82  // see algorithm for more info
84 
86  int RequestUpdateExtent(vtkInformation*, vtkInformationVector**, vtkInformationVector*);
87 
88  int WriteData() override;
89  const char* GetDataSetName() override;
90 
91  // Create a default executive.
93 
95 
99  virtual void FillDataTypes(vtkCompositeDataSet*);
100 
104  unsigned int GetNumberOfDataTypes();
105 
109  int* GetDataTypesPointer();
110 
111  // Methods to create the set of writers matching the set of inputs.
112  void CreateWriters(vtkCompositeDataSet*);
113  vtkXMLWriter* GetWriter(int index);
114 
115  // Methods to help construct internal file names.
116  void SplitFileName();
117  VTK_FILEPATH const char* GetFilePrefix();
118  VTK_FILEPATH const char* GetFilePath();
119 
124  const char* GetDefaultFileExtensionForDataSet(int dataset_type);
125 
131  int WriteMetaFileIfRequested();
132 
133  // Make a directory.
134  virtual void MakeDirectory(const char* name);
135 
136  // Remove a directory.
137  void RemoveADirectory(const char* name);
138 
139  // Internal implementation details.
140  vtkXMLCompositeDataWriterInternals* Internal;
141 
142  // The number of ghost levels to write for unstructured data.
144 
151 
152  // Callback registered with the InternalProgressObserver.
153  static void ProgressCallbackFunction(vtkObject*, unsigned long, void*, void*);
154  // Progress callback from internal writer.
155  virtual void ProgressCallback(vtkAlgorithm* w);
156 
157  // The observer to report progress from the internal writer.
159 
169  virtual int WriteComposite(
170  vtkCompositeDataSet* compositeData, vtkXMLDataElement* element, int& writerIdx) = 0;
171 
182  virtual int WriteNonCompositeData(
183  vtkDataObject* dObj, vtkXMLDataElement* element, int& writerIdx, const char* fileName);
184 
189  virtual void RemoveWrittenFiles(const char* SubDirectory);
190 
191 private:
193  void operator=(const vtkXMLCompositeDataWriter&) = delete;
194 };
195 
196 VTK_ABI_NAMESPACE_END
197 #endif
virtual const char * GetDataSetName()=0
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:28
abstract base class for most VTK objects
Definition: vtkObject.h:51
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:38
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:147
int vtkTypeBool
Definition: vtkABI.h:64
supports function callbacks
Superclass for all sources, filters, and sinks in VTK.
Definition: vtkAlgorithm.h:51
abstract superclass for composite (multi-block or AMR) datasets
Superclass for VTK's XML file writers.
Definition: vtkXMLWriter.h:53
a simple class to control print indentation
Definition: vtkIndent.h:28
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)
#define VTK_FILEPATH
vtkXMLCompositeDataWriterInternals * Internal
Store zero or more vtkInformation instances.
virtual const char * GetDefaultFileExtension()=0
Get the default file extension for files written by this writer.
int WriteMetaFile
Whether to write the collection file on this node.
std::map< DataSetType, DataSet > Piece
Definition: VTXTypes.h:43
vtkCallbackCommand * InternalProgressObserver
general representation of visualization data
Definition: vtkDataObject.h:54