vtkXMLStructuredDataReader Class Reference

#include <vtkXMLStructuredDataReader.h>

Inheritance diagram for vtkXMLStructuredDataReader:

[legend]Collaboration diagram for vtkXMLStructuredDataReader:

[legend]List of all members.

---

Detailed Description

Superclass for structured data XML readers.

vtkXMLStructuredDataReader provides functionality common to all structured data format readers.

See also:

vtkXMLImageDataReader vtkXMLStructuredGridReader vtkXMLRectilinearGridReader

Definition at line 32 of file vtkXMLStructuredDataReader.h.

Public Types
typedef vtkXMLDataReader	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkIdType	GetNumberOfPoints ()
virtual void	CopyOutputInformation (vtkInformation *outInfo, int port)
virtual vtkIdType	GetNumberOfCells ()
virtual void	SetWholeSlices (int)
virtual int	GetWholeSlices ()
virtual void	WholeSlicesOn ()
virtual void	WholeSlicesOff ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkXMLStructuredDataReader *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkXMLStructuredDataReader ()
	~vtkXMLStructuredDataReader ()
virtual void	SetOutputExtent (int *extent)=0
int	ReadPrimaryElement (vtkXMLDataElement *ePrimary)
void	ReadXMLData ()
void	SetupEmptyOutput ()
void	SetupPieces (int numPieces)
void	DestroyPieces ()
int	ReadArrayForPoints (vtkXMLDataElement *da, vtkDataArray *outArray)
int	ReadArrayForCells (vtkXMLDataElement *da, vtkDataArray *outArray)
int	ReadPiece (vtkXMLDataElement *ePiece)
int	ReadSubExtent (int *inExtent, int *inDimensions, vtkIdType *inIncrements, int *outExtent, int *outDimensions, vtkIdType *outIncrements, int *subExtent, int *subDimensions, vtkXMLDataElement *da, vtkDataArray *array)
Protected Attributes
int *	PieceExtents
int *	PiecePointDimensions
vtkIdType *	PiecePointIncrements
int *	PieceCellDimensions
vtkIdType *	PieceCellIncrements
int	WholeSlices
int	UpdateExtent [6]
int	PointDimensions [3]
int	CellDimensions [3]
vtkIdType	PointIncrements [3]
vtkIdType	CellIncrements [3]
int	SubExtent [6]
int	SubPointDimensions [3]
int	SubCellDimensions [3]

---

Member Typedef Documentation

typedef vtkXMLDataReader vtkXMLStructuredDataReader::Superclass

Reimplemented from vtkXMLDataReader. Reimplemented in vtkXMLImageDataReader, vtkXMLRectilinearGridReader, and vtkXMLStructuredGridReader. Definition at line 35 of file vtkXMLStructuredDataReader.h.

---

Constructor & Destructor Documentation

vtkXMLStructuredDataReader::vtkXMLStructuredDataReader (   )  [protected]

vtkXMLStructuredDataReader::~vtkXMLStructuredDataReader (   )  [protected]

---

Member Function Documentation

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

Reimplemented from vtkXMLDataReader. Reimplemented in vtkXMLImageDataReader, vtkXMLRectilinearGridReader, and vtkXMLStructuredGridReader.

static int vtkXMLStructuredDataReader::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 vtkXMLDataReader. Reimplemented in vtkXMLImageDataReader, vtkXMLRectilinearGridReader, and vtkXMLStructuredGridReader.

virtual int vtkXMLStructuredDataReader::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 vtkXMLDataReader. Reimplemented in vtkXMLImageDataReader, vtkXMLRectilinearGridReader, and vtkXMLStructuredGridReader.

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

Reimplemented from vtkXMLDataReader. Reimplemented in vtkXMLImageDataReader, vtkXMLRectilinearGridReader, and vtkXMLStructuredGridReader.

void vtkXMLStructuredDataReader::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 vtkXMLDataReader. Reimplemented in vtkXMLImageDataReader, vtkXMLRectilinearGridReader, and vtkXMLStructuredGridReader.

virtual vtkIdType vtkXMLStructuredDataReader::GetNumberOfPoints (   )  [virtual]

Get the number of points in the output. Implements vtkXMLDataReader.

virtual vtkIdType vtkXMLStructuredDataReader::GetNumberOfCells (   )  [virtual]

Get the number of cells in the output. Implements vtkXMLDataReader.

virtual void vtkXMLStructuredDataReader::SetWholeSlices (  int   )  [virtual]

Get/Set whether the reader gets a whole slice from disk when only a rectangle inside it is needed. This mode reads more data than necessary, but prevents many short reads from interacting poorly with the compression and encoding schemes.

virtual int vtkXMLStructuredDataReader::GetWholeSlices (   )  [virtual]

Get the number of cells in the output.

virtual void vtkXMLStructuredDataReader::WholeSlicesOn (   )  [virtual]

