VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkXMLStructuredDataReader Class Reference

Superclass for structured data XML readers. More...

#include <vtkXMLStructuredDataReader.h>

Inheritance diagram for vtkXMLStructuredDataReader:
[legend]
Collaboration diagram for vtkXMLStructuredDataReader:
[legend]

List of all members.

Public Types

typedef vtkXMLDataReader Superclass
- Public Types inherited from vtkXMLDataReader
- Public Types inherited from vtkXMLReader
- Public Types inherited from vtkAlgorithm
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual vtkIdType GetNumberOfPoints ()
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 vtkXMLStructuredDataReaderSafeDownCast (vtkObject *o)

Protected Member Functions

virtual void SetOutputExtent (int *extent)=0
int ReadPrimaryElement (vtkXMLDataElement *ePrimary)
void ReadXMLData ()
void SetupEmptyOutput ()
void SetupPieces (int numPieces)
void DestroyPieces ()
virtual int ReadArrayForPoints (vtkXMLDataElement *da, vtkAbstractArray *outArray)
virtual int ReadArrayForCells (vtkXMLDataElement *da, vtkAbstractArray *outArray)
int ReadPiece (vtkXMLDataElement *ePiece)
virtual int ReadSubExtent (int *inExtent, int *inDimensions, vtkIdType *inIncrements, int *outExtent, int *outDimensions, vtkIdType *outIncrements, int *subExtent, int *subDimensions, vtkXMLDataElement *da, vtkAbstractArray *array)
- Protected Member Functions inherited from vtkXMLDataReader
 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)
void SetupOutputData ()
int ReadPiece (vtkXMLDataElement *ePiece, int piece)
int ReadPieceData (int piece)
virtual int ReadPieceData ()
int ReadArrayValues (vtkXMLDataElement *da, vtkIdType arrayIndex, vtkAbstractArray *array, vtkIdType startIndex, vtkIdType numValues)
virtual void DataProgressCallback ()
int PointDataNeedToReadTimeStep (vtkXMLDataElement *eNested)
int CellDataNeedToReadTimeStep (vtkXMLDataElement *eNested)
- Protected Member Functions inherited from vtkXMLReader
 vtkXMLReader ()
 ~vtkXMLReader ()
virtual int ReadXMLInformation ()
virtual const char * GetDataSetName ()=0
virtual int CanReadFileVersion (int major, int minor)
virtual void SetupOutputInformation (vtkInformation *vtkNotUsed(outInfo))
virtual void SetupUpdateExtentInformation (vtkInformation *vtkNotUsed(outInfo))
int ReadVTKFile (vtkXMLDataElement *eVTKFile)
vtkAbstractArrayCreateArray (vtkXMLDataElement *da)
int CreateInformationKey (vtkXMLDataElement *eInfoKey, vtkInformation *info)
virtual int OpenVTKFile ()
virtual void CloseVTKFile ()
void SetupCompressor (const char *type)
int CanReadFileVersionString (const char *version)
virtual int GetFileMajorVersion ()
virtual int GetFileMinorVersion ()
int IntersectExtents (int *extent1, int *extent2, int *result)
int Min (int a, int b)
int Max (int a, int b)
void ComputePointDimensions (int *extent, int *dimensions)
void ComputePointIncrements (int *extent, vtkIdType *increments)
void ComputeCellDimensions (int *extent, int *dimensions)
void ComputeCellIncrements (int *extent, vtkIdType *increments)
vtkIdType GetStartTuple (int *extent, vtkIdType *increments, int i, int j, int k)
void ReadAttributeIndices (vtkXMLDataElement *eDSA, vtkDataSetAttributes *dsa)
char ** CreateStringArray (int numStrings)
void DestroyStringArray (int numStrings, char **strings)
void SetDataArraySelections (vtkXMLDataElement *eDSA, vtkDataArraySelection *sel)
int SetFieldDataInfo (vtkXMLDataElement *eDSA, int association, int numTuples, vtkInformationVector *(&infoVector))
int PointDataArrayIsEnabled (vtkXMLDataElement *ePDA)
int CellDataArrayIsEnabled (vtkXMLDataElement *eCDA)
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 UpdateProgressDiscrete (float progress)
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int RequestDataObject (vtkInformation *vtkNotUsed(request), vtkInformationVector **vtkNotUsed(inputVector), vtkInformationVector *vtkNotUsed(outputVector))
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int RequestUpdateExtentInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
void SetNumberOfTimeSteps (int num)
vtkDataObjectGetCurrentOutput ()
vtkInformationGetCurrentOutputInformation ()
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual int FillInputPortInformation (int port, vtkInformation *info)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

