VTK  9.2.6
vtkXMLWriter.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkXMLWriter.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=========================================================================*/
32
33#ifndef vtkXMLWriter_h
34#define vtkXMLWriter_h
35
36#include "vtkIOXMLModule.h" // For export macro
37#include "vtkXMLWriterBase.h"
38
39#include <sstream> // For ostringstream ivar
40
43
44template <class T>
46
47class vtkCellData;
48class vtkDataArray;
50class vtkDataSet;
52class vtkFieldData;
53class vtkOutputStream;
54class vtkPointData;
55class vtkPoints;
56class vtkFieldData;
58
59class vtkStdString;
60class OffsetsManager; // one per piece/per time
61class OffsetsManagerGroup; // array of OffsetsManager
62class OffsetsManagerArray; // array of OffsetsManagerGroup
63
64class VTKIOXML_EXPORT vtkXMLWriter : public vtkXMLWriterBase
65{
66public:
68 void PrintSelf(ostream& os, vtkIndent indent) override;
69
71
79 vtkDataObject* GetInput() { return this->GetInput(0); }
81
82 // See the vtkAlgorithm for a description of what these do
84 vtkInformationVector* outputVector) override;
85
87
90 vtkGetMacro(NumberOfTimeSteps, int);
91 vtkSetMacro(NumberOfTimeSteps, int);
93
95
98 void Start();
99 void Stop();
100 void WriteNextTime(double time);
102
103protected:
105 ~vtkXMLWriter() override;
106
107 virtual int RequestInformation(vtkInformation* request, vtkInformationVector** inputVector,
108 vtkInformationVector* outputVector);
109 virtual int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
110 vtkInformationVector* outputVector);
111
112 // The output stream to which the XML is written.
113 ostream* Stream;
114
115 // The stream position at which appended data starts.
117
118 // appended data offsets for field data
120
121 // We need a 32 bit signed integer type to which vtkIdType will be
122 // converted if Int32 is specified for the IdType parameter to this
123 // writer.
124#if VTK_SIZEOF_SHORT == 4
125 typedef short Int32IdType;
126#elif VTK_SIZEOF_INT == 4
127 typedef int Int32IdType;
128#elif VTK_SIZEOF_LONG == 4
129 typedef long Int32IdType;
130#else
131#error "No native data type can represent a signed 32-bit integer."
132#endif
133
134 // Buffer for vtkIdType conversion.
135 Int32IdType* Int32IdTypeBuffer;
136
137 // The byte swapping buffer.
138 unsigned char* ByteSwapBuffer;
139
140 // Compression information.
144
145 // The output stream used to write binary and appended data. May
146 // transparently encode the data.
148
149 // Allow subclasses to set the data stream.
151 vtkGetObjectMacro(DataStream, vtkOutputStream);
152
153 // Method to drive most of actual writing.
154 virtual int WriteInternal();
155
156 // Method defined by subclasses to write data. Return 1 for
157 // success, 0 for failure.
158 virtual int WriteData() { return 1; }
159
160 // Method defined by subclasses to specify the data set's type name.
161 virtual const char* GetDataSetName() = 0;
162
163 // Utility methods for subclasses.
165 virtual int StartFile();
166 virtual void WriteFileAttributes();
167 virtual int EndFile();
169 void DeleteAFile(const char* name);
170
171 virtual int WritePrimaryElement(ostream& os, vtkIndent indent);
172 virtual void WritePrimaryElementAttributes(ostream& os, vtkIndent indent);
175
176 // Write enough space to go back and write the given attribute with
177 // at most "length" characters in the value. Returns the stream
178 // position at which attribute should be later written. The default
179 // length of 20 is enough for a 64-bit integer written in decimal or
180 // a double-precision floating point value written to 13 digits of
181 // precision (the other 7 come from a minus sign, decimal place, and
182 // a big exponent like "e+300").
183 vtkTypeInt64 ReserveAttributeSpace(const char* attr, size_t length = 20);
184
185 vtkTypeInt64 GetAppendedDataOffset();
187 vtkTypeInt64 streamPos, vtkTypeInt64& lastoffset, const char* attr = nullptr);
189 vtkTypeInt64 streamPos, vtkTypeInt64 offset, const char* attr = nullptr);
190 void ForwardAppendedDataDouble(vtkTypeInt64 streamPos, double value, const char* attr);
191
192 int WriteScalarAttribute(const char* name, int data);
193 int WriteScalarAttribute(const char* name, float data);
194 int WriteScalarAttribute(const char* name, double data);
195#ifdef VTK_USE_64BIT_IDS
196 int WriteScalarAttribute(const char* name, vtkIdType data);
197#endif
198
199 int WriteVectorAttribute(const char* name, int length, int* data);
200 int WriteVectorAttribute(const char* name, int length, float* data);
201 int WriteVectorAttribute(const char* name, int length, double* data);
202#ifdef VTK_USE_64BIT_IDS
203 int WriteVectorAttribute(const char* name, int length, vtkIdType* data);
204#endif
205
206 int WriteDataModeAttribute(const char* name);
207 int WriteWordTypeAttribute(const char* name, int dataType);
208 int WriteStringAttribute(const char* name, const char* value);
209
210 // Returns true if any keys were written.
212
213 void WriteArrayHeader(vtkAbstractArray* a, vtkIndent indent, const char* alternateName,
214 int writeNumTuples, int timestep);
215 virtual void WriteArrayFooter(
216 ostream& os, vtkIndent indent, vtkAbstractArray* a, int shortFormat);
218 const char* alternateName = nullptr, int writeNumTuples = 0);
220
222 const char* alternateName = nullptr, int writeNumTuples = 0, int timestep = 0);
226 void WriteArrayAppendedData(vtkAbstractArray* a, vtkTypeInt64 pos, vtkTypeInt64& lastoffset);
227
228 // Methods for writing points, point data, and cell data.
238 void WriteCellDataAppendedData(vtkCellData* cd, int timestep, OffsetsManagerGroup* cdManager);
240 void WritePointsAppended(vtkPoints* points, vtkIndent indent, OffsetsManager* manager);
241 void WritePointsAppendedData(vtkPoints* points, int timestep, OffsetsManager* pdManager);
242 void WritePointsInline(vtkPoints* points, vtkIndent indent);
244 vtkDataArray* xc, vtkDataArray* yc, vtkDataArray* zc, vtkIndent indent);
246 vtkIndent indent, OffsetsManagerGroup* coordManager);
248 int timestep, OffsetsManagerGroup* coordManager);
251 void WritePPoints(vtkPoints* points, vtkIndent indent);
252 void WritePArray(vtkAbstractArray* a, vtkIndent indent, const char* alternateName = nullptr);
254
255 // Internal utility methods.
256 int WriteBinaryDataBlock(unsigned char* in_data, size_t numWords, int wordType);
257 void PerformByteSwap(void* data, size_t numWords, size_t wordSize);
258 int CreateCompressionHeader(size_t size);
259 int WriteCompressionBlock(unsigned char* data, size_t size);
261 size_t GetWordTypeSize(int dataType);
262 const char* GetWordTypeName(int dataType);
263 size_t GetOutputWordTypeSize(int dataType);
264
265 char** CreateStringArray(int numStrings);
266 void DestroyStringArray(int numStrings, char** strings);
267
268 // The current range over which progress is moving. This allows for
269 // incrementally fine-tuned progress updates.
270 virtual void GetProgressRange(float range[2]);
271 virtual void SetProgressRange(const float range[2], int curStep, int numSteps);
272 virtual void SetProgressRange(const float range[2], int curStep, const float* fractions);
273 virtual void SetProgressPartial(float fraction);
274 virtual void UpdateProgressDiscrete(float progress);
276
277 // This shallows copy input field data to the passed field data and
278 // then adds any additional field arrays. For example, TimeValue.
280
281 ostream* OutFile;
282 std::ostringstream* OutStringStream;
283
285 int OpenFile();
288 void CloseFile();
290
291 // The timestep currently being written
294
295 // Dummy boolean var to start/stop the continue executing:
296 // when using the Start/Stop/WriteNextTime API
297 int UserContinueExecuting; // can only be -1 = invalid, 0 = stop, 1 = start
298
299 vtkTypeInt64* NumberOfTimeValues; // one per piece / per timestep
300
301 friend class vtkXMLWriterHelper;
302
303private:
304 vtkXMLWriter(const vtkXMLWriter&) = delete;
305 void operator=(const vtkXMLWriter&) = delete;
306};
307
308#endif
Helper class due to PIMPL excess.
Abstract superclass for all arrays.
Implementation template for a array iterator.
Abstract superclass to iterate over elements in an vtkAbstractArray.
represent and manipulate cell attribute data
Definition vtkCellData.h:42
Abstract interface for data compression classes.
general representation of visualization data
represent and manipulate attribute data in a dataset
abstract class to specify dataset behavior
Definition vtkDataSet.h:63
represent and manipulate fields of data
a simple class to control print indentation
Definition vtkIndent.h:40
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Wraps a binary output stream with a VTK interface.
represent and manipulate point attribute data
represent and manipulate 3D points
Definition vtkPoints.h:40
Wrapper around std::string to keep symbols short.
void EndAppendedData()
int WriteBinaryDataInternal(vtkAbstractArray *a)
int WriteBinaryDataBlock(unsigned char *in_data, size_t numWords, int wordType)
void WriteFieldData(vtkIndent indent)
void SetInputData(vtkDataObject *)
Assign a data object as input.
virtual const char * GetDataSetName()=0
friend class vtkXMLWriterHelper
void Stop()
API to interface an outside the VTK pipeline control.
ostream * OutFile
int WriteBinaryData(vtkAbstractArray *a)
unsigned char * ByteSwapBuffer
void WritePCellData(vtkCellData *cd, vtkIndent indent)
int UserContinueExecuting
void WriteArrayAppendedData(vtkAbstractArray *a, vtkTypeInt64 pos, vtkTypeInt64 &lastoffset)
int WriteCompressionHeader()
void WriteFieldDataAppendedData(vtkFieldData *fd, int timestep, OffsetsManagerGroup *fdManager)
int WriteScalarAttribute(const char *name, int data)
void DestroyStringArray(int numStrings, char **strings)
vtkXMLDataHeader * CompressionHeader
void ForwardAppendedDataDouble(vtkTypeInt64 streamPos, double value, const char *attr)
void WritePointDataAppended(vtkPointData *pd, vtkIndent indent, OffsetsManagerGroup *pdManager)
void DeleteAFile()
void WritePPointData(vtkPointData *pd, vtkIndent indent)
vtkDataSet * GetInputAsDataSet()
void WritePPoints(vtkPoints *points, vtkIndent indent)
vtkDataObject * GetInput()
Assign a data object as input.
vtkTypeInt64 AppendedDataPosition
void WriteFieldDataAppended(vtkFieldData *fd, vtkIndent indent, OffsetsManagerGroup *fdManager)
int WriteStringAttribute(const char *name, const char *value)
bool WriteInformation(vtkInformation *info, vtkIndent indent)
~vtkXMLWriter() override
char ** CreateStringArray(int numStrings)
virtual int WriteData()
int WriteCompressionBlock(unsigned char *data, size_t size)
size_t GetOutputWordTypeSize(int dataType)
void UpdateFieldData(vtkFieldData *)
std::ostringstream * OutStringStream
int WriteVectorAttribute(const char *name, int length, int *data)
void SetInputData(int, vtkDataObject *)
Assign a data object as input.
virtual void UpdateProgressDiscrete(float progress)
virtual int EndFile()
void ForwardAppendedDataOffset(vtkTypeInt64 streamPos, vtkTypeInt64 offset, const char *attr=nullptr)
void WritePointsAppended(vtkPoints *points, vtkIndent indent, OffsetsManager *manager)
int WriteVectorAttribute(const char *name, int length, float *data)
int WriteDataModeAttribute(const char *name)
void WritePArray(vtkAbstractArray *a, vtkIndent indent, const char *alternateName=nullptr)
void Start()
API to interface an outside the VTK pipeline control.
void WritePointsAppendedData(vtkPoints *points, int timestep, OffsetsManager *pdManager)
void WriteCoordinatesAppendedData(vtkDataArray *xc, vtkDataArray *yc, vtkDataArray *zc, int timestep, OffsetsManagerGroup *coordManager)
Int32IdType * Int32IdTypeBuffer
void WriteArrayHeader(vtkAbstractArray *a, vtkIndent indent, const char *alternateName, int writeNumTuples, int timestep)
virtual void WriteArrayInline(vtkAbstractArray *a, vtkIndent indent, const char *alternateName=nullptr, int writeNumTuples=0)
void WritePointsInline(vtkPoints *points, vtkIndent indent)
virtual void SetProgressRange(const float range[2], int curStep, const float *fractions)
vtkTypeInt64 GetAppendedDataOffset()
void WriteCellDataAppendedData(vtkCellData *cd, int timestep, OffsetsManagerGroup *cdManager)
virtual void SetDataStream(vtkOutputStream *)
int WriteVectorAttribute(const char *name, int length, double *data)
vtkTypeBool ProcessRequest(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
Upstream/Downstream requests form the generalized interface through which executives invoke a algorit...
int WriteScalarAttribute(const char *name, double data)
void WriteCellDataAppended(vtkCellData *cd, vtkIndent indent, OffsetsManagerGroup *cdManager)
virtual void WriteFileAttributes()
void CloseStream()
void WritePCoordinates(vtkDataArray *xc, vtkDataArray *yc, vtkDataArray *zc, vtkIndent indent)
void WriteCoordinatesInline(vtkDataArray *xc, vtkDataArray *yc, vtkDataArray *zc, vtkIndent indent)
vtkTypeInt64 * NumberOfTimeValues
void WriteCoordinatesAppended(vtkDataArray *xc, vtkDataArray *yc, vtkDataArray *zc, vtkIndent indent, OffsetsManagerGroup *coordManager)
size_t CompressionBlockNumber
vtkOutputStream * DataStream
void WriteFieldDataInline(vtkFieldData *fd, vtkIndent indent)
void CloseFile()
void WritePointDataInline(vtkPointData *pd, vtkIndent indent)
int OpenStream()
void WriteArrayAppended(vtkAbstractArray *a, vtkIndent indent, OffsetsManager &offs, const char *alternateName=nullptr, int writeNumTuples=0, int timestep=0)
ostream * Stream
OffsetsManagerGroup * FieldDataOM
int OpenString()
virtual void GetProgressRange(float range[2])
vtkTypeInt64 ReserveAttributeSpace(const char *attr, size_t length=20)
virtual void SetProgressRange(const float range[2], int curStep, int numSteps)
virtual void WriteInlineData(vtkAbstractArray *a, vtkIndent indent)
int CreateCompressionHeader(size_t size)
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual int WritePrimaryElement(ostream &os, vtkIndent indent)
virtual void SetProgressPartial(float fraction)
virtual int StartFile()
float ProgressRange[2]
int WriteScalarAttribute(const char *name, float data)
void WriteNextTime(double time)
API to interface an outside the VTK pipeline control.
void DeleteAFile(const char *name)
const char * GetWordTypeName(int dataType)
void WritePointDataAppendedData(vtkPointData *pd, int timestep, OffsetsManagerGroup *pdManager)
void StartAppendedData()
void CloseString()
vtkTypeInt64 CompressionHeaderPosition
void WriteAppendedDataOffset(vtkTypeInt64 streamPos, vtkTypeInt64 &lastoffset, const char *attr=nullptr)
vtkDataObject * GetInput(int port)
Assign a data object as input.
void WriteAttributeIndices(vtkDataSetAttributes *dsa, char **names)
int WriteAsciiData(vtkAbstractArray *a, vtkIndent indent)
virtual void WriteArrayFooter(ostream &os, vtkIndent indent, vtkAbstractArray *a, int shortFormat)
size_t GetWordTypeSize(int dataType)
virtual int RequestInformation(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual void WritePrimaryElementAttributes(ostream &os, vtkIndent indent)
virtual int WriteInternal()
void WriteCellDataInline(vtkCellData *cd, vtkIndent indent)
int WriteWordTypeAttribute(const char *name, int dataType)
virtual int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
void PerformByteSwap(void *data, size_t numWords, size_t wordSize)
int vtkTypeBool
Definition vtkABI.h:69
#define vtkDataArray
int vtkIdType
Definition vtkType.h:332