vtkXMLWriter Class Reference

#include <vtkXMLWriter.h>

Inheritance diagram for vtkXMLWriter:

[legend]Collaboration diagram for vtkXMLWriter:

[legend]List of all members.

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 38 of file vtkXMLWriter.h.

Public Types

typedef vtkProcessObject Superclass

enum { BigEndian, LittleEndian }

enum { Ascii, Binary, Appended }

enum { Int32 = 32, Int64 = 64 }

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

void PrintSelf (ostream &os, vtkIndent indent)

virtual void SetByteOrder (int)

virtual int GetByteOrder ()

void SetByteOrderToBigEndian ()

void SetByteOrderToLittleEndian ()

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 ()

virtual void SetBlockSize (unsigned int blockSize)

virtual unsigned int 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 ()

virtual const char * GetDefaultFileExtension ()=0

int Write ()

Static Public Member Functions

static int IsTypeOf (const char *type)

static vtkXMLWriter * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkXMLWriter ()

~vtkXMLWriter ()

virtual void SetDataStream (vtkOutputStream *)

virtual vtkOutputStream * GetDataStream ()

virtual int WriteInternal ()

virtual int WriteData ()=0

virtual const char * GetDataSetName ()=0

virtual int GetDataSetMajorVersion ()

virtual int GetDataSetMinorVersion ()

vtkDataSet * GetInputAsDataSet ()

int StartFile ()

virtual void WriteFileAttributes ()

int EndFile ()

void DeleteFile ()

void DeleteFile (const char *name)

void StartAppendedData ()

void EndAppendedData ()

unsigned long ReserveAttributeSpace (const char *attr=0)

unsigned long GetAppendedDataOffset ()

unsigned long WriteAppendedDataOffset (unsigned long streamPos, const char *attr=0)

int WriteBinaryData (void *data, int numWords, int wordType)

int WriteBinaryData (char *data)

int WriteBinaryData (char *data, int numWords)

int WriteBinaryData (unsigned char *data, int numWords)

int WriteBinaryData (short *data, int numWords)

int WriteBinaryData (unsigned short *data, int numWords)

int WriteBinaryData (int *data, int numWords)

int WriteBinaryData (unsigned int *data, int numWords)

int WriteAsciiData (void *data, int numWords, int wordType, vtkIndent indent)

int WriteAsciiData (char *data, vtkIndent indent)

int WriteAsciiData (char *data, int numWords, vtkIndent indent)

int WriteAsciiData (unsigned char *data, int numWords, vtkIndent indent)

int WriteAsciiData (short *data, int numWords, vtkIndent indent)

int WriteAsciiData (unsigned short *data, int numWords, vtkIndent indent)

int WriteAsciiData (int *data, int numWords, vtkIndent indent)

int WriteAsciiData (unsigned int *data, int numWords, vtkIndent indent)

int WriteScalarAttribute (const char *name, int data)

int WriteScalarAttribute (const char *name, float 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)

unsigned long WriteDataArrayAppended (vtkDataArray *a, vtkIndent indent, const char *alternateName=0)

void WriteDataArrayAppendedData (vtkDataArray *a, unsigned long pos)

void WriteDataArrayInline (vtkDataArray *a, vtkIndent indent, const char *alternateName=0)

void WriteInlineData (void *data, int numWords, int wordType, vtkIndent indent)

void WritePointDataInline (vtkPointData *pd, vtkIndent indent)

void WriteCellDataInline (vtkCellData *cd, vtkIndent indent)

unsigned long * WritePointDataAppended (vtkPointData *pd, vtkIndent indent)

void WritePointDataAppendedData (vtkPointData *pd, unsigned long *pdPositions)

unsigned long * WriteCellDataAppended (vtkCellData *cd, vtkIndent indent)

void WriteCellDataAppendedData (vtkCellData *cd, unsigned long *cdPositions)

void WriteAttributeIndices (vtkDataSetAttributes *dsa, char **names)

unsigned long WritePointsAppended (vtkPoints *points, vtkIndent indent)

void WritePointsAppendedData (vtkPoints *points, unsigned long pointsPosition)

void WritePointsInline (vtkPoints *points, vtkIndent indent)

void WriteCoordinatesInline (vtkDataArray *xc, vtkDataArray *yc, vtkDataArray *zc, vtkIndent indent)

