vtkXMLWriter Class Reference

Superclass for VTK's XML file writers. More...

#include <vtkXMLWriter.h>

Inheritance diagram for vtkXMLWriter:

Collaboration diagram for vtkXMLWriter:

List of all members.

Public Types
enum	{ Int32 = 32, Int64 = 64 }
enum	CompressorType { NONE, ZLIB }
typedef vtkAlgorithm	Superclass
enum	{ BigEndian, LittleEndian }
enum	{ Ascii, Binary, Appended }
enum	{ UInt32 = 32, UInt64 = 64 }
Public Member Functions
virtual int	IsA (const char *type)
vtkXMLWriter *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual const char *	GetDefaultFileExtension ()=0
int	Write ()
virtual int	ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual void	SetByteOrder (int)
virtual int	GetByteOrder ()
void	SetByteOrderToBigEndian ()
void	SetByteOrderToLittleEndian ()
virtual void	SetHeaderType (int)
virtual int	GetHeaderType ()
void	SetHeaderTypeToUInt32 ()
void	SetHeaderTypeToUInt64 ()
virtual void	SetIdType (int)
virtual int	GetIdType ()
void	SetIdTypeToInt32 ()
void	SetIdTypeToInt64 ()
virtual void	SetFileName (const char *)
virtual char *	GetFileName ()
virtual void	SetCompressor (vtkDataCompressor *)
virtual vtkDataCompressor *	GetCompressor ()
void	SetCompressorType (int compressorType)
void	SetCompressorTypeToNone ()
void	SetCompressorTypeToZLib ()
virtual void	SetBlockSize (size_t blockSize)
virtual size_t	GetBlockSize ()
virtual void	SetDataMode (int)
virtual int	GetDataMode ()
void	SetDataModeToAscii ()
void	SetDataModeToBinary ()
void	SetDataModeToAppended ()
virtual void	SetEncodeAppendedData (int)
virtual int	GetEncodeAppendedData ()
virtual void	EncodeAppendedDataOn ()
virtual void	EncodeAppendedDataOff ()
void	SetInputData (vtkDataObject *)
void	SetInputData (int, vtkDataObject *)
vtkDataObject *	GetInput (int port)
vtkDataObject *	GetInput ()
virtual void	SetTimeStep (int)
virtual int	GetTimeStep ()
virtual int *	GetTimeStepRange ()
virtual void	GetTimeStepRange (int &, int &)
virtual void	GetTimeStepRange (int[2])
virtual void	SetTimeStepRange (int, int)
void	SetTimeStepRange (int[2])
virtual int	GetNumberOfTimeSteps ()
virtual void	SetNumberOfTimeSteps (int)
void	Start ()
void	Stop ()
void	WriteNextTime (double time)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkXMLWriter *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkXMLWriter ()
	~vtkXMLWriter ()
