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
55#ifndef vtkArrayWriter_h
56#define vtkArrayWriter_h
57
58#include "vtkIOCoreModule.h" // For export macro
59#include "vtkWriter.h"
60#include "vtkStdString.h" // For string API
61
62class vtkArray;
63
64class VTKIOCORE_EXPORT vtkArrayWriter :
65 public vtkWriter
66{
67public:
69 vtkTypeMacro(vtkArrayWriter, vtkWriter);
70 void PrintSelf(ostream& os, vtkIndent indent);
71
73
76 vtkSetStringMacro(FileName);
79
81
84 vtkSetMacro(Binary, int);
85 vtkGetMacro(Binary, int);
86 vtkBooleanMacro(Binary, int);
88
93 { return this->OutputString; }
94
96
99 vtkSetMacro(WriteToOutputString, bool);
100 vtkGetMacro(WriteToOutputString, bool);
101 vtkBooleanMacro(WriteToOutputString, bool);
103
104 virtual int Write(); // This is necessary to get Write() wrapped for scripting languages.
105
109 bool Write(const vtkStdString& FileName, bool WriteBinary = false);
110
114 static bool Write(vtkArray* array, const vtkStdString& file_name, bool WriteBinary = false);
115
120 bool Write(ostream& stream, bool WriteBinary = false);
121
126 static bool Write(vtkArray* array, ostream& stream, bool WriteBinary = false);
127
132 vtkStdString Write(bool WriteBinary);
133
137 static vtkStdString Write(vtkArray* array, bool WriteBinary = false);
138
139protected:
142
144 virtual void WriteData();
145
146 char* FileName;
150
151private:
152 vtkArrayWriter(const vtkArrayWriter&) VTK_DELETE_FUNCTION;
153 void operator=(const vtkArrayWriter&) VTK_DELETE_FUNCTION;
154};
155
156#endif
157
Serialize sparse and dense arrays to a file or stream.
static vtkArrayWriter * New()
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
bool Write(ostream &stream, bool WriteBinary=false)
Write input port 0 data to an arbitrary stream.
virtual int FillInputPortInformation(int port, vtkInformation *info)
Fill the input port information objects for this algorithm.
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.
virtual int Write()
Write data to output.
vtkStdString OutputString
vtkStdString Write(bool WriteBinary)
Write input port 0 data to a string.
virtual void WriteData()
static bool Write(vtkArray *array, const vtkStdString &file_name, bool WriteBinary=false)
Write an arbitrary array to a file, without using the pipeline.
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.
Abstract interface for N-dimensional arrays.
Definition: vtkArray.h:71
a simple class to control print indentation
Definition: vtkIndent.h:40
Store vtkAlgorithm input/output information.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:49
abstract class to write data to file(s)
Definition: vtkWriter.h:43
@ info
Definition: vtkX3D.h:376
@ port
Definition: vtkX3D.h:447
vtkSetMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkBooleanMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkGetStringMacro(ExtensionsString)
Returns a string listing all available extensions.