unsigned long * WriteCoordinatesAppended (vtkDataArray *xc, vtkDataArray *yc, vtkDataArray *zc, vtkIndent indent)

void WriteCoordinatesAppendedData (vtkDataArray *xc, vtkDataArray *yc, vtkDataArray *zc, unsigned long *cPositions)

virtual vtkDataArray * CreateArrayForPoints (vtkDataArray *inArray)

virtual vtkDataArray * CreateArrayForCells (vtkDataArray *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 WritePDataArray (vtkDataArray *a, vtkIndent indent, const char *alternateName=0)

void WritePCoordinates (vtkDataArray *xc, vtkDataArray *yc, vtkDataArray *zc, vtkIndent indent)

int WriteBinaryDataInternal (void *data, int numWords, int wordType)

int WriteBinaryDataBlock (unsigned char *in_data, int numWords, int wordType)

void PerformByteSwap (void *data, int numWords, int wordSize)

int CreateCompressionHeader (unsigned long size)

int WriteCompressionBlock (unsigned char *data, unsigned long size)

int WriteCompressionHeader ()

unsigned long GetWordTypeSize (int dataType)

const char * GetWordTypeName (int dataType)

unsigned long 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)

Protected Attributes

char * FileName

ostream * Stream

int ByteOrder

int IdType

int DataMode

int EncodeAppendedData

unsigned long AppendedDataPosition

Int32IdType * Int32IdTypeBuffer

unsigned char * ByteSwapBuffer

vtkDataCompressor * Compressor

unsigned int BlockSize

unsigned long CompressionBlockNumber

HeaderType * CompressionHeader

unsigned int CompressionHeaderLength

unsigned long CompressionHeaderPosition

vtkOutputStream * DataStream

float ProgressRange [2]

Member Typedef Documentation

typedef vtkProcessObject vtkXMLWriter::Superclass

Reimplemented from vtkProcessObject.
Reimplemented in vtkXMLDataSetWriter, vtkXMLImageDataWriter, vtkXMLPDataSetWriter, vtkXMLPDataWriter, vtkXMLPImageDataWriter, vtkXMLPolyDataWriter, vtkXMLPPolyDataWriter, vtkXMLPRectilinearGridWriter, vtkXMLPStructuredDataWriter, vtkXMLPStructuredGridWriter, vtkXMLPUnstructuredDataWriter, vtkXMLPUnstructuredGridWriter, vtkXMLRectilinearGridWriter, vtkXMLStructuredDataWriter, vtkXMLStructuredGridWriter, vtkXMLUnstructuredDataWriter, and vtkXMLUnstructuredGridWriter.
Definition at line 41 of file vtkXMLWriter.h.

Member Enumeration Documentation

anonymous enum

Enumerate big and little endian byte order settings.
Enumeration values:

BigEndian

LittleEndian

Definition at line 47 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).
Enumeration values:

Ascii

Binary

Appended

Definition at line 56 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.
Enumeration values:

Int32

Int64

Definition at line 65 of file vtkXMLWriter.h.

Constructor & Destructor Documentation

vtkXMLWriter::vtkXMLWriter ( ) [protected]

vtkXMLWriter::~vtkXMLWriter ( ) [protected]

Member Function Documentation

virtual const char* vtkXMLWriter::GetClassName ( ) [virtual]

Reimplemented from vtkProcessObject.
Reimplemented in vtkXMLDataSetWriter, vtkXMLImageDataWriter, vtkXMLPDataSetWriter, vtkXMLPDataWriter, vtkXMLPImageDataWriter, vtkXMLPolyDataWriter, vtkXMLPPolyDataWriter, vtkXMLPRectilinearGridWriter, vtkXMLPStructuredDataWriter, vtkXMLPStructuredGridWriter, vtkXMLPUnstructuredDataWriter, vtkXMLPUnstructuredGridWriter, vtkXMLRectilinearGridWriter, vtkXMLStructuredDataWriter, vtkXMLStructuredGridWriter, vtkXMLUnstructuredDataWriter, and vtkXMLUnstructuredGridWriter.