Get the number of cells in the output.

virtual void vtkXMLStructuredDataReader::WholeSlicesOff (   )  [virtual]

Get the number of cells in the output.

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

For the specified port, copy the information this reader sets up in SetupOutputInformation to outInfo Reimplemented from vtkXMLDataReader. Reimplemented in vtkXMLImageDataReader.

virtual void vtkXMLStructuredDataReader::SetOutputExtent (  int *  extent  )  [protected, pure virtual]

Implemented in vtkXMLImageDataReader, vtkXMLRectilinearGridReader, and vtkXMLStructuredGridReader.

int vtkXMLStructuredDataReader::ReadPrimaryElement (  vtkXMLDataElement *  ePrimary  )  [protected, virtual]

Reimplemented from vtkXMLDataReader. Reimplemented in vtkXMLImageDataReader.

void vtkXMLStructuredDataReader::ReadXMLData (   )  [protected, virtual]

Reimplemented from vtkXMLDataReader.

void vtkXMLStructuredDataReader::SetupEmptyOutput (   )  [protected, virtual]

Implements vtkXMLReader.

void vtkXMLStructuredDataReader::SetupPieces (  int  numPieces  )  [protected, virtual]

Reimplemented from vtkXMLDataReader. Reimplemented in vtkXMLRectilinearGridReader, and vtkXMLStructuredGridReader.

void vtkXMLStructuredDataReader::DestroyPieces (   )  [protected, virtual]

Reimplemented from vtkXMLDataReader. Reimplemented in vtkXMLRectilinearGridReader, and vtkXMLStructuredGridReader.

int vtkXMLStructuredDataReader::ReadArrayForPoints (  vtkXMLDataElement *  da, vtkDataArray *  outArray )  [protected, virtual]

Reimplemented from vtkXMLDataReader.

int vtkXMLStructuredDataReader::ReadArrayForCells (  vtkXMLDataElement *  da, vtkDataArray *  outArray )  [protected, virtual]

Reimplemented from vtkXMLDataReader.

int vtkXMLStructuredDataReader::ReadPiece (  vtkXMLDataElement *  ePiece  )  [protected, virtual]

Reimplemented from vtkXMLDataReader. Reimplemented in vtkXMLRectilinearGridReader, and vtkXMLStructuredGridReader.

int vtkXMLStructuredDataReader::ReadSubExtent (  int *  inExtent, int *  inDimensions, vtkIdType *  inIncrements, int *  outExtent, int *  outDimensions, vtkIdType *  outIncrements, int *  subExtent, int *  subDimensions, vtkXMLDataElement *  da, vtkDataArray *  array )  [protected]

---

Member Data Documentation

int* vtkXMLStructuredDataReader::PieceExtents [protected]

Definition at line 69 of file vtkXMLStructuredDataReader.h.

int* vtkXMLStructuredDataReader::PiecePointDimensions [protected]

Definition at line 70 of file vtkXMLStructuredDataReader.h.

vtkIdType* vtkXMLStructuredDataReader::PiecePointIncrements [protected]

Definition at line 71 of file vtkXMLStructuredDataReader.h.

int* vtkXMLStructuredDataReader::PieceCellDimensions [protected]

Definition at line 72 of file vtkXMLStructuredDataReader.h.

vtkIdType* vtkXMLStructuredDataReader::PieceCellIncrements [protected]

Definition at line 73 of file vtkXMLStructuredDataReader.h.

int vtkXMLStructuredDataReader::WholeSlices [protected]

Definition at line 76 of file vtkXMLStructuredDataReader.h.

int vtkXMLStructuredDataReader::UpdateExtent[6] [protected]

Definition at line 79 of file vtkXMLStructuredDataReader.h.

int vtkXMLStructuredDataReader::PointDimensions[3] [protected]

Definition at line 80 of file vtkXMLStructuredDataReader.h.

int vtkXMLStructuredDataReader::CellDimensions[3] [protected]

Definition at line 81 of file vtkXMLStructuredDataReader.h.

vtkIdType vtkXMLStructuredDataReader::PointIncrements[3] [protected]

Definition at line 82 of file vtkXMLStructuredDataReader.h.

vtkIdType vtkXMLStructuredDataReader::CellIncrements[3] [protected]

Definition at line 83 of file vtkXMLStructuredDataReader.h.

int vtkXMLStructuredDataReader::SubExtent[6] [protected]

Definition at line 86 of file vtkXMLStructuredDataReader.h.

int vtkXMLStructuredDataReader::SubPointDimensions[3] [protected]

Definition at line 87 of file vtkXMLStructuredDataReader.h.

int vtkXMLStructuredDataReader::SubCellDimensions[3] [protected]

Definition at line 88 of file vtkXMLStructuredDataReader.h.

---

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

• dox/IO/vtkXMLStructuredDataReader.h

---