virtual int	RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual void	SetDataStream (vtkOutputStream *)
virtual vtkOutputStream *	GetDataStream ()
virtual int	WriteInternal ()
virtual int	WriteData ()
virtual const char *	GetDataSetName ()=0
virtual int	GetDataSetMajorVersion ()
virtual int	GetDataSetMinorVersion ()
vtkDataSet *	GetInputAsDataSet ()
int	StartFile ()
virtual void	WriteFileAttributes ()
int	EndFile ()
void	DeleteAFile ()
void	DeleteAFile (const char *name)
virtual int	WritePrimaryElement (ostream &os, vtkIndent indent)
virtual void	WritePrimaryElementAttributes (ostream &os, vtkIndent indent)
void	StartAppendedData ()
void	EndAppendedData ()
vtkTypeInt64	ReserveAttributeSpace (const char *attr, size_t length=20)
vtkTypeInt64	GetAppendedDataOffset ()
void	WriteAppendedDataOffset (vtkTypeInt64 streamPos, vtkTypeInt64 &lastoffset, const char *attr=0)
void	ForwardAppendedDataOffset (vtkTypeInt64 streamPos, vtkTypeInt64 offset, const char *attr=0)
void	ForwardAppendedDataDouble (vtkTypeInt64 streamPos, double value, const char *attr)
int	WriteScalarAttribute (const char *name, int data)
int	WriteScalarAttribute (const char *name, float data)
int	WriteScalarAttribute (const char *name, double data)
int	WriteVectorAttribute (const char *name, int length, int *data)
int	WriteVectorAttribute (const char *name, int length, float *data)
int	WriteVectorAttribute (const char *name, int length, double *data)
int	WriteDataModeAttribute (const char *name)
int	WriteWordTypeAttribute (const char *name, int dataType)
int	WriteStringAttribute (const char *name, const char *value)
void	WriteArrayHeader (vtkAbstractArray *a, vtkIndent indent, const char *alternateName, int writeNumTuples, int timestep)
void	WriteArrayFooter (ostream &os, vtkIndent indent, vtkAbstractArray *a, int shortFormat)
void	WriteArrayInline (vtkAbstractArray *a, vtkIndent indent, const char *alternateName=0, int writeNumTuples=0)
void	WriteInlineData (vtkAbstractArray *a, vtkIndent indent)
void	WriteArrayAppended (vtkAbstractArray *a, vtkIndent indent, OffsetsManager &offs, const char *alternateName=0, int writeNumTuples=0, int timestep=0)
int	WriteAsciiData (vtkAbstractArray *a, vtkIndent indent)
int	WriteBinaryData (vtkAbstractArray *a)
int	WriteBinaryDataInternal (vtkAbstractArray *a)
void	WriteArrayAppendedData (vtkAbstractArray *a, vtkTypeInt64 pos, vtkTypeInt64 &lastoffset)
void	WriteFieldData (vtkIndent indent)
void	WriteFieldDataInline (vtkFieldData *fd, vtkIndent indent)
void	WritePointDataInline (vtkPointData *pd, vtkIndent indent)
void	WriteCellDataInline (vtkCellData *cd, vtkIndent indent)
void	WriteFieldDataAppended (vtkFieldData *fd, vtkIndent indent, OffsetsManagerGroup *fdManager)
void	WriteFieldDataAppendedData (vtkFieldData *fd, int timestep, OffsetsManagerGroup *fdManager)
void	WritePointDataAppended (vtkPointData *pd, vtkIndent indent, OffsetsManagerGroup *pdManager)
void	WritePointDataAppendedData (vtkPointData *pd, int timestep, OffsetsManagerGroup *pdManager)
void	WriteCellDataAppended (vtkCellData *cd, vtkIndent indent, OffsetsManagerGroup *cdManager)
void	WriteCellDataAppendedData (vtkCellData *cd, int timestep, OffsetsManagerGroup *cdManager)
void	WriteAttributeIndices (vtkDataSetAttributes *dsa, char **names)
void	WritePointsAppended (vtkPoints *points, vtkIndent indent, OffsetsManager *manager)
void	WritePointsAppendedData (vtkPoints *points, int timestep, OffsetsManager *pdManager)
void	WritePointsInline (vtkPoints *points, vtkIndent indent)
void	WriteCoordinatesInline (vtkDataArray *xc, vtkDataArray *yc, vtkDataArray *zc, vtkIndent indent)
void	WriteCoordinatesAppended (vtkDataArray *xc, vtkDataArray *yc, vtkDataArray *zc, vtkIndent indent, OffsetsManagerGroup *coordManager)
void	WriteCoordinatesAppendedData (vtkDataArray *xc, vtkDataArray *yc, vtkDataArray *zc, int timestep, OffsetsManagerGroup *coordManager)
virtual vtkAbstractArray *	CreateArrayForPoints (vtkAbstractArray *inArray)
virtual vtkAbstractArray *	CreateArrayForCells (vtkAbstractArray *inArray)
virtual vtkDataArray *	CreateExactCoordinates (vtkDataArray *inArray, int xyz)
void	WritePPointData (vtkPointData *pd, vtkIndent indent)
void	WritePCellData (vtkCellData *cd, vtkIndent indent)
void	WritePPoints (vtkPoints *points, vtkIndent indent)
void	WritePArray (vtkAbstractArray *a, vtkIndent indent, const char *alternateName=0)
void	WritePCoordinates (vtkDataArray *xc, vtkDataArray *yc, vtkDataArray *zc, vtkIndent indent)
int	WriteBinaryDataBlock (unsigned char *in_data, size_t numWords, int wordType)
void	PerformByteSwap (void *data, size_t numWords, size_t wordSize)
int	CreateCompressionHeader (size_t size)
int	WriteCompressionBlock (unsigned char *data, size_t size)
int	WriteCompressionHeader ()
size_t	GetWordTypeSize (int dataType)
const char *	GetWordTypeName (int dataType)
size_t	GetOutputWordTypeSize (int dataType)
char **	CreateStringArray (int numStrings)
void	DestroyStringArray (int numStrings, char **strings)
virtual void	GetProgressRange (float *range)
virtual void	SetProgressRange (float *range, int curStep, int numSteps)
virtual void	SetProgressRange (float *range, int curStep, float *fractions)
virtual void	SetProgressPartial (float fraction)
virtual void	UpdateProgressDiscrete (float progress)
int	OpenFile ()
void	CloseFile ()
Protected Attributes
char *	FileName
ostream *	Stream
int	ByteOrder
int	HeaderType
int	IdType
int	DataMode
int	EncodeAppendedData
vtkTypeInt64	AppendedDataPosition
OffsetsManagerGroup *	FieldDataOM
Int32IdType *	Int32IdTypeBuffer
unsigned char *	ByteSwapBuffer
vtkDataCompressor *	Compressor
size_t	BlockSize
size_t	CompressionBlockNumber
vtkXMLDataHeader *	CompressionHeader
vtkTypeInt64	CompressionHeaderPosition
vtkOutputStream *	DataStream
float	ProgressRange [2]
ofstream *	OutFile
int	TimeStep
int	CurrentTimeIndex
int	NumberOfTimeSteps
int	TimeStepRange [2]
int	UserContinueExecuting
vtkTypeInt64 *	NumberOfTimeValues
Friends
class	vtkXMLWriterHelper

---

Detailed Description

Superclass for VTK's XML file writers.

vtkXMLWriter provides methods implementing most of the functionality needed to write VTK XML file formats. Concrete subclasses provide actual writer implementations calling upon this functionality.

Definition at line 52 of file vtkXMLWriter.h.

---

Member Typedef Documentation

typedef vtkAlgorithm vtkXMLWriter::Superclass

Reimplemented from vtkAlgorithm.

Reimplemented in vtkXMLPolyDataWriter, vtkXMLDataSetWriter, vtkXMLHyperOctreeWriter, vtkXMLUnstructuredGridWriter, vtkXMLImageDataWriter, vtkXMLRectilinearGridWriter, vtkXMLStructuredGridWriter, vtkXMLPMultiBlockDataWriter, vtkXMLPRectilinearGridWriter, vtkXMLPStructuredGridWriter, vtkXMLPUnstructuredGridWriter, vtkXMLPUniformGridAMRWriter, vtkXMLCompositeDataWriter, vtkXMLPDataSetWriter, vtkXMLPImageDataWriter, vtkXMLPPolyDataWriter, vtkXMLUnstructuredDataWriter, vtkXMLStructuredDataWriter, vtkXMLUniformGridAMRWriter, vtkXMLMultiBlockDataWriter, vtkXMLPDataWriter, vtkXMLPUnstructuredDataWriter, vtkXMLPHierarchicalBoxDataWriter, vtkXMLHierarchicalBoxDataWriter, and vtkXMLPStructuredDataWriter.

Definition at line 55 of file vtkXMLWriter.h.

---

Member Enumeration Documentation

anonymous enum

Enumerate big and little endian byte order settings.

Enumerator:

BigEndian
LittleEndian

Definition at line 61 of file vtkXMLWriter.h.

anonymous enum

Enumerate the supported data modes. Ascii = Inline ascii data. Binary = Inline binary data (base64 encoded, possibly compressed). Appended = Appended binary data (possibly compressed and/or base64).

Enumerator:

Ascii
Binary
Appended

Definition at line 70 of file vtkXMLWriter.h.

anonymous enum

Enumerate the supported vtkIdType bit lengths. Int32 = File stores 32-bit values for vtkIdType. Int64 = File stores 64-bit values for vtkIdType.

Enumerator:

Int32
Int64

Definition at line 78 of file vtkXMLWriter.h.

anonymous enum

Enumerate the supported binary data header bit lengths. UInt32 = File stores 32-bit binary data header elements. UInt64 = File stores 64-bit binary data header elements.

Enumerator:

UInt32
UInt64

Definition at line 84 of file vtkXMLWriter.h.

enum vtkXMLWriter::CompressorType

Enumerator:

NONE
ZLIB

Definition at line 129 of file vtkXMLWriter.h.

---

Constructor & Destructor Documentation

vtkXMLWriter::vtkXMLWriter

(

)

[protected]

vtkXMLWriter::~vtkXMLWriter

(

)

[protected]

---

Member Function Documentation

static int vtkXMLWriter::IsTypeOf

(

const char *

name

)