static int vtkXMLWriter::IsTypeOf ( const char * type ) [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkProcessObject.
Reimplemented in vtkXMLDataSetWriter, vtkXMLImageDataWriter, vtkXMLPDataSetWriter, vtkXMLPDataWriter, vtkXMLPImageDataWriter, vtkXMLPolyDataWriter, vtkXMLPPolyDataWriter, vtkXMLPRectilinearGridWriter, vtkXMLPStructuredDataWriter, vtkXMLPStructuredGridWriter, vtkXMLPUnstructuredDataWriter, vtkXMLPUnstructuredGridWriter, vtkXMLRectilinearGridWriter, vtkXMLStructuredDataWriter, vtkXMLStructuredGridWriter, vtkXMLUnstructuredDataWriter, and vtkXMLUnstructuredGridWriter.

virtual int vtkXMLWriter::IsA ( const char * type ) [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkProcessObject.
Reimplemented in vtkXMLDataSetWriter, vtkXMLImageDataWriter, vtkXMLPDataSetWriter, vtkXMLPDataWriter, vtkXMLPImageDataWriter, vtkXMLPolyDataWriter, vtkXMLPPolyDataWriter, vtkXMLPRectilinearGridWriter, vtkXMLPStructuredDataWriter, vtkXMLPStructuredGridWriter, vtkXMLPUnstructuredDataWriter, vtkXMLPUnstructuredGridWriter, vtkXMLRectilinearGridWriter, vtkXMLStructuredDataWriter, vtkXMLStructuredGridWriter, vtkXMLUnstructuredDataWriter, and vtkXMLUnstructuredGridWriter.

static vtkXMLWriter* vtkXMLWriter::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkProcessObject.
Reimplemented in vtkXMLDataSetWriter, vtkXMLImageDataWriter, vtkXMLPDataSetWriter, vtkXMLPDataWriter, vtkXMLPImageDataWriter, vtkXMLPolyDataWriter, vtkXMLPPolyDataWriter, vtkXMLPRectilinearGridWriter, vtkXMLPStructuredDataWriter, vtkXMLPStructuredGridWriter, vtkXMLPUnstructuredDataWriter, vtkXMLPUnstructuredGridWriter, vtkXMLRectilinearGridWriter, vtkXMLStructuredDataWriter, vtkXMLStructuredGridWriter, vtkXMLUnstructuredDataWriter, and vtkXMLUnstructuredGridWriter.

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 vtkProcessObject.
Reimplemented in vtkXMLDataSetWriter, vtkXMLImageDataWriter, vtkXMLPDataSetWriter, vtkXMLPDataWriter, vtkXMLPImageDataWriter, vtkXMLPolyDataWriter, vtkXMLPPolyDataWriter, vtkXMLPRectilinearGridWriter, vtkXMLPStructuredDataWriter, vtkXMLPStructuredGridWriter, vtkXMLPUnstructuredDataWriter, vtkXMLPUnstructuredGridWriter, vtkXMLRectilinearGridWriter, vtkXMLStructuredDataWriter, vtkXMLStructuredGridWriter, vtkXMLUnstructuredDataWriter, and vtkXMLUnstructuredGridWriter.

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]

void vtkXMLWriter::SetByteOrderToBigEndian ( )

void vtkXMLWriter::SetByteOrderToLittleEndian ( )

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]

void vtkXMLWriter::SetIdTypeToInt32 ( )

void vtkXMLWriter::SetIdTypeToInt64 ( )

virtual void vtkXMLWriter::SetFileName ( const char * ) [virtual]

Get/Set the name of the output file.

virtual char* vtkXMLWriter::GetFileName ( ) [virtual]

virtual void vtkXMLWriter::SetCompressor ( vtkDataCompressor * ) [virtual]

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

virtual vtkDataCompressor* vtkXMLWriter::GetCompressor ( ) [virtual]

virtual void vtkXMLWriter::SetBlockSize ( unsigned int 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 unsigned int vtkXMLWriter::GetBlockSize ( ) [virtual]

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]

void vtkXMLWriter::SetDataModeToAscii ( )

void vtkXMLWriter::SetDataModeToBinary ( )

void vtkXMLWriter::SetDataModeToAppended ( )

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]

virtual void vtkXMLWriter::EncodeAppendedDataOn ( ) [virtual]

virtual void vtkXMLWriter::EncodeAppendedDataOff ( ) [virtual]

virtual const char* vtkXMLWriter::GetDefaultFileExtension ( ) [pure virtual]

