vtkXMLDataReader Class Reference

#include <vtkXMLDataReader.h>

Inheritance diagram for vtkXMLDataReader:

[legend]

Collaboration diagram for vtkXMLDataReader:

[legend]

List of all members.

---

Detailed Description

Superclass for VTK XML file readers.

vtkXMLDataReader provides functionality common to all VTK XML file readers. Concrete subclasses call upon this functionality when needed.

See also:

vtkXMLPDataReader

Definition at line 31 of file vtkXMLDataReader.h.

Public Types
typedef vtkXMLReader	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkIdType	GetNumberOfPoints ()=0
virtual vtkIdType	GetNumberOfCells ()=0
virtual void	CopyOutputInformation (vtkInformation *outInfo, int port)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkXMLDataReader *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkXMLDataReader ()
	~vtkXMLDataReader ()
int	SetUpdateExtentInfo (vtkXMLDataElement *eDSA, vtkInformationVector *infoVector, int piece, int numPieces)
virtual void	CreateXMLParser ()
virtual void	DestroyXMLParser ()
virtual void	SetupOutputInformation (vtkInformation *outInfo)
virtual void	SetupUpdateExtentInformation (vtkInformation *outInfo)
int	ReadPrimaryElement (vtkXMLDataElement *ePrimary)
void	SetupOutputData ()
virtual void	SetupPieces (int numPieces)
virtual void	DestroyPieces ()
int	ReadPiece (vtkXMLDataElement *ePiece, int piece)
virtual int	ReadPiece (vtkXMLDataElement *ePiece)
int	ReadPieceData (int piece)
virtual int	ReadPieceData ()
virtual void	ReadXMLData ()
virtual int	ReadArrayForPoints (vtkXMLDataElement *da, vtkAbstractArray *outArray)
virtual int	ReadArrayForCells (vtkXMLDataElement *da, vtkAbstractArray *outArray)
int	ReadArrayValues (vtkXMLDataElement *da, vtkIdType arrayIndex, vtkAbstractArray *array, vtkIdType startIndex, vtkIdType numValues)
virtual void	DataProgressCallback ()
int	PointDataNeedToReadTimeStep (vtkXMLDataElement *eNested)
int	CellDataNeedToReadTimeStep (vtkXMLDataElement *eNested)
Static Protected Member Functions
static void	DataProgressCallbackFunction (vtkObject *, unsigned long, void *, void *)
Protected Attributes
int	NumberOfPieces
vtkXMLDataElement **	PointDataElements
vtkXMLDataElement **	CellDataElements
int	Piece
int	NumberOfPointArrays
int	NumberOfCellArrays
int	InReadData
vtkCallbackCommand *	DataProgressObserver
int *	PointDataTimeStep
unsigned long *	PointDataOffset
int *	CellDataTimeStep
unsigned long *	CellDataOffset

---

Member Typedef Documentation

typedef vtkXMLReader vtkXMLDataReader::Superclass

Reimplemented from vtkXMLReader.

Reimplemented in vtkRTXMLPolyDataReader, vtkXMLHyperOctreeReader, vtkXMLImageDataReader, vtkXMLPolyDataReader, vtkXMLRectilinearGridReader, vtkXMLStructuredDataReader, vtkXMLStructuredGridReader, vtkXMLUnstructuredDataReader, and vtkXMLUnstructuredGridReader.

Definition at line 34 of file vtkXMLDataReader.h.

---

Constructor & Destructor Documentation

vtkXMLDataReader::vtkXMLDataReader

(

)

[protected]

vtkXMLDataReader::~vtkXMLDataReader

(

)

[protected]

---

Member Function Documentation

virtual const char* vtkXMLDataReader::GetClassName

(

)

[virtual]

Reimplemented from vtkXMLReader.

Reimplemented in vtkRTXMLPolyDataReader, vtkXMLHyperOctreeReader, vtkXMLImageDataReader, vtkXMLPolyDataReader, vtkXMLRectilinearGridReader, vtkXMLStructuredDataReader, vtkXMLStructuredGridReader, vtkXMLUnstructuredDataReader, and vtkXMLUnstructuredGridReader.

static int vtkXMLDataReader::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkXMLReader.

Reimplemented in vtkRTXMLPolyDataReader, vtkXMLHyperOctreeReader, vtkXMLImageDataReader, vtkXMLPolyDataReader, vtkXMLRectilinearGridReader, vtkXMLStructuredDataReader, vtkXMLStructuredGridReader, vtkXMLUnstructuredDataReader, and vtkXMLUnstructuredGridReader.