int * PieceExtents
int * PiecePointDimensions
vtkIdTypePiecePointIncrements
int * PieceCellDimensions
vtkIdTypePieceCellIncrements
int WholeSlices
int UpdateExtent [6]
int PointDimensions [3]
int CellDimensions [3]
vtkIdType PointIncrements [3]
vtkIdType CellIncrements [3]
int WholeExtent [6]
int SubExtent [6]
int SubPointDimensions [3]
int SubCellDimensions [3]
- Protected Attributes inherited from vtkXMLDataReader
int NumberOfPieces
vtkXMLDataElement ** PointDataElements
vtkXMLDataElement ** CellDataElements
int Piece
int NumberOfPointArrays
int NumberOfCellArrays
int InReadData
vtkCallbackCommandDataProgressObserver
int * PointDataTimeStep
unsigned long * PointDataOffset
int * CellDataTimeStep
unsigned long * CellDataOffset
- Protected Attributes inherited from vtkXMLReader
vtkXMLDataParserXMLParser
vtkXMLDataElementFieldDataElement
char * FileName
istream * Stream
vtkDataArraySelectionPointDataArraySelection
vtkDataArraySelectionCellDataArraySelection
vtkCallbackCommandSelectionObserver
int InformationError
int DataError
float ProgressRange [2]
vtkTimeStamp ReadMTime
int ReadError
int AxesEmpty [3]
int TimeStep
int CurrentTimeStep
int NumberOfTimeSteps
int * TimeSteps
int TimeStepRange [2]
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
double Progress
char * ProgressText
unsigned long ErrorCode
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers
virtual void CopyOutputInformation (vtkInformation *outInfo, int port)
 vtkXMLStructuredDataReader ()
 ~vtkXMLStructuredDataReader ()

Additional Inherited Members

- Static Protected Member Functions inherited from vtkXMLDataReader
static void DataProgressCallbackFunction (vtkObject *, unsigned long, void *, void *)
- Static Protected Member Functions inherited from vtkXMLReader
static void SelectionModifiedCallback (vtkObject *caller, unsigned long eid, void *clientdata, void *calldata)
static int IsTimeStepInArray (int timestep, int *timesteps, int length)
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()

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.


Member Typedef Documentation


Constructor & Destructor Documentation

vtkXMLStructuredDataReader::vtkXMLStructuredDataReader ( )
protected

For the specified port, copy the information this reader sets up in SetupOutputInformation to outInfo

vtkXMLStructuredDataReader::~vtkXMLStructuredDataReader ( )
protected

For the specified port, copy the information this reader sets up in SetupOutputInformation to outInfo


Member Function Documentation

virtual const char* vtkXMLStructuredDataReader::GetClassName ( )
virtual
static int vtkXMLStructuredDataReader::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkXMLDataReader.

Reimplemented in vtkXMLImageDataReader, vtkXMLRectilinearGridReader, and vtkXMLStructuredGridReader.

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

Reimplemented from vtkXMLDataReader.

Reimplemented in vtkXMLImageDataReader, vtkXMLRectilinearGridReader, and vtkXMLStructuredGridReader.

static vtkXMLStructuredDataReader* vtkXMLStructuredDataReader::SafeDownCast ( vtkObject o)
static
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/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 void vtkXMLStructuredDataReader::WholeSlicesOn ( )
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 void vtkXMLStructuredDataReader::WholeSlicesOff ( )
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 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)
protectedpure virtual
int vtkXMLStructuredDataReader::ReadPrimaryElement ( vtkXMLDataElement ePrimary)
protectedvirtual

Reimplemented from vtkXMLDataReader.

