VTK  9.1.0
vtkArrayWriter.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkArrayWriter.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
71#ifndef vtkArrayWriter_h
72#define vtkArrayWriter_h
73
74#include "vtkIOCoreModule.h" // For export macro
75#include "vtkStdString.h" // For string API
76#include "vtkWriter.h"
77
78class vtkArray;
79
80class VTKIOCORE_EXPORT vtkArrayWriter : public vtkWriter
81{
82public:
84 vtkTypeMacro(vtkArrayWriter, vtkWriter);
85 void PrintSelf(ostream& os, vtkIndent indent) override;
86
88
94
96
99 vtkSetMacro(Binary, vtkTypeBool);
100 vtkGetMacro(Binary, vtkTypeBool);
101 vtkBooleanMacro(Binary, vtkTypeBool);
103
107 virtual vtkStdString GetOutputString() { return this->OutputString; }
108
110
113 vtkSetMacro(WriteToOutputString, bool);
114 vtkGetMacro(WriteToOutputString, bool);
115 vtkBooleanMacro(WriteToOutputString, bool);
117
118 int Write() override; // This is necessary to get Write() wrapped for scripting languages.
119
123 bool Write(const vtkStdString& FileName, bool WriteBinary = false);
124
128 static bool Write(vtkArray* array, const vtkStdString& file_name, bool WriteBinary = false);
129
134 bool Write(ostream& stream, bool WriteBinary = false);
135
140 static bool Write(vtkArray* array, ostream& stream, bool WriteBinary = false);
141
146 vtkStdString Write(bool WriteBinary);
147
151 static vtkStdString Write(vtkArray* array, bool WriteBinary = false);
152
153protected:
155 ~vtkArrayWriter() override;
156
157 int FillInputPortInformation(int port, vtkInformation* info) override;
158 void WriteData() override;
159
160 char* FileName;
164
165private:
166 vtkArrayWriter(const vtkArrayWriter&) = delete;
167 void operator=(const vtkArrayWriter&) = delete;
168};
169
170#endif
Serialize sparse and dense arrays to a file or stream.
static vtkArrayWriter * New()
void WriteData() override
vtkSetFilePathMacro(FileName)
Get / set the filename where data will be stored (when used as a filter).
bool Write(ostream &stream, bool WriteBinary=false)
Write input port 0 data to an arbitrary stream.
vtkTypeBool Binary
static bool Write(vtkArray *array, ostream &stream, bool WriteBinary=false)
Write arbitrary data to a stream without using the pipeline.
virtual vtkStdString GetOutputString()
The output string.
vtkStdString OutputString
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int Write() override
Write data to output.
vtkStdString Write(bool WriteBinary)
Write input port 0 data to a string.
static bool Write(vtkArray *array, const vtkStdString &file_name, bool WriteBinary=false)
Write an arbitrary array to a file, without using the pipeline.
vtkGetFilePathMacro(FileName)
Get / set the filename where data will be stored (when used as a filter).
~vtkArrayWriter() override
bool Write(const vtkStdString &FileName, bool WriteBinary=false)
Writes input port 0 data to a file, using an arbitrary filename and binary flag.
static vtkStdString Write(vtkArray *array, bool WriteBinary=false)
Write arbitrary data to a string without using the pipeline.
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
Abstract interface for N-dimensional arrays.
Definition: vtkArray.h:65
a simple class to control print indentation
Definition: vtkIndent.h:113
Store vtkAlgorithm input/output information.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:105
abstract class to write data to file(s)
Definition: vtkWriter.h:46
int vtkTypeBool
Definition: vtkABI.h:69