vtkXMLStructuredDataWriter Class Reference

#include <vtkXMLStructuredDataWriter.h>

Inheritance diagram for vtkXMLStructuredDataWriter:

[legend]Collaboration diagram for vtkXMLStructuredDataWriter:

[legend]List of all members.

Detailed Description

Superclass for VTK XML structured data writers.

vtkXMLStructuredDataWriter provides VTK XML writing functionality that is common among all the structured data formats.

Definition at line 32 of file vtkXMLStructuredDataWriter.h.

Public Types

typedef vtkXMLWriter Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

void PrintSelf (ostream &os, vtkIndent indent)

virtual void SetNumberOfPieces (int)

virtual int GetNumberOfPieces ()

virtual void SetWriteExtent (int, int, int, int, int, int)

virtual void SetWriteExtent (int[6])

virtual int * GetWriteExtent ()

virtual void GetWriteExtent (int &, int &, int &, int &, int &, int &)

virtual void GetWriteExtent (int[6])

virtual void SetExtentTranslator (vtkExtentTranslator *)

virtual vtkExtentTranslator * GetExtentTranslator ()

Static Public Member Functions

static int IsTypeOf (const char *type)

static vtkXMLStructuredDataWriter * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkXMLStructuredDataWriter ()

~vtkXMLStructuredDataWriter ()

virtual void WritePrimaryElementAttributes (ostream &os, vtkIndent indent)

virtual void WriteAppendedPiece (int index, vtkIndent indent)

virtual void WriteAppendedPieceData (int index)

virtual void WriteInlinePiece (vtkIndent indent)

virtual void GetInputExtent (int *extent)=0

virtual int WriteHeader ()

virtual int WriteAPiece ()

virtual int WriteFooter ()

virtual void AllocatePositionArrays ()

virtual void DeletePositionArrays ()

void SetupExtentTranslator ()

vtkDataArray * CreateExactExtent (vtkDataArray *array, int *inExtent, int *outExtent, int isPoint)

virtual int WriteInlineMode (vtkIndent indent)

vtkIdType GetStartTuple (int *extent, vtkIdType *increments, int i, int j, int k)

void CalculatePieceFractions (float *fractions)

vtkDataArray * CreateArrayForPoints (vtkDataArray *inArray)

vtkDataArray * CreateArrayForCells (vtkDataArray *inArray)

void SetInputUpdateExtent (int piece)

int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)

virtual void SetInternalWriteExtent (int, int, int, int, int, int)

virtual void SetInternalWriteExtent (int[6])

Protected Attributes

int WriteExtent [6]

int InternalWriteExtent [6]

int NumberOfPieces

vtkExtentTranslator * ExtentTranslator

float * ProgressFractions

int CurrentPiece

OffsetsManagerArray * PointDataOM

OffsetsManagerArray * CellDataOM

Member Typedef Documentation

typedef vtkXMLWriter vtkXMLStructuredDataWriter::Superclass

Reimplemented from vtkXMLWriter.
Reimplemented in vtkXMLImageDataWriter, vtkXMLRectilinearGridWriter, and vtkXMLStructuredGridWriter.
Definition at line 35 of file vtkXMLStructuredDataWriter.h.

Constructor & Destructor Documentation

vtkXMLStructuredDataWriter::vtkXMLStructuredDataWriter ( ) [protected]

vtkXMLStructuredDataWriter::~vtkXMLStructuredDataWriter ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkXMLWriter.
Reimplemented in vtkXMLImageDataWriter, vtkXMLRectilinearGridWriter, and vtkXMLStructuredGridWriter.

static int vtkXMLStructuredDataWriter::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 vtkXMLWriter.
Reimplemented in vtkXMLImageDataWriter, vtkXMLRectilinearGridWriter, and vtkXMLStructuredGridWriter.

virtual int vtkXMLStructuredDataWriter::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 vtkXMLWriter.
Reimplemented in vtkXMLImageDataWriter, vtkXMLRectilinearGridWriter, and vtkXMLStructuredGridWriter.

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

Reimplemented from vtkXMLWriter.
Reimplemented in vtkXMLImageDataWriter, vtkXMLRectilinearGridWriter, and vtkXMLStructuredGridWriter.

void vtkXMLStructuredDataWriter::PrintSelf ( ostream & os,

vtkIndent indent

) [virtual]

Enumerate big and little endian byte order settings.
Reimplemented from vtkXMLWriter.
Reimplemented in vtkXMLImageDataWriter, vtkXMLRectilinearGridWriter, and vtkXMLStructuredGridWriter.

