VTK  9.0.1
vtkWriter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkWriter.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 =========================================================================*/
34 #ifndef vtkWriter_h
35 #define vtkWriter_h
36 
37 #include "vtkAlgorithm.h"
38 #include "vtkIOCoreModule.h" // For export macro
39 
40 class vtkDataObject;
41 
42 #define VTK_ASCII 1
43 #define VTK_BINARY 2
44 
45 class VTKIOCORE_EXPORT vtkWriter : public vtkAlgorithm
46 {
47 public:
48  vtkTypeMacro(vtkWriter, vtkAlgorithm);
49  void PrintSelf(ostream& os, vtkIndent indent) override;
50 
56  virtual int Write();
57 
64  void EncodeString(char* resname, const char* name, bool doublePercent);
65 
73  void EncodeWriteString(ostream* out, const char* name, bool doublePercent);
74 
76 
79  void SetInputData(vtkDataObject* input);
80  void SetInputData(int index, vtkDataObject* input);
82 
83  vtkDataObject* GetInput();
84  vtkDataObject* GetInput(int port);
85 
86 protected:
87  vtkWriter();
88  ~vtkWriter() override;
89 
91  vtkInformationVector* outputVector) override;
92  virtual int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
93  vtkInformationVector* outputVector);
94 
95  virtual void WriteData() = 0; // internal method subclasses must respond to
97 
98 private:
99  vtkWriter(const vtkWriter&) = delete;
100  void operator=(const vtkWriter&) = delete;
101 };
102 
103 #endif
vtkAlgorithm
Superclass for all sources, filters, and sinks in VTK.
Definition: vtkAlgorithm.h:62
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:35
vtkTimeStamp
record modification and/or execution time
Definition: vtkTimeStamp.h:32
vtkAlgorithm.h
vtkX3D::port
@ port
Definition: vtkX3D.h:453
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkWriter
abstract class to write data to file(s)
Definition: vtkWriter.h:45
vtkX3D::name
@ name
Definition: vtkX3D.h:225
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:73
vtkAlgorithm::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkWriter::WriteTime
vtkTimeStamp WriteTime
Definition: vtkWriter.h:96
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:59
vtkX3D::index
@ index
Definition: vtkX3D.h:252
vtkAlgorithm::ProcessRequest
virtual vtkTypeBool ProcessRequest(vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
Upstream/Downstream requests form the generalized interface through which executives invoke a algorit...
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69