VTK
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 =========================================================================*/
33 #ifndef vtkDataObjectWriter_h
34 #define vtkDataObjectWriter_h
35 
36 #include "vtkIOLegacyModule.h" // For export macro
37 #include "vtkWriter.h"
38 #include "vtkDataWriter.h" // Needs data because it calls methods on it
39 #include "vtkStdString.h" // For string used in api
40 
41 class VTKIOLEGACY_EXPORT vtkDataObjectWriter : public vtkWriter
42 {
43 public:
44  static vtkDataObjectWriter *New();
46  void PrintSelf(ostream& os, vtkIndent indent) override;
47 
49 
52  void SetFileName(const char *filename) {this->Writer->SetFileName(filename);};
53  char *GetFileName() {return this->Writer->GetFileName();};
54  void SetHeader(const char *header) {this->Writer->SetHeader(header);};
55  char *GetHeader() {return this->Writer->GetHeader();};
56  void SetFileType(int type) {this->Writer->SetFileType(type);};
57  int GetFileType() {return this->Writer->GetFileType();};
58  void SetFileTypeToASCII() {this->Writer->SetFileType(VTK_ASCII);};
59  void SetFileTypeToBinary() {this->Writer->SetFileType(VTK_BINARY);};
60  void SetWriteToOutputString(int b) {this->Writer->SetWriteToOutputString(b);};
61  void WriteToOutputStringOn() {this->Writer->WriteToOutputStringOn();};
62  void WriteToOutputStringOff() {this->Writer->WriteToOutputStringOff();};
63  int GetWriteToOutputString() {return this->Writer->GetWriteToOutputString();};
64  char* GetOutputString() {return this->Writer->GetOutputString();};
65  vtkStdString GetOutputStdString() {return this->Writer->GetOutputStdString();};
66  int GetOutputStringLength() {return this->Writer->GetOutputStringLength();};
67  unsigned char* GetBinaryOutputString() {return this->Writer->GetBinaryOutputString();};
68  void SetFieldDataName(const char *fieldname) {this->Writer->SetFieldDataName(fieldname);};
69  char *GetFieldDataName() {return this->Writer->GetFieldDataName();};
71 
72 protected:
74  ~vtkDataObjectWriter() override;
75 
76  void WriteData() override;
78 
80 
81 private:
83  void operator=(const vtkDataObjectWriter&) = delete;
84 };
85 
86 #endif
vtkStdString.h
vtkDataObjectWriter::SetFileName
void SetFileName(const char *filename)
Methods delegated to vtkDataWriter, see vtkDataWriter.
Definition: vtkDataObjectWriter.h:52
vtkDataObjectWriter::GetOutputString
char * GetOutputString()
Definition: vtkDataObjectWriter.h:64
vtkDataObjectWriter::SetFieldDataName
void SetFieldDataName(const char *fieldname)
Definition: vtkDataObjectWriter.h:68
vtkDataObjectWriter::WriteToOutputStringOff
void WriteToOutputStringOff()
Definition: vtkDataObjectWriter.h:62
vtkX3D::type
Definition: vtkX3D.h:516
vtkDataObjectWriter::SetFileTypeToBinary
void SetFileTypeToBinary()
Definition: vtkDataObjectWriter.h:59
vtkDataObjectWriter::SetWriteToOutputString
void SetWriteToOutputString(int b)
Definition: vtkDataObjectWriter.h:60
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:56
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:41
vtkDataObjectWriter::Writer
vtkDataWriter * Writer
Definition: vtkDataObjectWriter.h:77
vtkDataObjectWriter::GetFileName
char * GetFileName()
Definition: vtkDataObjectWriter.h:53
vtkX3D::port
Definition: vtkX3D.h:447
vtkDataObjectWriter::GetWriteToOutputString
int GetWriteToOutputString()
Definition: vtkDataObjectWriter.h:63
vtkDataObjectWriter::WriteToOutputStringOn
void WriteToOutputStringOn()
Definition: vtkDataObjectWriter.h:61
vtkWriter::WriteData
virtual void WriteData()=0
vtkDataObjectWriter::GetFileType
int GetFileType()
Definition: vtkDataObjectWriter.h:57
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkWriter
abstract class to write data to file(s)
Definition: vtkWriter.h:42
vtkDataObjectWriter::GetOutputStringLength
int GetOutputStringLength()
Definition: vtkDataObjectWriter.h:66
VTK_ASCII
#define VTK_ASCII
Definition: vtkWriter.h:39
vtkDataObjectWriter::GetOutputStdString
vtkStdString GetOutputStdString()
Definition: vtkDataObjectWriter.h:65
vtkDataObjectWriter::SetFileTypeToASCII
void SetFileTypeToASCII()
Definition: vtkDataObjectWriter.h:58
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:86
vtkX3D::info
Definition: vtkX3D.h:376
vtkAlgorithm::New
static vtkAlgorithm * New()
vtkWriter.h
vtkDataWriter.h
vtkDataObjectWriter::GetFieldDataName
char * GetFieldDataName()
Definition: vtkDataObjectWriter.h:69
vtkDataObjectWriter::GetHeader
char * GetHeader()
Definition: vtkDataObjectWriter.h:55
vtkDataObjectWriter::GetBinaryOutputString
unsigned char * GetBinaryOutputString()
Definition: vtkDataObjectWriter.h:67
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:40
VTK_BINARY
#define VTK_BINARY
Definition: vtkWriter.h:40
vtkDataObjectWriter::SetHeader
void SetHeader(const char *header)
Definition: vtkDataObjectWriter.h:54