virtual void vtkXMLStructuredDataWriter::SetNumberOfPieces ( int ) [virtual]

Get/Set the number of pieces used to stream the image through the pipeline while writing to the file.

virtual int vtkXMLStructuredDataWriter::GetNumberOfPieces ( ) [virtual]

virtual void vtkXMLStructuredDataWriter::SetWriteExtent ( int ,

int ,

int ,

int ,

int ,

int

) [virtual]

Get/Set the extent of the input that should be treated as the WholeExtent in the output file. The default is the WholeExtent of the input.

virtual void vtkXMLStructuredDataWriter::SetWriteExtent ( int [6] ) [virtual]

Get/Set the extent of the input that should be treated as the WholeExtent in the output file. The default is the WholeExtent of the input.

virtual int* vtkXMLStructuredDataWriter::GetWriteExtent ( ) [virtual]

Get/Set the extent of the input that should be treated as the WholeExtent in the output file. The default is the WholeExtent of the input.

virtual void vtkXMLStructuredDataWriter::GetWriteExtent ( int & ,

int & ,

int & ,

int & ,

int & ,

int &

) [virtual]

Get/Set the extent of the input that should be treated as the WholeExtent in the output file. The default is the WholeExtent of the input.

virtual void vtkXMLStructuredDataWriter::GetWriteExtent ( int [6] ) [virtual]

Get/Set the extent of the input that should be treated as the WholeExtent in the output file. The default is the WholeExtent of the input.

virtual void vtkXMLStructuredDataWriter::SetExtentTranslator ( vtkExtentTranslator * ) [virtual]

Get/Set the extent translator used for streaming.

virtual vtkExtentTranslator* vtkXMLStructuredDataWriter::GetExtentTranslator ( ) [virtual]

Get/Set the extent translator used for streaming.

virtual void vtkXMLStructuredDataWriter::WritePrimaryElementAttributes ( ostream & os,

vtkIndent indent

) [protected, virtual]

Reimplemented from vtkXMLWriter.
Reimplemented in vtkXMLImageDataWriter.

virtual void vtkXMLStructuredDataWriter::WriteAppendedPiece ( int index,

vtkIndent indent

) [protected, virtual]

Reimplemented in vtkXMLRectilinearGridWriter, and vtkXMLStructuredGridWriter.

virtual void vtkXMLStructuredDataWriter::WriteAppendedPieceData ( int index ) [protected, virtual]

Reimplemented in vtkXMLRectilinearGridWriter, and vtkXMLStructuredGridWriter.

virtual void vtkXMLStructuredDataWriter::WriteInlinePiece ( vtkIndent indent ) [protected, virtual]

Reimplemented in vtkXMLRectilinearGridWriter, and vtkXMLStructuredGridWriter.

virtual void vtkXMLStructuredDataWriter::GetInputExtent ( int * extent ) [protected, pure virtual]

Implemented in vtkXMLImageDataWriter, vtkXMLRectilinearGridWriter, and vtkXMLStructuredGridWriter.

virtual int vtkXMLStructuredDataWriter::WriteHeader ( ) [protected, virtual]

virtual int vtkXMLStructuredDataWriter::WriteAPiece ( ) [protected, virtual]

virtual int vtkXMLStructuredDataWriter::WriteFooter ( ) [protected, virtual]

virtual void vtkXMLStructuredDataWriter::AllocatePositionArrays ( ) [protected, virtual]

Reimplemented in vtkXMLRectilinearGridWriter, and vtkXMLStructuredGridWriter.

virtual void vtkXMLStructuredDataWriter::DeletePositionArrays ( ) [protected, virtual]

Reimplemented in vtkXMLRectilinearGridWriter, and vtkXMLStructuredGridWriter.

void vtkXMLStructuredDataWriter::SetupExtentTranslator ( ) [protected]

vtkDataArray* vtkXMLStructuredDataWriter::CreateExactExtent ( vtkDataArray * array,

int * inExtent,

int * outExtent,

int isPoint

) [protected]

virtual int vtkXMLStructuredDataWriter::WriteInlineMode ( vtkIndent indent ) [protected, virtual]

vtkIdType vtkXMLStructuredDataWriter::GetStartTuple ( int * extent,

vtkIdType * increments,

int i,

int j,

int k

) [protected]

void vtkXMLStructuredDataWriter::CalculatePieceFractions ( float * fractions ) [protected]

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

Reimplemented from vtkXMLWriter.