[static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkXMLPolyDataWriter, vtkXMLDataSetWriter, vtkXMLHyperOctreeWriter, vtkXMLUnstructuredGridWriter, vtkXMLImageDataWriter, vtkXMLRectilinearGridWriter, vtkXMLStructuredGridWriter, vtkXMLPMultiBlockDataWriter, vtkXMLPRectilinearGridWriter, vtkXMLPStructuredGridWriter, vtkXMLPUnstructuredGridWriter, vtkXMLPUniformGridAMRWriter, vtkXMLCompositeDataWriter, vtkXMLPDataSetWriter, vtkXMLPImageDataWriter, vtkXMLPPolyDataWriter, vtkXMLUnstructuredDataWriter, vtkXMLStructuredDataWriter, vtkXMLUniformGridAMRWriter, vtkXMLMultiBlockDataWriter, vtkXMLPDataWriter, vtkXMLPUnstructuredDataWriter, vtkXMLPHierarchicalBoxDataWriter, vtkXMLHierarchicalBoxDataWriter, and vtkXMLPStructuredDataWriter.

virtual int vtkXMLWriter::IsA

(

const char *

name

)

[virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkXMLPolyDataWriter, vtkXMLDataSetWriter, vtkXMLHyperOctreeWriter, vtkXMLUnstructuredGridWriter, vtkXMLImageDataWriter, vtkXMLRectilinearGridWriter, vtkXMLStructuredGridWriter, vtkXMLPMultiBlockDataWriter, vtkXMLPRectilinearGridWriter, vtkXMLPStructuredGridWriter, vtkXMLPUnstructuredGridWriter, vtkXMLPUniformGridAMRWriter, vtkXMLCompositeDataWriter, vtkXMLPDataSetWriter, vtkXMLPImageDataWriter, vtkXMLPPolyDataWriter, vtkXMLUnstructuredDataWriter, vtkXMLStructuredDataWriter, vtkXMLUniformGridAMRWriter, vtkXMLMultiBlockDataWriter, vtkXMLPDataWriter, vtkXMLPUnstructuredDataWriter, vtkXMLPHierarchicalBoxDataWriter, vtkXMLHierarchicalBoxDataWriter, and vtkXMLPStructuredDataWriter.

static vtkXMLWriter* vtkXMLWriter::SafeDownCast

(

vtkObjectBase *

o

)

[static]

Reimplemented from vtkAlgorithm.

Reimplemented in vtkXMLPolyDataWriter, vtkXMLDataSetWriter, vtkXMLHyperOctreeWriter, vtkXMLUnstructuredGridWriter, vtkXMLImageDataWriter, vtkXMLRectilinearGridWriter, vtkXMLStructuredGridWriter, vtkXMLPMultiBlockDataWriter, vtkXMLPRectilinearGridWriter, vtkXMLPStructuredGridWriter, vtkXMLPUnstructuredGridWriter, vtkXMLPUniformGridAMRWriter, vtkXMLCompositeDataWriter, vtkXMLPDataSetWriter, vtkXMLPImageDataWriter, vtkXMLPPolyDataWriter, vtkXMLUnstructuredDataWriter, vtkXMLStructuredDataWriter, vtkXMLUniformGridAMRWriter, vtkXMLMultiBlockDataWriter, vtkXMLPDataWriter, vtkXMLPUnstructuredDataWriter, vtkXMLPHierarchicalBoxDataWriter, vtkXMLHierarchicalBoxDataWriter, and vtkXMLPStructuredDataWriter.

virtual vtkObjectBase* vtkXMLWriter::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkAlgorithm.

Reimplemented in vtkXMLPolyDataWriter, vtkXMLDataSetWriter, vtkXMLHyperOctreeWriter, vtkXMLUnstructuredGridWriter, vtkXMLImageDataWriter, vtkXMLRectilinearGridWriter, vtkXMLStructuredGridWriter, vtkXMLPMultiBlockDataWriter, vtkXMLPRectilinearGridWriter, vtkXMLPStructuredGridWriter, vtkXMLPUnstructuredGridWriter, vtkXMLPUniformGridAMRWriter, vtkXMLCompositeDataWriter, vtkXMLPDataSetWriter, vtkXMLPImageDataWriter, vtkXMLPPolyDataWriter, vtkXMLUnstructuredDataWriter, vtkXMLStructuredDataWriter, vtkXMLUniformGridAMRWriter, vtkXMLMultiBlockDataWriter, vtkXMLPDataWriter, vtkXMLPUnstructuredDataWriter, vtkXMLPHierarchicalBoxDataWriter, vtkXMLHierarchicalBoxDataWriter, and vtkXMLPStructuredDataWriter.

vtkXMLWriter* vtkXMLWriter::NewInstance

(

)

const

Reimplemented from vtkAlgorithm.

Reimplemented in vtkXMLPolyDataWriter, vtkXMLDataSetWriter, vtkXMLHyperOctreeWriter, vtkXMLUnstructuredGridWriter, vtkXMLImageDataWriter, vtkXMLRectilinearGridWriter, vtkXMLStructuredGridWriter, vtkXMLPMultiBlockDataWriter, vtkXMLPRectilinearGridWriter, vtkXMLPStructuredGridWriter, vtkXMLPUnstructuredGridWriter, vtkXMLPUniformGridAMRWriter, vtkXMLCompositeDataWriter, vtkXMLPDataSetWriter, vtkXMLPImageDataWriter, vtkXMLPPolyDataWriter, vtkXMLUnstructuredDataWriter, vtkXMLStructuredDataWriter, vtkXMLUniformGridAMRWriter, vtkXMLMultiBlockDataWriter, vtkXMLPDataWriter, vtkXMLPUnstructuredDataWriter, vtkXMLPHierarchicalBoxDataWriter, vtkXMLHierarchicalBoxDataWriter, and vtkXMLPStructuredDataWriter.

void vtkXMLWriter::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		[virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkXMLPolyDataWriter, vtkXMLDataSetWriter, vtkXMLHyperOctreeWriter, vtkXMLUnstructuredGridWriter, vtkXMLImageDataWriter, vtkXMLRectilinearGridWriter, vtkXMLStructuredGridWriter, vtkXMLPMultiBlockDataWriter, vtkXMLPRectilinearGridWriter, vtkXMLPStructuredGridWriter, vtkXMLPUnstructuredGridWriter, vtkXMLPUniformGridAMRWriter, vtkXMLCompositeDataWriter, vtkXMLPDataSetWriter, vtkXMLPImageDataWriter, vtkXMLPPolyDataWriter, vtkXMLUnstructuredDataWriter, vtkXMLStructuredDataWriter, vtkXMLUniformGridAMRWriter, vtkXMLMultiBlockDataWriter, vtkXMLPDataWriter, vtkXMLPUnstructuredDataWriter, vtkXMLPHierarchicalBoxDataWriter, vtkXMLHierarchicalBoxDataWriter, and vtkXMLPStructuredDataWriter.

virtual void vtkXMLWriter::SetByteOrder

(

int

)

[virtual]

Get/Set the byte order of data written to the file. The default is the machine's hardware byte order.

virtual int vtkXMLWriter::GetByteOrder

(

)

[virtual]

Get/Set the byte order of data written to the file. The default is the machine's hardware byte order.

void vtkXMLWriter::SetByteOrderToBigEndian

(

)

Get/Set the byte order of data written to the file. The default is the machine's hardware byte order.

void vtkXMLWriter::SetByteOrderToLittleEndian

(

)

Get/Set the byte order of data written to the file. The default is the machine's hardware byte order.

virtual void vtkXMLWriter::SetHeaderType

(

int

)

[virtual]

Get/Set the binary data header word type. The default is UInt32. Set to UInt64 when storing arrays requiring 64-bit indexing.

virtual int vtkXMLWriter::GetHeaderType

(

)

[virtual]

Get/Set the binary data header word type. The default is UInt32. Set to UInt64 when storing arrays requiring 64-bit indexing.

void vtkXMLWriter::SetHeaderTypeToUInt32

(

)

Get/Set the binary data header word type. The default is UInt32. Set to UInt64 when storing arrays requiring 64-bit indexing.

void vtkXMLWriter::SetHeaderTypeToUInt64

(

)

Get/Set the binary data header word type. The default is UInt32. Set to UInt64 when storing arrays requiring 64-bit indexing.

virtual void vtkXMLWriter::SetIdType

(

int

)

[virtual]

Get/Set the size of the vtkIdType values stored in the file. The default is the real size of vtkIdType.

virtual int vtkXMLWriter::GetIdType

(

)

[virtual]

Get/Set the size of the vtkIdType values stored in the file. The default is the real size of vtkIdType.

void vtkXMLWriter::SetIdTypeToInt32

(

)

Get/Set the size of the vtkIdType values stored in the file. The default is the real size of vtkIdType.

void vtkXMLWriter::SetIdTypeToInt64

(

)

Get/Set the size of the vtkIdType values stored in the file. The default is the real size of vtkIdType.

virtual void vtkXMLWriter::SetFileName

(

const char *

)

[virtual]

Get/Set the name of the output file.

virtual char* vtkXMLWriter::GetFileName

(

)

[virtual]

Get/Set the name of the output file.

virtual void vtkXMLWriter::SetCompressor

(

vtkDataCompressor *

)

[virtual]

Get/Set the compressor used to compress binary and appended data before writing to the file. Default is a vtkZLibDataCompressor.

virtual vtkDataCompressor* vtkXMLWriter::GetCompressor

(

)

[virtual]

Get/Set the compressor used to compress binary and appended data before writing to the file. Default is a vtkZLibDataCompressor.

void vtkXMLWriter::SetCompressorType

(

int

compressorType

)

Convenience functions to set the compressor to certain known types.

void vtkXMLWriter::SetCompressorTypeToNone

(

)

[inline]

Convenience functions to set the compressor to certain known types.

Definition at line 139 of file vtkXMLWriter.h.

void vtkXMLWriter::SetCompressorTypeToZLib

(

)

[inline]

Convenience functions to set the compressor to certain known types.

Definition at line 143 of file vtkXMLWriter.h.

virtual void vtkXMLWriter::SetBlockSize

(

size_t

blockSize

)

[virtual]

Get/Set the block size used in compression. When reading, this controls the granularity of how much extra information must be read when only part of the data are requested. The value should be a multiple of the largest scalar data type.

virtual size_t vtkXMLWriter::GetBlockSize

(

)

[virtual]

Get/Set the block size used in compression. When reading, this controls the granularity of how much extra information must be read when only part of the data are requested. The value should be a multiple of the largest scalar data type.

virtual void vtkXMLWriter::SetDataMode

(

int

)

[virtual]

Get/Set the data mode used for the file's data. The options are vtkXMLWriter::Ascii, vtkXMLWriter::Binary, and vtkXMLWriter::Appended.

virtual int vtkXMLWriter::GetDataMode

(

)

[virtual]

Get/Set the data mode used for the file's data. The options are vtkXMLWriter::Ascii, vtkXMLWriter::Binary, and vtkXMLWriter::Appended.

void vtkXMLWriter::SetDataModeToAscii

(

)

Get/Set the data mode used for the file's data. The options are vtkXMLWriter::Ascii, vtkXMLWriter::Binary, and vtkXMLWriter::Appended.

void vtkXMLWriter::SetDataModeToBinary

(

)

Get/Set the data mode used for the file's data. The options are vtkXMLWriter::Ascii, vtkXMLWriter::Binary, and vtkXMLWriter::Appended.

void vtkXMLWriter::SetDataModeToAppended

(

)

Get/Set the data mode used for the file's data. The options are vtkXMLWriter::Ascii, vtkXMLWriter::Binary, and vtkXMLWriter::Appended.

virtual void vtkXMLWriter::SetEncodeAppendedData

(

int

)

[virtual]

Get/Set whether the appended data section is base64 encoded. If encoded, reading and writing will be slower, but the file will be fully valid XML and text-only. If not encoded, the XML specification will be violated, but reading and writing will be fast. The default is to do the encoding.

virtual int vtkXMLWriter::GetEncodeAppendedData

(

)

[virtual]

Get/Set whether the appended data section is base64 encoded. If encoded, reading and writing will be slower, but the file will be fully valid XML and text-only. If not encoded, the XML specification will be violated, but reading and writing will be fast. The default is to do the encoding.

virtual void vtkXMLWriter::EncodeAppendedDataOn

(

)

[virtual]

Get/Set whether the appended data section is base64 encoded. If encoded, reading and writing will be slower, but the file will be fully valid XML and text-only. If not encoded, the XML specification will be violated, but reading and writing will be fast. The default is to do the encoding.

virtual void vtkXMLWriter::EncodeAppendedDataOff

(

)

[virtual]

Get/Set whether the appended data section is base64 encoded. If encoded, reading and writing will be slower, but the file will be fully valid XML and text-only. If not encoded, the XML specification will be violated, but reading and writing will be fast. The default is to do the encoding.

void vtkXMLWriter::SetInputData

(

vtkDataObject *

)

Assign a data object as input. Note that this method does not establish a pipeline connection. Use SetInputConnection() to setup a pipeline connection.

void vtkXMLWriter::SetInputData	(	int	,
		vtkDataObject *
	)

Assign a data object as input. Note that this method does not establish a pipeline connection. Use SetInputConnection() to setup a pipeline connection.

vtkDataObject* vtkXMLWriter::GetInput

(

int

port

)

Assign a data object as input. Note that this method does not establish a pipeline connection. Use SetInputConnection() to setup a pipeline connection.

vtkDataObject* vtkXMLWriter::GetInput

(

)

[inline]

Assign a data object as input. Note that this method does not establish a pipeline connection. Use SetInputConnection() to setup a pipeline connection.

Reimplemented in vtkXMLPolyDataWriter, vtkXMLDataSetWriter, vtkXMLHyperOctreeWriter, vtkXMLUnstructuredGridWriter, vtkXMLImageDataWriter, vtkXMLRectilinearGridWriter, vtkXMLStructuredGridWriter, vtkXMLPDataSetWriter, vtkXMLPRectilinearGridWriter, vtkXMLPStructuredGridWriter, vtkXMLPUnstructuredGridWriter, vtkXMLPImageDataWriter, and vtkXMLPPolyDataWriter.

Definition at line 187 of file vtkXMLWriter.h.

virtual const char* vtkXMLWriter::GetDefaultFileExtension

(

)

[pure virtual]

Get the default file extension for files written by this writer.

Implemented in vtkXMLDataSetWriter, vtkXMLPDataSetWriter, vtkXMLPStructuredGridWriter, vtkXMLPolyDataWriter, vtkXMLHyperOctreeWriter, vtkXMLUnstructuredGridWriter, vtkXMLImageDataWriter, vtkXMLRectilinearGridWriter, vtkXMLStructuredGridWriter, vtkXMLPRectilinearGridWriter, vtkXMLPUnstructuredGridWriter, vtkXMLPImageDataWriter, vtkXMLPPolyDataWriter, vtkXMLCompositeDataWriter, vtkXMLUniformGridAMRWriter, vtkXMLMultiBlockDataWriter, and vtkXMLHierarchicalBoxDataWriter.

int vtkXMLWriter::Write

(

)

Invoke the writer. Returns 1 for success, 0 for failure.

virtual int vtkXMLWriter::ProcessRequest	(	vtkInformation *	request,
		vtkInformationVector **	inInfo,
		vtkInformationVector *	outInfo
	)		[virtual]

Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. Upstream requests correspond to information flow from the algorithm's outputs to its inputs. Downstream requests correspond to information flow from the algorithm's inputs to its outputs. A downstream request is defined by the contents of the request information object. The input to the request is stored in the input information vector passed to ProcessRequest. The results of an downstream request are stored in the output information vector passed to ProcessRequest. An upstream request is defined by the contents of the request information object. The input to the request is stored in the output information vector passed to ProcessRequest. The results of an upstream request are stored in the input information vector passed to ProcessRequest. It returns the boolean status of the pipeline (false means failure).

Reimplemented from vtkAlgorithm.

Reimplemented in vtkXMLStructuredDataWriter, vtkXMLCompositeDataWriter, vtkXMLUnstructuredDataWriter, vtkXMLPUnstructuredDataWriter, and vtkXMLPStructuredDataWriter.

virtual void vtkXMLWriter::SetTimeStep

(

int

)

[virtual]

Which TimeStep to write.

virtual int vtkXMLWriter::GetTimeStep

(

)

[virtual]

Which TimeStep to write.

virtual int* vtkXMLWriter::GetTimeStepRange

(

)

[virtual]

Which TimeStepRange to write.

virtual void vtkXMLWriter::GetTimeStepRange	(	int &	,
		int &
	)		[virtual]

Which TimeStepRange to write.

virtual void vtkXMLWriter::GetTimeStepRange

(

int

[2]

)

[virtual]

Which TimeStepRange to write.

virtual void vtkXMLWriter::SetTimeStepRange	(	int	,
		int
	)		[virtual]

Which TimeStepRange to write.

void vtkXMLWriter::SetTimeStepRange

(

int

[2]

)

Which TimeStepRange to write.

virtual int vtkXMLWriter::GetNumberOfTimeSteps

(

)

[virtual]

Set the number of time steps

virtual void vtkXMLWriter::SetNumberOfTimeSteps

(

int

)

[virtual]

Set the number of time steps

void vtkXMLWriter::Start

(

)

API to interface an outside the VTK pipeline control

void vtkXMLWriter::Stop

(

)

API to interface an outside the VTK pipeline control

void vtkXMLWriter::WriteNextTime

(

double

time

)

API to interface an outside the VTK pipeline control

virtual int vtkXMLWriter::RequestInformation	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)		[protected, virtual]

virtual int vtkXMLWriter::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)		[protected, virtual]

Reimplemented in vtkXMLCompositeDataWriter.

virtual void vtkXMLWriter::SetDataStream

(

vtkOutputStream *

)

[protected, virtual]

virtual vtkOutputStream* vtkXMLWriter::GetDataStream

(

)

[protected, virtual]

virtual int vtkXMLWriter::WriteInternal

(

)

[protected, virtual]

Reimplemented in vtkXMLPDataWriter, vtkXMLDataSetWriter, and vtkXMLPDataSetWriter.

virtual int vtkXMLWriter::WriteData

(

)

[inline, protected, virtual]

Reimplemented in vtkXMLCompositeDataWriter, vtkXMLPDataWriter, and vtkXMLHyperOctreeWriter.

Definition at line 307 of file vtkXMLWriter.h.

virtual const char* vtkXMLWriter::GetDataSetName

(

)

[protected, pure virtual]

Implemented in vtkXMLCompositeDataWriter, vtkXMLUnstructuredDataWriter, vtkXMLRectilinearGridWriter, vtkXMLUnstructuredGridWriter, vtkXMLDataSetWriter, vtkXMLPolyDataWriter, vtkXMLStructuredGridWriter, vtkXMLImageDataWriter, vtkXMLHyperOctreeWriter, vtkXMLPDataSetWriter, vtkXMLPRectilinearGridWriter, vtkXMLPUnstructuredGridWriter, vtkXMLPPolyDataWriter, vtkXMLPStructuredGridWriter, and vtkXMLPImageDataWriter.

virtual int vtkXMLWriter::GetDataSetMajorVersion

(

)

[protected, virtual]

Reimplemented in vtkXMLCompositeDataWriter, and vtkXMLUniformGridAMRWriter.

virtual int vtkXMLWriter::GetDataSetMinorVersion

(

)

[protected, virtual]

Reimplemented in vtkXMLCompositeDataWriter, and vtkXMLUniformGridAMRWriter.

vtkDataSet* vtkXMLWriter::GetInputAsDataSet

(

)

[protected]

int vtkXMLWriter::StartFile

(

)

[protected]

virtual void vtkXMLWriter::WriteFileAttributes

(

)

[protected, virtual]

int vtkXMLWriter::EndFile

(

)

[protected]

void vtkXMLWriter::DeleteAFile

(

)

[protected]

void vtkXMLWriter::DeleteAFile

(

const char *

name

)

[protected]

virtual int vtkXMLWriter::WritePrimaryElement	(	ostream &	os,
		vtkIndent	indent
	)		[protected, virtual]

virtual void vtkXMLWriter::WritePrimaryElementAttributes	(	ostream &	os,
		vtkIndent	indent
	)		[protected, virtual]

Reimplemented in vtkXMLPDataWriter, vtkXMLHyperOctreeWriter, vtkXMLStructuredDataWriter, vtkXMLImageDataWriter, vtkXMLPImageDataWriter, and vtkXMLPStructuredDataWriter.

void vtkXMLWriter::StartAppendedData

(

)

[protected]

void vtkXMLWriter::EndAppendedData

(

)

[protected]

vtkTypeInt64 vtkXMLWriter::ReserveAttributeSpace	(	const char *	attr,
		size_t	length = 20
	)		[protected]

vtkTypeInt64 vtkXMLWriter::GetAppendedDataOffset

(

)

[protected]

void vtkXMLWriter::WriteAppendedDataOffset	(	vtkTypeInt64	streamPos,
		vtkTypeInt64 &	lastoffset,
		const char *	attr = 0
	)		[protected]

void vtkXMLWriter::ForwardAppendedDataOffset	(	vtkTypeInt64	streamPos,
		vtkTypeInt64	offset,
		const char *	attr = 0
	)		[protected]

void vtkXMLWriter::ForwardAppendedDataDouble	(	vtkTypeInt64	streamPos,
		double	value,
		const char *	attr
	)		[protected]

int vtkXMLWriter::WriteScalarAttribute	(	const char *	name,
		int	data
	)		[protected]

int vtkXMLWriter::WriteScalarAttribute	(	const char *	name,
		float	data
	)		[protected]

int vtkXMLWriter::WriteScalarAttribute	(	const char *	name,
		double	data
	)		[protected]

int vtkXMLWriter::WriteVectorAttribute	(	const char *	name,
		int	length,
		int *	data
	)		[protected]

int vtkXMLWriter::WriteVectorAttribute	(	const char *	name,
		int	length,
		float *	data
	)		[protected]

int vtkXMLWriter::WriteVectorAttribute	(	const char *	name,
		int	length,
		double *	data
	)		[protected]

int vtkXMLWriter::WriteDataModeAttribute

(

const char *

name

)

[protected]

int vtkXMLWriter::WriteWordTypeAttribute	(	const char *	name,
		int	dataType
	)		[protected]

int vtkXMLWriter::WriteStringAttribute	(	const char *	name,
		const char *	value
	)		[protected]

void vtkXMLWriter::WriteArrayHeader	(	vtkAbstractArray *	a,
		vtkIndent	indent,
		const char *	alternateName,
		int	writeNumTuples,
		int	timestep
	)		[protected]

void vtkXMLWriter::WriteArrayFooter	(	ostream &	os,
		vtkIndent	indent,
		vtkAbstractArray *	a,
		int	shortFormat
	)		[protected]

void vtkXMLWriter::WriteArrayInline	(	vtkAbstractArray *	a,
		vtkIndent	indent,
		const char *	alternateName = 0,
		int	writeNumTuples = 0
	)		[protected]

void vtkXMLWriter::WriteInlineData	(	vtkAbstractArray *	a,
		vtkIndent	indent
	)		[protected]

void vtkXMLWriter::WriteArrayAppended	(	vtkAbstractArray *	a,
		vtkIndent	indent,
		OffsetsManager &	offs,
		const char *	alternateName = 0,
		int	writeNumTuples = 0,
		int	timestep = 0
	)		[protected]

int vtkXMLWriter::WriteAsciiData	(	vtkAbstractArray *	a,
		vtkIndent	indent
	)		[protected]

int vtkXMLWriter::WriteBinaryData

(

vtkAbstractArray *

a

)

[protected]

int vtkXMLWriter::WriteBinaryDataInternal

(

vtkAbstractArray *

a

)

[protected]

void vtkXMLWriter::WriteArrayAppendedData	(	vtkAbstractArray *	a,
		vtkTypeInt64	pos,
		vtkTypeInt64 &	lastoffset
	)		[protected]

void vtkXMLWriter::WriteFieldData

(

vtkIndent

indent

)

[protected]

void vtkXMLWriter::WriteFieldDataInline	(	vtkFieldData *	fd,
		vtkIndent	indent
	)		[protected]

void vtkXMLWriter::WritePointDataInline	(	vtkPointData *	pd,
		vtkIndent	indent
	)		[protected]

void vtkXMLWriter::WriteCellDataInline	(	vtkCellData *	cd,
		vtkIndent	indent
	)		[protected]

void vtkXMLWriter::WriteFieldDataAppended	(	vtkFieldData *	fd,
		vtkIndent	indent,
		OffsetsManagerGroup *	fdManager
	)		[protected]

void vtkXMLWriter::WriteFieldDataAppendedData	(	vtkFieldData *	fd,
		int	timestep,
		OffsetsManagerGroup *	fdManager
	)		[protected]

void vtkXMLWriter::WritePointDataAppended	(	vtkPointData *	pd,
		vtkIndent	indent,
		OffsetsManagerGroup *	pdManager
	)		[protected]

void vtkXMLWriter::WritePointDataAppendedData	(	vtkPointData *	pd,
		int	timestep,
		OffsetsManagerGroup *	pdManager
	)		[protected]

void vtkXMLWriter::WriteCellDataAppended	(	vtkCellData *	cd,
		vtkIndent	indent,
		OffsetsManagerGroup *	cdManager
	)		[protected]

void vtkXMLWriter::WriteCellDataAppendedData	(	vtkCellData *	cd,
		int	timestep,
		OffsetsManagerGroup *	cdManager
	)		[protected]

void vtkXMLWriter::WriteAttributeIndices	(	vtkDataSetAttributes *	dsa,
		char **	names
	)		[protected]

void vtkXMLWriter::WritePointsAppended	(	vtkPoints *	points,
		vtkIndent	indent,
		OffsetsManager *	manager
	)		[protected]

void vtkXMLWriter::WritePointsAppendedData	(	vtkPoints *	points,
		int	timestep,
		OffsetsManager *	pdManager
	)		[protected]

void vtkXMLWriter::WritePointsInline	(	vtkPoints *	points,
		vtkIndent	indent
	)		[protected]

void vtkXMLWriter::WriteCoordinatesInline	(	vtkDataArray *	xc,
		vtkDataArray *	yc,
		vtkDataArray *	zc,
		vtkIndent	indent
	)		[protected]

void vtkXMLWriter::WriteCoordinatesAppended	(	vtkDataArray *	xc,
		vtkDataArray *	yc,
		vtkDataArray *	zc,
		vtkIndent	indent,
		OffsetsManagerGroup *	coordManager
	)		[protected]

void vtkXMLWriter::WriteCoordinatesAppendedData	(	vtkDataArray *	xc,
		vtkDataArray *	yc,
		vtkDataArray *	zc,
		int	timestep,
		OffsetsManagerGroup *	coordManager
	)		[protected]

virtual vtkAbstractArray* vtkXMLWriter::CreateArrayForPoints

(

vtkAbstractArray *

inArray

)

[protected, virtual]

Reimplemented in vtkXMLStructuredDataWriter.

virtual vtkAbstractArray* vtkXMLWriter::CreateArrayForCells

(

vtkAbstractArray *

inArray

)

[protected, virtual]

Reimplemented in vtkXMLStructuredDataWriter.

virtual vtkDataArray* vtkXMLWriter::CreateExactCoordinates	(	vtkDataArray *	inArray,
		int	xyz
	)		[protected, virtual]

Reimplemented in vtkXMLRectilinearGridWriter.

void vtkXMLWriter::WritePPointData	(	vtkPointData *	pd,
		vtkIndent	indent
	)		[protected]

void vtkXMLWriter::WritePCellData	(	vtkCellData *	cd,
		vtkIndent	indent
	)		[protected]

void vtkXMLWriter::WritePPoints	(	vtkPoints *	points,
		vtkIndent	indent
	)		[protected]

void vtkXMLWriter::WritePArray	(	vtkAbstractArray *	a,
		vtkIndent	indent,
		const char *	alternateName = 0
	)		[protected]

void vtkXMLWriter::WritePCoordinates	(	vtkDataArray *	xc,
		vtkDataArray *	yc,
		vtkDataArray *	zc,
		vtkIndent	indent
	)		[protected]

int vtkXMLWriter::WriteBinaryDataBlock	(	unsigned char *	in_data,
		size_t	numWords,
		int	wordType
	)		[protected]

void vtkXMLWriter::PerformByteSwap	(	void *	data,
		size_t	numWords,
		size_t	wordSize
	)		[protected]

int vtkXMLWriter::CreateCompressionHeader

(

size_t

size

)

[protected]

int vtkXMLWriter::WriteCompressionBlock	(	unsigned char *	data,
		size_t	size
	)		[protected]

int vtkXMLWriter::WriteCompressionHeader

(

)

[protected]

size_t vtkXMLWriter::GetWordTypeSize

(

int

dataType

)

[protected]

const char* vtkXMLWriter::GetWordTypeName

(

int

dataType

)

[protected]

size_t vtkXMLWriter::GetOutputWordTypeSize

(

int

dataType

)

[protected]

char** vtkXMLWriter::CreateStringArray

(

int

numStrings

)

[protected]

void vtkXMLWriter::DestroyStringArray	(	int	numStrings,
		char **	strings
	)		[protected]

virtual void vtkXMLWriter::GetProgressRange

(

float *

range

)

[protected, virtual]

virtual void vtkXMLWriter::SetProgressRange	(	float *	range,
		int	curStep,
		int	numSteps
	)		[protected, virtual]

virtual void vtkXMLWriter::SetProgressRange	(	float *	range,
		int	curStep,
		float *	fractions
	)		[protected, virtual]

virtual void vtkXMLWriter::SetProgressPartial

(

float

fraction

)

[protected, virtual]

virtual void vtkXMLWriter::UpdateProgressDiscrete

(

float

progress

)

[protected, virtual]

int vtkXMLWriter::OpenFile

(

)

[protected]

void vtkXMLWriter::CloseFile

(

)

[protected]

---

Friends And Related Function Documentation

friend class vtkXMLWriterHelper [friend]

Definition at line 463 of file vtkXMLWriter.h.

---

Member Data Documentation

char* vtkXMLWriter::FileName [protected]

Definition at line 239 of file vtkXMLWriter.h.

ostream* vtkXMLWriter::Stream [protected]

Definition at line 242 of file vtkXMLWriter.h.

int vtkXMLWriter::ByteOrder [protected]

Definition at line 245 of file vtkXMLWriter.h.

int vtkXMLWriter::HeaderType [protected]

Definition at line 248 of file vtkXMLWriter.h.

int vtkXMLWriter::IdType [protected]

Definition at line 251 of file vtkXMLWriter.h.

int vtkXMLWriter::DataMode [protected]

Definition at line 255 of file vtkXMLWriter.h.

int vtkXMLWriter::EncodeAppendedData [protected]

Definition at line 258 of file vtkXMLWriter.h.

vtkTypeInt64 vtkXMLWriter::AppendedDataPosition [protected]

Definition at line 261 of file vtkXMLWriter.h.

OffsetsManagerGroup* vtkXMLWriter::FieldDataOM [protected]

Definition at line 264 of file vtkXMLWriter.h.

Int32IdType* vtkXMLWriter::Int32IdTypeBuffer [protected]

Definition at line 282 of file vtkXMLWriter.h.

unsigned char* vtkXMLWriter::ByteSwapBuffer [protected]

Definition at line 285 of file vtkXMLWriter.h.

vtkDataCompressor* vtkXMLWriter::Compressor [protected]

Definition at line 288 of file vtkXMLWriter.h.

size_t vtkXMLWriter::BlockSize [protected]

Definition at line 289 of file vtkXMLWriter.h.

size_t vtkXMLWriter::CompressionBlockNumber [protected]

Definition at line 290 of file vtkXMLWriter.h.

vtkXMLDataHeader* vtkXMLWriter::CompressionHeader [protected]

Definition at line 291 of file vtkXMLWriter.h.

vtkTypeInt64 vtkXMLWriter::CompressionHeaderPosition [protected]

Definition at line 292 of file vtkXMLWriter.h.

vtkOutputStream* vtkXMLWriter::DataStream [protected]

Definition at line 296 of file vtkXMLWriter.h.

float vtkXMLWriter::ProgressRange[2] [protected]

Definition at line 443 of file vtkXMLWriter.h.

ofstream* vtkXMLWriter::OutFile [protected]

Definition at line 445 of file vtkXMLWriter.h.

int vtkXMLWriter::TimeStep [protected]

Definition at line 451 of file vtkXMLWriter.h.

int vtkXMLWriter::CurrentTimeIndex [protected]

Definition at line 452 of file vtkXMLWriter.h.

int vtkXMLWriter::NumberOfTimeSteps [protected]

Definition at line 453 of file vtkXMLWriter.h.

int vtkXMLWriter::TimeStepRange[2] [protected]

Definition at line 455 of file vtkXMLWriter.h.

int vtkXMLWriter::UserContinueExecuting [protected]

Definition at line 459 of file vtkXMLWriter.h.

vtkTypeInt64* vtkXMLWriter::NumberOfTimeValues [protected]

Definition at line 461 of file vtkXMLWriter.h.

---

The documentation for this class was generated from the following file:

• dox/IO/XML/vtkXMLWriter.h