Get the default file extension for files written by this writer.
Implemented in vtkXMLDataSetWriter, vtkXMLImageDataWriter, vtkXMLPDataSetWriter, vtkXMLPImageDataWriter, vtkXMLPolyDataWriter, vtkXMLPPolyDataWriter, vtkXMLPRectilinearGridWriter, vtkXMLPStructuredGridWriter, vtkXMLPUnstructuredGridWriter, vtkXMLRectilinearGridWriter, vtkXMLStructuredGridWriter, and vtkXMLUnstructuredGridWriter.

int vtkXMLWriter::Write ( )

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

virtual void vtkXMLWriter::SetDataStream ( vtkOutputStream * ) [protected, virtual]

virtual vtkOutputStream* vtkXMLWriter::GetDataStream ( ) [protected, virtual]

virtual int vtkXMLWriter::WriteInternal ( ) [protected, virtual]

Reimplemented in vtkXMLDataSetWriter, vtkXMLPDataSetWriter, and vtkXMLPDataWriter.

virtual int vtkXMLWriter::WriteData ( ) [protected, pure virtual]

Implemented in vtkXMLDataSetWriter, vtkXMLPDataWriter, vtkXMLStructuredDataWriter, and vtkXMLUnstructuredDataWriter.

virtual const char* vtkXMLWriter::GetDataSetName ( ) [protected, pure virtual]

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

virtual int vtkXMLWriter::GetDataSetMajorVersion ( ) [protected, virtual]

virtual int vtkXMLWriter::GetDataSetMinorVersion ( ) [protected, virtual]

vtkDataSet* vtkXMLWriter::GetInputAsDataSet ( ) [protected]

int vtkXMLWriter::StartFile ( ) [protected]

virtual void vtkXMLWriter::WriteFileAttributes ( ) [protected, virtual]

int vtkXMLWriter::EndFile ( ) [protected]

void vtkXMLWriter::DeleteFile ( ) [protected]

void vtkXMLWriter::DeleteFile ( const char * name ) [protected]

void vtkXMLWriter::StartAppendedData ( ) [protected]

void vtkXMLWriter::EndAppendedData ( ) [protected]

unsigned long vtkXMLWriter::ReserveAttributeSpace ( const char * attr = 0 ) [protected]

unsigned long vtkXMLWriter::GetAppendedDataOffset ( ) [protected]

unsigned long vtkXMLWriter::WriteAppendedDataOffset ( unsigned long streamPos,

const char * attr = 0

) [protected]

int vtkXMLWriter::WriteBinaryData ( void * data,

int numWords,

int wordType

) [protected]

int vtkXMLWriter::WriteBinaryData ( char * data ) [inline, protected]

Definition at line 245 of file vtkXMLWriter.h.
References VTK_CHAR.

int vtkXMLWriter::WriteBinaryData ( char * data,

int numWords

) [inline, protected]

Definition at line 248 of file vtkXMLWriter.h.
References VTK_CHAR.

int vtkXMLWriter::WriteBinaryData ( unsigned char * data,

int numWords

) [inline, protected]

Definition at line 250 of file vtkXMLWriter.h.
References VTK_UNSIGNED_CHAR.

int vtkXMLWriter::WriteBinaryData ( short * data,

int numWords

) [inline, protected]

Definition at line 252 of file vtkXMLWriter.h.
References VTK_SHORT.

int vtkXMLWriter::WriteBinaryData ( unsigned short * data,

int numWords

) [inline, protected]

Definition at line 254 of file vtkXMLWriter.h.
References VTK_UNSIGNED_SHORT.

int vtkXMLWriter::WriteBinaryData ( int * data,

int numWords

) [inline, protected]

Definition at line 256 of file vtkXMLWriter.h.
References VTK_INT.

int vtkXMLWriter::WriteBinaryData ( unsigned int * data,

int numWords

) [inline, protected]

Definition at line 258 of file vtkXMLWriter.h.
References VTK_UNSIGNED_INT.

int vtkXMLWriter::WriteAsciiData ( void * data,

int numWords,

int wordType,

vtkIndent indent

) [protected]

int vtkXMLWriter::WriteAsciiData ( char * data,

vtkIndent indent

) [inline, protected]

Definition at line 263 of file vtkXMLWriter.h.
References VTK_CHAR.

int vtkXMLWriter::WriteAsciiData ( char * data,

int numWords,

vtkIndent indent

) [inline, protected]

Definition at line 266 of file vtkXMLWriter.h.
References VTK_CHAR.

int vtkXMLWriter::WriteAsciiData ( unsigned char * data,

int numWords,

vtkIndent indent

) [inline, protected]