vtkDataArray* vtkXMLStructuredDataWriter::CreateArrayForCells ( vtkDataArray * inArray ) [protected, virtual]

Reimplemented from vtkXMLWriter.

void vtkXMLStructuredDataWriter::SetInputUpdateExtent ( int piece ) [protected]

int vtkXMLStructuredDataWriter::ProcessRequest ( vtkInformation * request,

vtkInformationVector ** inputVector,

vtkInformationVector * outputVector

) [protected, 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 vtkXMLWriter.

virtual void vtkXMLStructuredDataWriter::SetInternalWriteExtent ( int ,

int ,

int ,

int ,

int ,

int

) [protected, virtual]

virtual void vtkXMLStructuredDataWriter::SetInternalWriteExtent ( int [6] ) [protected, virtual]

Member Data Documentation

int vtkXMLStructuredDataWriter::WriteExtent[6] [protected]

Definition at line 94 of file vtkXMLStructuredDataWriter.h.

int vtkXMLStructuredDataWriter::InternalWriteExtent[6] [protected]

Definition at line 100 of file vtkXMLStructuredDataWriter.h.

int vtkXMLStructuredDataWriter::NumberOfPieces [protected]

Definition at line 103 of file vtkXMLStructuredDataWriter.h.

vtkExtentTranslator* vtkXMLStructuredDataWriter::ExtentTranslator [protected]

Definition at line 106 of file vtkXMLStructuredDataWriter.h.

float* vtkXMLStructuredDataWriter::ProgressFractions [protected]

Definition at line 108 of file vtkXMLStructuredDataWriter.h.

int vtkXMLStructuredDataWriter::CurrentPiece [protected]

Definition at line 110 of file vtkXMLStructuredDataWriter.h.

OffsetsManagerArray* vtkXMLStructuredDataWriter::PointDataOM [protected]

Definition at line 114 of file vtkXMLStructuredDataWriter.h.

OffsetsManagerArray* vtkXMLStructuredDataWriter::CellDataOM [protected]

Definition at line 115 of file vtkXMLStructuredDataWriter.h.

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

dox/IO/vtkXMLStructuredDataWriter.h

Generated on Tue Jan 22 00:34:19 2008 for VTK by

1.4.3-20050530


Public Types
typedef vtkXMLWriter	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetNumberOfPieces (int)
virtual int	GetNumberOfPieces ()

virtual void	SetWriteExtent (int, int, int, int, int, int)
virtual void	SetWriteExtent (int[6])
virtual int *	GetWriteExtent ()
virtual void	GetWriteExtent (int &, int &, int &, int &, int &, int &)
virtual void	GetWriteExtent (int[6])

virtual void	SetExtentTranslator (vtkExtentTranslator *)
virtual vtkExtentTranslator *	GetExtentTranslator ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkXMLStructuredDataWriter *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkXMLStructuredDataWriter ()
	~vtkXMLStructuredDataWriter ()
virtual void	WritePrimaryElementAttributes (ostream &os, vtkIndent indent)
virtual void	WriteAppendedPiece (int index, vtkIndent indent)
virtual void	WriteAppendedPieceData (int index)
virtual void	WriteInlinePiece (vtkIndent indent)
virtual void	GetInputExtent (int *extent)=0
virtual int	WriteHeader ()
virtual int	WriteAPiece ()
virtual int	WriteFooter ()
virtual void	AllocatePositionArrays ()
virtual void	DeletePositionArrays ()
void	SetupExtentTranslator ()
vtkDataArray *	CreateExactExtent (vtkDataArray array, int inExtent, int *outExtent, int isPoint)
virtual int	WriteInlineMode (vtkIndent indent)
vtkIdType	GetStartTuple (int extent, vtkIdType increments, int i, int j, int k)
void	CalculatePieceFractions (float *fractions)
vtkDataArray *	CreateArrayForPoints (vtkDataArray *inArray)
vtkDataArray *	CreateArrayForCells (vtkDataArray *inArray)
void	SetInputUpdateExtent (int piece)
int	ProcessRequest (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
virtual void	SetInternalWriteExtent (int, int, int, int, int, int)
virtual void	SetInternalWriteExtent (int[6])
Protected Attributes
int	WriteExtent [6]
int	InternalWriteExtent [6]
int	NumberOfPieces
vtkExtentTranslator *	ExtentTranslator
float *	ProgressFractions
int	CurrentPiece
OffsetsManagerArray *	PointDataOM
OffsetsManagerArray *	CellDataOM