VTK  9.0.1
vtkDataObjectWriter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkDataObjectWriter.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 =========================================================================*/
30 #ifndef vtkDataObjectWriter_h
31 #define vtkDataObjectWriter_h
32 
33 #include "vtkDataWriter.h" // Needs data because it calls methods on it
34 #include "vtkIOLegacyModule.h" // For export macro
35 #include "vtkStdString.h" // For string used in api
36 #include "vtkWriter.h"
37 
38 class VTKIOLEGACY_EXPORT vtkDataObjectWriter : public vtkWriter
39 {
40 public:
41  static vtkDataObjectWriter* New();
43  void PrintSelf(ostream& os, vtkIndent indent) override;
44 
46 
49  void SetFileName(const char* filename) { this->Writer->SetFileName(filename); }
50  char* GetFileName() { return this->Writer->GetFileName(); }
51  void SetHeader(const char* header) { this->Writer->SetHeader(header); }
52  char* GetHeader() { return this->Writer->GetHeader(); }
53  void SetFileType(int type) { this->Writer->SetFileType(type); }
54  int GetFileType() { return this->Writer->GetFileType(); }
55  void SetFileTypeToASCII() { this->Writer->SetFileType(VTK_ASCII); }
56  void SetFileTypeToBinary() { this->Writer->SetFileType(VTK_BINARY); }
57  void SetWriteToOutputString(int b) { this->Writer->SetWriteToOutputString(b); }
58  void WriteToOutputStringOn() { this->Writer->WriteToOutputStringOn(); }
59  void WriteToOutputStringOff() { this->Writer->WriteToOutputStringOff(); }
60  int GetWriteToOutputString() { return this->Writer->GetWriteToOutputString(); }
61  char* GetOutputString() { return this->Writer->GetOutputString(); }
62  vtkStdString GetOutputStdString() { return this->Writer->GetOutputStdString(); }
63  vtkIdType GetOutputStringLength() { return this->Writer->GetOutputStringLength(); }
64  unsigned char* GetBinaryOutputString() { return this->Writer->GetBinaryOutputString(); }
65  void SetFieldDataName(const char* fieldname) { this->Writer->SetFieldDataName(fieldname); }
66  char* GetFieldDataName() { return this->Writer->GetFieldDataName(); }
68 
69 protected:
71  ~vtkDataObjectWriter() override;
72 
73  void WriteData() override;
75 
77 
78 private:
80  void operator=(const vtkDataObjectWriter&) = delete;
81 };
82 
83 #endif
vtkStdString.h
vtkDataObjectWriter::SetFileName
void SetFileName(const char *filename)
Methods delegated to vtkDataWriter, see vtkDataWriter.
Definition: vtkDataObjectWriter.h:49
vtkDataObjectWriter::GetOutputString
char * GetOutputString()
Definition: vtkDataObjectWriter.h:61
vtkDataObjectWriter::SetFieldDataName
void SetFieldDataName(const char *fieldname)
Definition: vtkDataObjectWriter.h:65
vtkDataObjectWriter::WriteToOutputStringOff
void WriteToOutputStringOff()
Definition: vtkDataObjectWriter.h:59
vtkX3D::type
@ type
Definition: vtkX3D.h:522
vtkIdType
int vtkIdType
Definition: vtkType.h:338
vtkDataObjectWriter::SetFileTypeToBinary
void SetFileTypeToBinary()
Definition: vtkDataObjectWriter.h:56
vtkDataObjectWriter::SetWriteToOutputString
void SetWriteToOutputString(int b)
Definition: vtkDataObjectWriter.h:57
vtkAlgorithm::FillInputPortInformation
virtual int FillInputPortInformation(int port, vtkInformation *info)
Fill the input port information objects for this algorithm.
vtkDataObjectWriter::SetFileType
void SetFileType(int type)
Definition: vtkDataObjectWriter.h:53
vtkWriter::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkDataObjectWriter
write vtk field data
Definition: vtkDataObjectWriter.h:38
vtkDataObjectWriter::Writer
vtkDataWriter * Writer
Definition: vtkDataObjectWriter.h:74
vtkDataObjectWriter::GetFileName
char * GetFileName()
Definition: vtkDataObjectWriter.h:50
vtkX3D::port
@ port
Definition: vtkX3D.h:453
vtkDataObjectWriter::GetWriteToOutputString
int GetWriteToOutputString()
Definition: vtkDataObjectWriter.h:60
vtkDataObjectWriter::WriteToOutputStringOn
void WriteToOutputStringOn()
Definition: vtkDataObjectWriter.h:58
vtkWriter::WriteData
virtual void WriteData()=0
vtkDataObjectWriter::GetFileType
int GetFileType()
Definition: vtkDataObjectWriter.h:54
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
VTK_ASCII
#define VTK_ASCII
Definition: vtkWriter.h:42
vtkDataObjectWriter::GetOutputStdString
vtkStdString GetOutputStdString()
Definition: vtkDataObjectWriter.h:62
vtkDataObjectWriter::SetFileTypeToASCII
void SetFileTypeToASCII()
Definition: vtkDataObjectWriter.h:55
vtkDataObjectWriter::GetOutputStringLength
vtkIdType GetOutputStringLength()
Definition: vtkDataObjectWriter.h:63
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:73
vtkX3D::info
@ info
Definition: vtkX3D.h:382
vtkAlgorithm::New
static vtkAlgorithm * New()
vtkWriter.h
vtkDataWriter.h
vtkDataObjectWriter::GetFieldDataName
char * GetFieldDataName()
Definition: vtkDataObjectWriter.h:66
vtkDataObjectWriter::GetHeader
char * GetHeader()
Definition: vtkDataObjectWriter.h:52
vtkDataObjectWriter::GetBinaryOutputString
unsigned char * GetBinaryOutputString()
Definition: vtkDataObjectWriter.h:64
vtkDataWriter
helper class for objects that write vtk data files
Definition: vtkDataWriter.h:47
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:34
VTK_BINARY
#define VTK_BINARY
Definition: vtkWriter.h:43
vtkDataObjectWriter::SetHeader
void SetHeader(const char *header)
Definition: vtkDataObjectWriter.h:51