Reimplemented in vtkXMLImageDataReader.

void vtkXMLStructuredDataReader::ReadXMLData ( )
protectedvirtual

Reimplemented from vtkXMLDataReader.

void vtkXMLStructuredDataReader::SetupEmptyOutput ( )
protectedvirtual

Implements vtkXMLReader.

void vtkXMLStructuredDataReader::SetupPieces ( int  numPieces)
protectedvirtual

Reimplemented from vtkXMLDataReader.

Reimplemented in vtkXMLRectilinearGridReader, and vtkXMLStructuredGridReader.

void vtkXMLStructuredDataReader::DestroyPieces ( )
protectedvirtual

Reimplemented from vtkXMLDataReader.

Reimplemented in vtkXMLRectilinearGridReader, and vtkXMLStructuredGridReader.

virtual int vtkXMLStructuredDataReader::ReadArrayForPoints ( vtkXMLDataElement da,
vtkAbstractArray outArray 
)
protectedvirtual

Reimplemented from vtkXMLDataReader.

virtual int vtkXMLStructuredDataReader::ReadArrayForCells ( vtkXMLDataElement da,
vtkAbstractArray outArray 
)
protectedvirtual

Reimplemented from vtkXMLDataReader.

int vtkXMLStructuredDataReader::ReadPiece ( vtkXMLDataElement ePiece)
protectedvirtual

Reimplemented from vtkXMLDataReader.

Reimplemented in vtkXMLStructuredGridReader, and vtkXMLRectilinearGridReader.

virtual int vtkXMLStructuredDataReader::ReadSubExtent ( int *  inExtent,
int *  inDimensions,
vtkIdType inIncrements,
int *  outExtent,
int *  outDimensions,
vtkIdType outIncrements,
int *  subExtent,
int *  subDimensions,
vtkXMLDataElement da,
vtkAbstractArray array 
)
protectedvirtual

Member Data Documentation

int* vtkXMLStructuredDataReader::PieceExtents
protected

Definition at line 71 of file vtkXMLStructuredDataReader.h.

int* vtkXMLStructuredDataReader::PiecePointDimensions
protected

Definition at line 72 of file vtkXMLStructuredDataReader.h.

vtkIdType* vtkXMLStructuredDataReader::PiecePointIncrements
protected

Definition at line 73 of file vtkXMLStructuredDataReader.h.

int* vtkXMLStructuredDataReader::PieceCellDimensions
protected

Definition at line 74 of file vtkXMLStructuredDataReader.h.

vtkIdType* vtkXMLStructuredDataReader::PieceCellIncrements
protected

Definition at line 75 of file vtkXMLStructuredDataReader.h.

int vtkXMLStructuredDataReader::WholeSlices
protected

Definition at line 78 of file vtkXMLStructuredDataReader.h.

int vtkXMLStructuredDataReader::UpdateExtent[6]
protected

Definition at line 81 of file vtkXMLStructuredDataReader.h.

int vtkXMLStructuredDataReader::PointDimensions[3]
protected

Definition at line 82 of file vtkXMLStructuredDataReader.h.

int vtkXMLStructuredDataReader::CellDimensions[3]
protected

Definition at line 83 of file vtkXMLStructuredDataReader.h.

vtkIdType vtkXMLStructuredDataReader::PointIncrements[3]
protected

Definition at line 84 of file vtkXMLStructuredDataReader.h.

vtkIdType vtkXMLStructuredDataReader::CellIncrements[3]
protected

Definition at line 85 of file vtkXMLStructuredDataReader.h.

int vtkXMLStructuredDataReader::WholeExtent[6]
protected

Definition at line 87 of file vtkXMLStructuredDataReader.h.

int vtkXMLStructuredDataReader::SubExtent[6]
protected

Definition at line 90 of file vtkXMLStructuredDataReader.h.

int vtkXMLStructuredDataReader::SubPointDimensions[3]
protected

Definition at line 91 of file vtkXMLStructuredDataReader.h.

int vtkXMLStructuredDataReader::SubCellDimensions[3]
protected

Definition at line 92 of file vtkXMLStructuredDataReader.h.


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