Definition at line 268 of file vtkXMLWriter.h.
References VTK_UNSIGNED_CHAR.

int vtkXMLWriter::WriteAsciiData ( short * data,

int numWords,

vtkIndent indent

) [inline, protected]

Definition at line 270 of file vtkXMLWriter.h.
References VTK_SHORT.

int vtkXMLWriter::WriteAsciiData ( unsigned short * data,

int numWords,

vtkIndent indent

) [inline, protected]

Definition at line 272 of file vtkXMLWriter.h.
References VTK_UNSIGNED_SHORT.

int vtkXMLWriter::WriteAsciiData ( int * data,

int numWords,

vtkIndent indent

) [inline, protected]

Definition at line 274 of file vtkXMLWriter.h.
References VTK_INT.

int vtkXMLWriter::WriteAsciiData ( unsigned int * data,

int numWords,

vtkIndent indent

) [inline, protected]

Definition at line 276 of file vtkXMLWriter.h.
References VTK_UNSIGNED_INT.

int vtkXMLWriter::WriteScalarAttribute ( const char * name,

int data

) [protected]

int vtkXMLWriter::WriteScalarAttribute ( const char * name,

float 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]

unsigned long vtkXMLWriter::WriteDataArrayAppended ( vtkDataArray * a,

vtkIndent indent,

const char * alternateName = 0

) [protected]

void vtkXMLWriter::WriteDataArrayAppendedData ( vtkDataArray * a,

unsigned long pos

) [protected]

void vtkXMLWriter::WriteDataArrayInline ( vtkDataArray * a,

vtkIndent indent,

const char * alternateName = 0

) [protected]

void vtkXMLWriter::WriteInlineData ( void * data,

int numWords,

int wordType,

vtkIndent indent

) [protected]

void vtkXMLWriter::WritePointDataInline ( vtkPointData * pd,

vtkIndent indent

) [protected]

void vtkXMLWriter::WriteCellDataInline ( vtkCellData * cd,

vtkIndent indent

) [protected]

unsigned long* vtkXMLWriter::WritePointDataAppended ( vtkPointData * pd,

vtkIndent indent

) [protected]

void vtkXMLWriter::WritePointDataAppendedData ( vtkPointData * pd,

unsigned long * pdPositions

) [protected]

unsigned long* vtkXMLWriter::WriteCellDataAppended ( vtkCellData * cd,

vtkIndent indent

) [protected]

void vtkXMLWriter::WriteCellDataAppendedData ( vtkCellData * cd,

unsigned long * cdPositions

) [protected]

void vtkXMLWriter::WriteAttributeIndices ( vtkDataSetAttributes * dsa,

char ** names

) [protected]

unsigned long vtkXMLWriter::WritePointsAppended ( vtkPoints * points,

vtkIndent indent

) [protected]

void vtkXMLWriter::WritePointsAppendedData ( vtkPoints * points,

unsigned long pointsPosition

) [protected]

void vtkXMLWriter::WritePointsInline ( vtkPoints * points,

vtkIndent indent

) [protected]

void vtkXMLWriter::WriteCoordinatesInline ( vtkDataArray * xc,

vtkDataArray * yc,

vtkDataArray * zc,

vtkIndent indent

) [protected]

unsigned long* vtkXMLWriter::WriteCoordinatesAppended ( vtkDataArray * xc,

vtkDataArray * yc,

vtkDataArray * zc,

vtkIndent indent

) [protected]

void vtkXMLWriter::WriteCoordinatesAppendedData ( vtkDataArray * xc,

vtkDataArray * yc,

vtkDataArray * zc,

unsigned long * cPositions

) [protected]

virtual vtkDataArray* vtkXMLWriter::CreateArrayForPoints ( vtkDataArray * inArray ) [protected, virtual]

Reimplemented in vtkXMLStructuredDataWriter.

