1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkWriter
* @brief abstract class to write data to file(s)
*
* vtkWriter is an abstract class for mapper objects that write their data
* to disk (or into a communications port). All writers respond to Write()
* method. This method insures that there is input and input is up to date.
*
* @warning
* Every subclass of vtkWriter must implement a WriteData() method. Most likely
* will have to create SetInput() method as well.
*
* @sa
* vtkXMLDataSetWriter vtkDataSetWriter vtkImageWriter vtkMCubesWriter
*/
#ifndef vtkWriter_h
#define vtkWriter_h
#include "vtkAlgorithm.h"
#include "vtkIOCoreModule.h" // For export macro
VTK_ABI_NAMESPACE_BEGIN
class vtkDataObject;
#define VTK_ASCII 1
#define VTK_BINARY 2
class VTKIOCORE_EXPORT vtkWriter : public vtkAlgorithm
{
public:
vtkTypeMacro(vtkWriter, vtkAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent) override;
/**
* Write data to output. Method executes subclasses WriteData() method, as
* well as StartMethod() and EndMethod() methods.
* Returns 1 on success and 0 on failure.
*/
virtual int Write();
/**
* Encode the string so that the reader will not have problems.
* The resulting string is up to three times the size of the input
* string. doublePercent indicates whether to output a double '%' before
* escaped characters so the string may be used as a printf format string.
*/
void EncodeString(char* resname, const char* name, bool doublePercent);
/**
* Encode the string so that the reader will not have problems.
* The resulting string is up to three times the size of the input
* string. Write the string to the output stream.
* doublePercent indicates whether to output a double '%' before
* escaped characters so the string may be used as a printf format string.
*/
void EncodeWriteString(ostream* out, const char* name, bool doublePercent);
///@{
/**
* Set/get the input to this writer.
*/
void SetInputData(vtkDataObject* input);
void SetInputData(int index, vtkDataObject* input);
///@}
vtkDataObject* GetInput();
vtkDataObject* GetInput(int port);
protected:
vtkWriter();
~vtkWriter() override;
vtkTypeBool ProcessRequest(vtkInformation* request, vtkInformationVector** inputVector,
vtkInformationVector* outputVector) override;
virtual int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
vtkInformationVector* outputVector);
virtual void WriteData() = 0; // internal method subclasses must respond to
vtkTimeStamp WriteTime;
private:
vtkWriter(const vtkWriter&) = delete;
void operator=(const vtkWriter&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif
|
