VTK
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 =========================================================================*/
31 #ifndef vtkWriter_h
32 #define vtkWriter_h
33 
34 #include "vtkIOCoreModule.h" // For export macro
35 #include "vtkAlgorithm.h"
36 
37 class vtkDataObject;
38 
39 #define VTK_ASCII 1
40 #define VTK_BINARY 2
41 
42 class VTKIOCORE_EXPORT vtkWriter : public vtkAlgorithm
43 {
44 public:
45  vtkTypeMacro(vtkWriter,vtkAlgorithm);
46  void PrintSelf(ostream& os, vtkIndent indent) override;
47 
53  virtual int Write();
54 
61  void EncodeString(char* resname, const char* name, bool doublePercent);
62 
70  void EncodeWriteString(ostream* out, const char* name, bool doublePercent);
71 
73 
77  void SetInputData(int index, vtkDataObject *input);
79 
82 
83 protected:
85  ~vtkWriter() override;
86 
88  vtkInformationVector **inputVector,
89  vtkInformationVector *outputVector) override;
90  virtual int RequestData(vtkInformation *request,
91  vtkInformationVector **inputVector,
92  vtkInformationVector *outputVector);
93 
94  virtual void WriteData() = 0; //internal method subclasses must respond to
96 private:
97  vtkWriter(const vtkWriter&) = delete;
98  void operator=(const vtkWriter&) = delete;
99 };
100 
101 #endif
vtkWriter::RequestData
virtual int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
vtkWriter::GetInput
vtkDataObject * GetInput(int port)
vtkAlgorithm
Superclass for all sources, filters, and sinks in VTK.
Definition: vtkAlgorithm.h:60
vtkWriter::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:42
vtkWriter::Write
virtual int Write()
Write data to output.
vtkTimeStamp
record modification and/or execution time
Definition: vtkTimeStamp.h:36
vtkWriter::EncodeWriteString
void EncodeWriteString(ostream *out, const char *name, bool doublePercent)
Encode the string so that the reader will not have problems.
vtkWriter::vtkWriter
vtkWriter()
vtkAlgorithm.h
vtkX3D::port
@ port
Definition: vtkX3D.h:447
vtkWriter::WriteData
virtual void WriteData()=0
vtkWriter::GetInput
vtkDataObject * GetInput()
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkWriter::SetInputData
void SetInputData(vtkDataObject *input)
Set/get the input to this writer.
vtkWriter
abstract class to write data to file(s)
Definition: vtkWriter.h:43
vtkWriter::EncodeString
void EncodeString(char *resname, const char *name, bool doublePercent)
Encode the string so that the reader will not have problems.
vtkWriter::SetInputData
void SetInputData(int index, vtkDataObject *input)
vtkX3D::name
@ name
Definition: vtkX3D.h:219
vtkWriter::ProcessRequest
int ProcessRequest(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
Upstream/Downstream requests form the generalized interface through which executives invoke a algorit...
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkWriter::WriteTime
vtkTimeStamp WriteTime
Definition: vtkWriter.h:95
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:65
vtkX3D::index
@ index
Definition: vtkX3D.h:246
vtkWriter::~vtkWriter
~vtkWriter() override