virtual vtkDataArray* vtkXMLWriter::CreateArrayForCells ( vtkDataArray * 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::WritePDataArray ( vtkDataArray * a,

vtkIndent indent,

const char * alternateName = 0

) [protected]

void vtkXMLWriter::WritePCoordinates ( vtkDataArray * xc,

vtkDataArray * yc,

vtkDataArray * zc,

vtkIndent indent

) [protected]

int vtkXMLWriter::WriteBinaryDataInternal ( void * data,

int numWords,

int wordType

) [protected]

int vtkXMLWriter::WriteBinaryDataBlock ( unsigned char * in_data,

int numWords,

int wordType

) [protected]

void vtkXMLWriter::PerformByteSwap ( void * data,

int numWords,

int wordSize

) [protected]

int vtkXMLWriter::CreateCompressionHeader ( unsigned long size ) [protected]

int vtkXMLWriter::WriteCompressionBlock ( unsigned char * data,

unsigned long size

) [protected]

int vtkXMLWriter::WriteCompressionHeader ( ) [protected]

unsigned long vtkXMLWriter::GetWordTypeSize ( int dataType ) [protected]

const char* vtkXMLWriter::GetWordTypeName ( int dataType ) [protected]

unsigned long 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]

Member Data Documentation

char* vtkXMLWriter::FileName [protected]

Definition at line 142 of file vtkXMLWriter.h.

ostream* vtkXMLWriter::Stream [protected]

Definition at line 145 of file vtkXMLWriter.h.

int vtkXMLWriter::ByteOrder [protected]

Definition at line 148 of file vtkXMLWriter.h.

int vtkXMLWriter::IdType [protected]

Definition at line 151 of file vtkXMLWriter.h.

int vtkXMLWriter::DataMode [protected]

Definition at line 155 of file vtkXMLWriter.h.

int vtkXMLWriter::EncodeAppendedData [protected]

Definition at line 158 of file vtkXMLWriter.h.

unsigned long vtkXMLWriter::AppendedDataPosition [protected]

Definition at line 161 of file vtkXMLWriter.h.

Int32IdType* vtkXMLWriter::Int32IdTypeBuffer [protected]

Definition at line 194 of file vtkXMLWriter.h.

unsigned char* vtkXMLWriter::ByteSwapBuffer [protected]

Definition at line 197 of file vtkXMLWriter.h.

vtkDataCompressor* vtkXMLWriter::Compressor [protected]

Definition at line 200 of file vtkXMLWriter.h.

unsigned int vtkXMLWriter::BlockSize [protected]

Definition at line 201 of file vtkXMLWriter.h.

unsigned long vtkXMLWriter::CompressionBlockNumber [protected]

Definition at line 202 of file vtkXMLWriter.h.

HeaderType* vtkXMLWriter::CompressionHeader [protected]

Definition at line 203 of file vtkXMLWriter.h.

unsigned int vtkXMLWriter::CompressionHeaderLength [protected]

Definition at line 204 of file vtkXMLWriter.h.

unsigned long vtkXMLWriter::CompressionHeaderPosition [protected]

Definition at line 205 of file vtkXMLWriter.h.

vtkOutputStream* vtkXMLWriter::DataStream [protected]

Definition at line 209 of file vtkXMLWriter.h.

float vtkXMLWriter::ProgressRange[2] [protected]

Definition at line 354 of file vtkXMLWriter.h.

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

dox/IO/vtkXMLWriter.h


Public Types
typedef vtkProcessObject	Superclass
enum	{ BigEndian, LittleEndian }
enum	{ Ascii, Binary, Appended }
enum	{ Int32 = 32, Int64 = 64 }
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetByteOrder (int)
virtual int	GetByteOrder ()
void	SetByteOrderToBigEndian ()
void	SetByteOrderToLittleEndian ()
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 ()
virtual void	SetBlockSize (unsigned int blockSize)
virtual unsigned int	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 ()
virtual const char *	GetDefaultFileExtension ()=0
int	Write ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkXMLWriter *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkXMLWriter ()
	~vtkXMLWriter ()