virtual int vtkXMLDataReader::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkXMLReader.

Reimplemented in vtkRTXMLPolyDataReader, vtkXMLHyperOctreeReader, vtkXMLImageDataReader, vtkXMLPolyDataReader, vtkXMLRectilinearGridReader, vtkXMLStructuredDataReader, vtkXMLStructuredGridReader, vtkXMLUnstructuredDataReader, and vtkXMLUnstructuredGridReader.

static vtkXMLDataReader* vtkXMLDataReader::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkXMLReader.

Reimplemented in vtkRTXMLPolyDataReader, vtkXMLHyperOctreeReader, vtkXMLImageDataReader, vtkXMLPolyDataReader, vtkXMLRectilinearGridReader, vtkXMLStructuredDataReader, vtkXMLStructuredGridReader, vtkXMLUnstructuredDataReader, and vtkXMLUnstructuredGridReader.

void vtkXMLDataReader::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 vtkXMLReader.

Reimplemented in vtkRTXMLPolyDataReader, vtkXMLHyperOctreeReader, vtkXMLImageDataReader, vtkXMLPolyDataReader, vtkXMLRectilinearGridReader, vtkXMLStructuredDataReader, vtkXMLStructuredGridReader, vtkXMLUnstructuredDataReader, and vtkXMLUnstructuredGridReader.

virtual vtkIdType vtkXMLDataReader::GetNumberOfPoints

(

)

[pure virtual]

Get the number of points in the output.

Implemented in vtkXMLHyperOctreeReader, vtkXMLStructuredDataReader, and vtkXMLUnstructuredDataReader.

virtual vtkIdType vtkXMLDataReader::GetNumberOfCells

(

)

[pure virtual]

Get the number of cells in the output.

Implemented in vtkXMLHyperOctreeReader, vtkXMLStructuredDataReader, and vtkXMLUnstructuredDataReader.

virtual void vtkXMLDataReader::CopyOutputInformation	(	vtkInformation *	outInfo,
		int	port
	)			[virtual]

Reimplemented in vtkXMLImageDataReader, vtkXMLStructuredDataReader, and vtkXMLUnstructuredDataReader.

int vtkXMLDataReader::SetUpdateExtentInfo	(	vtkXMLDataElement *	eDSA,
		vtkInformationVector *	infoVector,
		int	piece,
		int	numPieces
	)			[protected]

virtual void vtkXMLDataReader::CreateXMLParser

(

)

[protected, virtual]

Reimplemented from vtkXMLReader.

virtual void vtkXMLDataReader::DestroyXMLParser

(

)

[protected, virtual]

Reimplemented from vtkXMLReader.

virtual void vtkXMLDataReader::SetupOutputInformation

(

vtkInformation *

outInfo

)

[protected, virtual]

Reimplemented in vtkXMLImageDataReader, and vtkXMLUnstructuredDataReader.

virtual void vtkXMLDataReader::SetupUpdateExtentInformation

(

vtkInformation *

outInfo

)

[protected, virtual]

Reimplemented in vtkXMLImageDataReader.

int vtkXMLDataReader::ReadPrimaryElement

(

vtkXMLDataElement *

ePrimary

)

[protected, virtual]

Reimplemented from vtkXMLReader.

Reimplemented in vtkXMLImageDataReader, and vtkXMLStructuredDataReader.

void vtkXMLDataReader::SetupOutputData

(

)

[protected, virtual]

Reimplemented from vtkXMLReader.

Reimplemented in vtkXMLPolyDataReader, vtkXMLRectilinearGridReader, vtkXMLStructuredGridReader, vtkXMLUnstructuredDataReader, and vtkXMLUnstructuredGridReader.

virtual void vtkXMLDataReader::SetupPieces

(

int

numPieces

)

[protected, virtual]

Reimplemented in vtkXMLPolyDataReader, vtkXMLRectilinearGridReader, vtkXMLStructuredDataReader, vtkXMLStructuredGridReader, vtkXMLUnstructuredDataReader, and vtkXMLUnstructuredGridReader.

virtual void vtkXMLDataReader::DestroyPieces

(

)

[protected, virtual]

Reimplemented in vtkXMLPolyDataReader, vtkXMLRectilinearGridReader, vtkXMLStructuredDataReader, vtkXMLStructuredGridReader, vtkXMLUnstructuredDataReader, and vtkXMLUnstructuredGridReader.

