VTK  9.0.1
vtkXMLDataObjectWriter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkXMLDataObjectWriter.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 vtkXMLDataObjectWriter_h
30 #define vtkXMLDataObjectWriter_h
31 
32 #include "vtkIOXMLModule.h" // For export macro
33 #include "vtkXMLWriter.h"
34 
35 class vtkCallbackCommand;
36 
37 class VTKIOXML_EXPORT vtkXMLDataObjectWriter : public vtkXMLWriter
38 {
39 public:
41  void PrintSelf(ostream& os, vtkIndent indent) override;
42  static vtkXMLDataObjectWriter* New();
43 
48 
55  static vtkXMLWriter* NewWriter(int dataset_type);
56 
57 protected:
59  ~vtkXMLDataObjectWriter() override;
60 
61  // see algorithm for more info
63 
64  // Override writing method from superclass.
65  int WriteInternal() override;
66 
67  // Dummies to satisfy pure virtuals from superclass.
68  const char* GetDataSetName() override;
69  const char* GetDefaultFileExtension() override;
70 
71  // Callback registered with the InternalProgressObserver.
72  static void ProgressCallbackFunction(vtkObject*, unsigned long, void*, void*);
73  // Progress callback from internal writer.
74  virtual void ProgressCallback(vtkAlgorithm* w);
75 
76  // The observer to report progress from the internal writer.
78 
79 private:
81  void operator=(const vtkXMLDataObjectWriter&) = delete;
82 };
83 
84 #endif
vtkXMLDataObjectWriter
Write any type of VTK XML file.
Definition: vtkXMLDataObjectWriter.h:37
vtkXMLWriter::GetDefaultFileExtension
virtual const char * GetDefaultFileExtension()=0
Get the default file extension for files written by this writer.
vtkAlgorithm
Superclass for all sources, filters, and sinks in VTK.
Definition: vtkAlgorithm.h:62
vtkAlgorithm::FillInputPortInformation
virtual int FillInputPortInformation(int port, vtkInformation *info)
Fill the input port information objects for this algorithm.
vtkXMLWriter.h
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:62
vtkXMLWriter::WriteInternal
virtual int WriteInternal()
vtkX3D::port
@ port
Definition: vtkX3D.h:453
vtkXMLWriter
Superclass for VTK's XML file writers.
Definition: vtkXMLWriter.h:61
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkXMLWriter::GetDataSetName
virtual const char * GetDataSetName()=0
vtkXMLWriter::GetInput
vtkDataObject * GetInput()
Definition: vtkXMLWriter.h:239
vtkXMLDataObjectWriter::InternalProgressObserver
vtkCallbackCommand * InternalProgressObserver
Definition: vtkXMLDataObjectWriter.h:77
vtkDataSet
abstract class to specify dataset behavior
Definition: vtkDataSet.h:56
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:73
vtkX3D::info
@ info
Definition: vtkX3D.h:382
vtkAlgorithm::New
static vtkAlgorithm * New()
vtkCallbackCommand
supports function callbacks
Definition: vtkCallbackCommand.h:44
vtkXMLWriter::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.