virtual void	SetDataStream (vtkOutputStream *)
virtual vtkOutputStream *	GetDataStream ()
virtual int	WriteInternal ()
virtual int	WriteData ()=0
virtual const char *	GetDataSetName ()=0
virtual int	GetDataSetMajorVersion ()
virtual int	GetDataSetMinorVersion ()
vtkDataSet *	GetInputAsDataSet ()
int	StartFile ()
virtual void	WriteFileAttributes ()
int	EndFile ()
void	DeleteFile ()
void	DeleteFile (const char *name)
void	StartAppendedData ()
void	EndAppendedData ()
unsigned long	ReserveAttributeSpace (const char *attr=0)
unsigned long	GetAppendedDataOffset ()
unsigned long	WriteAppendedDataOffset (unsigned long streamPos, const char *attr=0)
int	WriteBinaryData (void *data, int numWords, int wordType)
int	WriteBinaryData (char *data)
int	WriteBinaryData (char *data, int numWords)
int	WriteBinaryData (unsigned char *data, int numWords)
int	WriteBinaryData (short *data, int numWords)
int	WriteBinaryData (unsigned short *data, int numWords)
int	WriteBinaryData (int *data, int numWords)
int	WriteBinaryData (unsigned int *data, int numWords)
int	WriteAsciiData (void *data, int numWords, int wordType, vtkIndent indent)
int	WriteAsciiData (char *data, vtkIndent indent)
int	WriteAsciiData (char *data, int numWords, vtkIndent indent)
int	WriteAsciiData (unsigned char *data, int numWords, vtkIndent indent)
int	WriteAsciiData (short *data, int numWords, vtkIndent indent)
int	WriteAsciiData (unsigned short *data, int numWords, vtkIndent indent)
int	WriteAsciiData (int *data, int numWords, vtkIndent indent)
int	WriteAsciiData (unsigned int *data, int numWords, vtkIndent indent)
int	WriteScalarAttribute (const char *name, int data)
int	WriteScalarAttribute (const char *name, float 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)
unsigned long	WriteDataArrayAppended (vtkDataArray a, vtkIndent indent, const char alternateName=0)
void	WriteDataArrayAppendedData (vtkDataArray *a, unsigned long pos)
void	WriteDataArrayInline (vtkDataArray a, vtkIndent indent, const char alternateName=0)
void	WriteInlineData (void *data, int numWords, int wordType, vtkIndent indent)
void	WritePointDataInline (vtkPointData *pd, vtkIndent indent)
void	WriteCellDataInline (vtkCellData *cd, vtkIndent indent)
unsigned long *	WritePointDataAppended (vtkPointData *pd, vtkIndent indent)
void	WritePointDataAppendedData (vtkPointData pd, unsigned long pdPositions)
unsigned long *	WriteCellDataAppended (vtkCellData *cd, vtkIndent indent)
void	WriteCellDataAppendedData (vtkCellData cd, unsigned long cdPositions)
void	WriteAttributeIndices (vtkDataSetAttributes dsa, char *names)
unsigned long	WritePointsAppended (vtkPoints *points, vtkIndent indent)
void	WritePointsAppendedData (vtkPoints *points, unsigned long pointsPosition)
void	WritePointsInline (vtkPoints *points, vtkIndent indent)
void	WriteCoordinatesInline (vtkDataArray xc, vtkDataArray yc, vtkDataArray *zc, vtkIndent indent)
unsigned long *	WriteCoordinatesAppended (vtkDataArray xc, vtkDataArray yc, vtkDataArray *zc, vtkIndent indent)
void	WriteCoordinatesAppendedData (vtkDataArray xc, vtkDataArray yc, vtkDataArray zc, unsigned long cPositions)
virtual vtkDataArray *	CreateArrayForPoints (vtkDataArray *inArray)
virtual vtkDataArray *	CreateArrayForCells (vtkDataArray *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	WritePDataArray (vtkDataArray a, vtkIndent indent, const char alternateName=0)
void	WritePCoordinates (vtkDataArray xc, vtkDataArray yc, vtkDataArray *zc, vtkIndent indent)
int	WriteBinaryDataInternal (void *data, int numWords, int wordType)
int	WriteBinaryDataBlock (unsigned char *in_data, int numWords, int wordType)
void	PerformByteSwap (void *data, int numWords, int wordSize)
int	CreateCompressionHeader (unsigned long size)
int	WriteCompressionBlock (unsigned char *data, unsigned long size)
int	WriteCompressionHeader ()
unsigned long	GetWordTypeSize (int dataType)
const char *	GetWordTypeName (int dataType)
unsigned long	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)
Protected Attributes
char *	FileName
ostream *	Stream
int	ByteOrder
int	IdType
int	DataMode
int	EncodeAppendedData
unsigned long	AppendedDataPosition
Int32IdType *	Int32IdTypeBuffer
unsigned char *	ByteSwapBuffer
vtkDataCompressor *	Compressor
unsigned int	BlockSize
unsigned long	CompressionBlockNumber
HeaderType *	CompressionHeader
unsigned int	CompressionHeaderLength
unsigned long	CompressionHeaderPosition
vtkOutputStream *	DataStream
float	ProgressRange [2]