int vtkXMLDataReader::ReadPiece	(	vtkXMLDataElement *	ePiece,
		int	piece
	)			[protected]

virtual int vtkXMLDataReader::ReadPiece

(

vtkXMLDataElement *

ePiece

)

[protected, virtual]

Reimplemented in vtkXMLPolyDataReader, vtkXMLRectilinearGridReader, vtkXMLStructuredDataReader, vtkXMLStructuredGridReader, vtkXMLUnstructuredDataReader, and vtkXMLUnstructuredGridReader.

int vtkXMLDataReader::ReadPieceData

(

int

piece

)

[protected]

virtual int vtkXMLDataReader::ReadPieceData

(

)

[protected, virtual]

Reimplemented in vtkXMLPolyDataReader, vtkXMLRectilinearGridReader, vtkXMLStructuredGridReader, vtkXMLUnstructuredDataReader, and vtkXMLUnstructuredGridReader.

virtual void vtkXMLDataReader::ReadXMLData

(

)

[protected, virtual]

Reimplemented from vtkXMLReader.

Reimplemented in vtkXMLHyperOctreeReader, vtkXMLStructuredDataReader, and vtkXMLUnstructuredDataReader.

virtual int vtkXMLDataReader::ReadArrayForPoints	(	vtkXMLDataElement *	da,
		vtkAbstractArray *	outArray
	)			[protected, virtual]

Reimplemented in vtkXMLHyperOctreeReader, vtkXMLStructuredDataReader, and vtkXMLUnstructuredDataReader.

virtual int vtkXMLDataReader::ReadArrayForCells	(	vtkXMLDataElement *	da,
		vtkAbstractArray *	outArray
	)			[protected, virtual]

Reimplemented in vtkXMLHyperOctreeReader, vtkXMLPolyDataReader, vtkXMLStructuredDataReader, and vtkXMLUnstructuredGridReader.

int vtkXMLDataReader::ReadArrayValues	(	vtkXMLDataElement *	da,
		vtkIdType	arrayIndex,
		vtkAbstractArray *	array,
		vtkIdType	startIndex,
		vtkIdType	numValues
	)			[protected]

static void vtkXMLDataReader::DataProgressCallbackFunction	(	vtkObject *	,
		unsigned	long,
		void *	,
		void *
	)			[static, protected]

virtual void vtkXMLDataReader::DataProgressCallback

(

)

[protected, virtual]

int vtkXMLDataReader::PointDataNeedToReadTimeStep

(

vtkXMLDataElement *

eNested

)

[protected]

int vtkXMLDataReader::CellDataNeedToReadTimeStep

(

vtkXMLDataElement *

eNested

)

[protected]

---

Member Data Documentation

int vtkXMLDataReader::NumberOfPieces [protected]

Definition at line 100 of file vtkXMLDataReader.h.

vtkXMLDataElement** vtkXMLDataReader::PointDataElements [protected]

Definition at line 103 of file vtkXMLDataReader.h.

vtkXMLDataElement** vtkXMLDataReader::CellDataElements [protected]

Definition at line 104 of file vtkXMLDataReader.h.

int vtkXMLDataReader::Piece [protected]

Definition at line 107 of file vtkXMLDataReader.h.

int vtkXMLDataReader::NumberOfPointArrays [protected]

Definition at line 111 of file vtkXMLDataReader.h.

int vtkXMLDataReader::NumberOfCellArrays [protected]

Definition at line 112 of file vtkXMLDataReader.h.

int vtkXMLDataReader::InReadData [protected]

Definition at line 116 of file vtkXMLDataReader.h.

vtkCallbackCommand* vtkXMLDataReader::DataProgressObserver [protected]

Definition at line 119 of file vtkXMLDataReader.h.

int* vtkXMLDataReader::PointDataTimeStep [protected]

Definition at line 123 of file vtkXMLDataReader.h.

unsigned long* vtkXMLDataReader::PointDataOffset [protected]

Definition at line 124 of file vtkXMLDataReader.h.

int* vtkXMLDataReader::CellDataTimeStep [protected]

Definition at line 128 of file vtkXMLDataReader.h.

unsigned long* vtkXMLDataReader::CellDataOffset [protected]

Definition at line 129 of file vtkXMLDataReader.h.

---

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

• dox/IO/vtkXMLDataReader.h