vtkXMLWriter Class Reference

#include <vtkXMLWriter.h>

Inheritance diagram for vtkXMLWriter:

[legend]Collaboration diagram for vtkXMLWriter:

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.

Member Typedef Documentation

typedef vtkIdType vtkXMLWriter::OffsetType

A type used for data sizes and offsets for stream i/o. Using vtkIdType should satisfy most users. This could be streamoff if it is deemed portable. It could also be split into OffsetType (streamoff) and PositionType (streampos).

Definition at line 69 of file vtkXMLWriter.h.

Member Enumeration Documentation

anonymous enum

Enumerate big and little endian byte order settings.

Enumerator:

BigEndian
LittleEndian

Definition at line 59 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 78 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 87 of file vtkXMLWriter.h.

Constructor & Destructor Documentation

vtkXMLWriter::vtkXMLWriter ( ) [protected]

vtkXMLWriter::~vtkXMLWriter ( ) [protected]

Member Function Documentation

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

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 vtkAlgorithm.

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

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 vtkAlgorithm.

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

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.

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::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.

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]

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]

virtual void vtkXMLWriter::EncodeAppendedDataOn ( ) [virtual]

virtual void vtkXMLWriter::EncodeAppendedDataOff ( ) [virtual]

void vtkXMLWriter::SetInput ( vtkDataObject * )

Set/Get an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline

void vtkXMLWriter::SetInput	(	int	,
		vtkDataObject *
	)

Set/Get an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline

vtkDataObject* vtkXMLWriter::GetInput ( int port )

Set/Get an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline

vtkDataObject* vtkXMLWriter::GetInput ( ) [inline]

Set/Get an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline

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

Definition at line 159 of file vtkXMLWriter.h.

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

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

Implemented in vtkXMLCompositeDataWriter, vtkXMLDataSetWriter, vtkXMLHierarchicalBoxDataWriter, vtkXMLHyperOctreeWriter, vtkXMLImageDataWriter, vtkXMLMultiBlockDataWriter, 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 int vtkXMLWriter::ProcessRequest	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)			`[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 vtkXMLCompositeDataWriter, vtkXMLPUnstructuredDataWriter, vtkXMLStructuredDataWriter, and vtkXMLUnstructuredDataWriter.

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 vtkXMLDataSetWriter, vtkXMLPDataSetWriter, and vtkXMLPDataWriter.

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

Reimplemented in vtkXMLCompositeDataWriter, vtkXMLHyperOctreeWriter, and vtkXMLPDataWriter.

Definition at line 292 of file vtkXMLWriter.h.

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


Public Types
typedef vtkAlgorithm	Superclass
	BigEndian
	LittleEndian
	Ascii
	Binary
	Appended
	Int32 = 32
	Int64 = 64

typedef vtkIdType	OffsetType

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

void	SetInput (vtkDataObject *)
void	SetInput (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 (vtkObject *o)
Protected Member Functions
	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 ()
OffsetType	ReserveAttributeSpace (const char *attr, int length=20)
OffsetType	GetAppendedDataOffset ()
OffsetType	WriteAppendedDataOffset (OffsetType streamPos, OffsetType &lastoffset, const char *attr=0)
OffsetType	ForwardAppendedDataOffset (OffsetType streamPos, OffsetType offset, const char *attr=0)
OffsetType	ForwardAppendedDataDouble (OffsetType 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, OffsetType data_size)
void	WriteArrayAppendedData (vtkAbstractArray *a, OffsetType pos, OffsetType &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	WriteBinaryDataInternal (void *data, OffsetType numWords, int wordType)
int	WriteBinaryDataBlock (unsigned char *in_data, OffsetType numWords, int wordType)
void	PerformByteSwap (void *data, OffsetType numWords, int wordSize)
int	CreateCompressionHeader (OffsetType size)
int	WriteCompressionBlock (unsigned char *data, OffsetType size)
int	WriteCompressionHeader ()
OffsetType	GetWordTypeSize (int dataType)
const char *	GetWordTypeName (int dataType)
OffsetType	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	IdType
int	DataMode
int	EncodeAppendedData
OffsetType	AppendedDataPosition
OffsetsManagerGroup *	FieldDataOM
Int32IdType *	Int32IdTypeBuffer
unsigned char *	ByteSwapBuffer
vtkDataCompressor *	Compressor
unsigned int	BlockSize
OffsetType	CompressionBlockNumber
HeaderType *	CompressionHeader
unsigned int	CompressionHeaderLength
OffsetType	CompressionHeaderPosition
vtkOutputStream *	DataStream
float	ProgressRange [2]
ofstream *	OutFile
int	TimeStep
int	CurrentTimeIndex
int	NumberOfTimeSteps
int	TimeStepRange [2]
int	UserContinueExecuting
unsigned long *	NumberOfTimeValues
Friends
class	vtkXMLWriterHelper

vtkXMLWriter Class Reference

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation