VTK
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 
52 #ifndef vtkArrayWriter_h
53 #define vtkArrayWriter_h
54 
55 #include "vtkIOCoreModule.h" // For export macro
56 #include "vtkWriter.h"
57 #include "vtkStdString.h" // For string API
58 
59 class vtkArray;
60 
61 class VTKIOCORE_EXPORT vtkArrayWriter :
62  public vtkWriter
63 {
64 public:
65  static vtkArrayWriter *New();
66  vtkTypeMacro(vtkArrayWriter, vtkWriter);
67  void PrintSelf(ostream& os, vtkIndent indent) override;
68 
70 
73  vtkSetStringMacro(FileName);
74  vtkGetStringMacro(FileName);
76 
78 
81  vtkSetMacro(Binary, vtkTypeBool);
82  vtkGetMacro(Binary, vtkTypeBool);
83  vtkBooleanMacro(Binary, vtkTypeBool);
85 
90  { return this->OutputString; }
91 
93 
96  vtkSetMacro(WriteToOutputString, bool);
97  vtkGetMacro(WriteToOutputString, bool);
98  vtkBooleanMacro(WriteToOutputString, bool);
100 
101  int Write() override; // This is necessary to get Write() wrapped for scripting languages.
102 
106  bool Write(const vtkStdString& FileName, bool WriteBinary = false);
107 
111  static bool Write(vtkArray* array, const vtkStdString& file_name, bool WriteBinary = false);
112 
117  bool Write(ostream& stream, bool WriteBinary = false);
118 
123  static bool Write(vtkArray* array, ostream& stream, bool WriteBinary = false);
124 
129  vtkStdString Write(bool WriteBinary);
130 
134  static vtkStdString Write(vtkArray* array, bool WriteBinary = false);
135 
136 protected:
137  vtkArrayWriter();
138  ~vtkArrayWriter() override;
139 
140  int FillInputPortInformation(int port, vtkInformation* info) override;
141  void WriteData() override;
142 
143  char* FileName;
147 
148 private:
149  vtkArrayWriter(const vtkArrayWriter&) = delete;
150  void operator=(const vtkArrayWriter&) = delete;
151 };
152 
153 #endif
154 
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:34
Serialize sparse and dense arrays to a file or stream.
Store vtkAlgorithm input/output information.
vtkTypeBool Binary
Abstract interface for N-dimensional arrays.
Definition: vtkArray.h:64
int vtkTypeBool
Definition: vtkABI.h:69
abstract class to write data to file(s)
Definition: vtkWriter.h:42
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
a simple class to control print indentation
Definition: vtkIndent.h:33
virtual int FillInputPortInformation(int port, vtkInformation *info)
Fill the input port information objects for this algorithm.
virtual int Write()
Write data to output.
vtkStdString OutputString
static vtkAlgorithm * New()
virtual void WriteData()=0
virtual vtkStdString GetOutputString()
The output string.