VTK
vtkArrayDataWriter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkArrayDataWriter.h
5 
6 -------------------------------------------------------------------------
7  Copyright 2008 Sandia Corporation.
8  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9  the U.S. Government retains certain rights in this software.
10 -------------------------------------------------------------------------
11 
12  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
13  All rights reserved.
14  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
15 
16  This software is distributed WITHOUT ANY WARRANTY; without even
17  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
18  PURPOSE. See the above copyright notice for more information.
19 
20 =========================================================================*/
21 
54 #ifndef vtkArrayDataWriter_h
55 #define vtkArrayDataWriter_h
56 
57 #include "vtkIOCoreModule.h" // For export macro
58 #include "vtkWriter.h"
59 #include "vtkStdString.h" // For string API
60 
61 class vtkArrayData;
62 
63 class VTKIOCORE_EXPORT vtkArrayDataWriter :
64  public vtkWriter
65 {
66 public:
68  vtkTypeMacro(vtkArrayDataWriter, vtkWriter);
69  void PrintSelf(ostream& os, vtkIndent indent) override;
70 
72 
75  vtkSetStringMacro(FileName);
76  vtkGetStringMacro(FileName);
78 
80 
83  vtkSetMacro(Binary, vtkTypeBool);
84  vtkGetMacro(Binary, vtkTypeBool);
85  vtkBooleanMacro(Binary, vtkTypeBool);
87 
92  { return this->OutputString; }
93 
95 
98  vtkSetMacro(WriteToOutputString, bool);
99  vtkGetMacro(WriteToOutputString, bool);
100  vtkBooleanMacro(WriteToOutputString, bool);
102 
103  int Write() override; // This is necessary to get Write() wrapped for scripting languages.
104 
108  bool Write(const vtkStdString& FileName, bool WriteBinary = false);
109 
113  static bool Write(vtkArrayData* array, const vtkStdString& file_name, bool WriteBinary = false);
114 
119  bool Write(ostream& stream, bool WriteBinary = false);
120 
125  static bool Write(vtkArrayData* array, ostream& stream, bool WriteBinary = false);
126 
131  vtkStdString Write(bool WriteBinary);
132 
136  static vtkStdString Write(vtkArrayData* array, bool WriteBinary = false);
137 
138 protected:
141 
143  void WriteData() override;
144 
145  char* FileName;
149 
150 private:
151  vtkArrayDataWriter(const vtkArrayDataWriter&) = delete;
152  void operator=(const vtkArrayDataWriter&) = delete;
153 };
154 
155 #endif
vtkArrayDataWriter::Write
static vtkStdString Write(vtkArrayData *array, bool WriteBinary=false)
Write arbitrary data to a string without using the pipeline.
vtkArrayDataWriter::Write
vtkStdString Write(bool WriteBinary)
Write input port 0 data to a string.
vtkStdString.h
vtkArrayDataWriter::WriteToOutputString
bool WriteToOutputString
Definition: vtkArrayDataWriter.h:147
vtkArrayDataWriter::Binary
vtkTypeBool Binary
Definition: vtkArrayDataWriter.h:146
vtkArrayDataWriter::Write
static bool Write(vtkArrayData *array, ostream &stream, bool WriteBinary=false)
Write arbitrary data to a stream without using the pipeline.
vtkArrayDataWriter::Write
static bool Write(vtkArrayData *array, const vtkStdString &file_name, bool WriteBinary=false)
Write an arbitrary array to a file, without using the pipeline.
vtkArrayDataWriter::FillInputPortInformation
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
vtkArrayData
Pipeline data object that contains multiple vtkArray objects.
Definition: vtkArrayData.h:53
vtkArrayDataWriter::Write
bool Write(const vtkStdString &FileName, bool WriteBinary=false)
Writes input port 0 data to a file, using an arbitrary filename and binary flag.
vtkArrayDataWriter::OutputString
vtkStdString OutputString
Definition: vtkArrayDataWriter.h:148
vtkArrayDataWriter::vtkArrayDataWriter
vtkArrayDataWriter()
vtkArrayDataWriter::New
static vtkArrayDataWriter * New()
vtkX3D::port
@ port
Definition: vtkX3D.h:447
vtkArrayDataWriter::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkArrayDataWriter
Serialize vtkArrayData to a file or stream.
Definition: vtkArrayDataWriter.h:65
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkArrayDataWriter::GetOutputString
virtual vtkStdString GetOutputString()
The output string.
Definition: vtkArrayDataWriter.h:91
vtkWriter
abstract class to write data to file(s)
Definition: vtkWriter.h:43
vtkArrayDataWriter::Write
int Write() override
Write data to output.
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkX3D::info
@ info
Definition: vtkX3D.h:376
vtkWriter.h
vtkArrayDataWriter::Write
bool Write(ostream &stream, bool WriteBinary=false)
Write input port 0 data to an arbitrary stream.
vtkArrayDataWriter::~vtkArrayDataWriter
~vtkArrayDataWriter() override
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:41
vtkArrayDataWriter::WriteData
void WriteData() override
vtkArrayDataWriter::FileName
char * FileName
Definition: vtkArrayDataWriter.h:145
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69