VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkXMLStructuredGridReader Class Reference

Read VTK XML StructuredGrid files. More...

#include <vtkXMLStructuredGridReader.h>

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

Public Types

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

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
vtkStructuredGridGetOutput ()
 
vtkStructuredGridGetOutput (int idx)
 
- Public Member Functions inherited from vtkXMLStructuredDataReader
virtual vtkIdType GetNumberOfPoints ()
 
virtual vtkIdType GetNumberOfCells ()
 
virtual void SetWholeSlices (int)
 
virtual int GetWholeSlices ()
 
virtual void WholeSlicesOn ()
 
virtual void WholeSlicesOff ()
 
virtual void CopyOutputInformation (vtkInformation *outInfo, int port)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkXMLStructuredGridReaderSafeDownCast (vtkObject *o)
 
static vtkXMLStructuredGridReaderNew ()
 
- Static Public Member Functions inherited from vtkXMLStructuredDataReader
static int IsTypeOf (const char *type)
 
static vtkXMLStructuredDataReaderSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkXMLDataReader
static int IsTypeOf (const char *type)
 
static vtkXMLDataReaderSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkXMLReader
static int IsTypeOf (const char *type)
 
static vtkXMLReaderSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObject *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static
vtkInformationInformationVectorKey
INPUT_REQUIRED_FIELDS ()
 
static
vtkInformationStringVectorKey
INPUT_REQUIRED_DATA_TYPE ()
 
static
vtkInformationInformationVectorKey
INPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyPRESERVES_DATASET ()
 
static vtkInformationIntegerKeyPRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKeyPRESERVES_BOUNDS ()
 
static vtkInformationIntegerKeyPRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKeyPRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKeyPRESERVES_RANGES ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkXMLStructuredGridReader ()
 
 ~vtkXMLStructuredGridReader ()
 
const char * GetDataSetName ()
 
void SetOutputExtent (int *extent)
 
void SetupPieces (int numPieces)
 
void DestroyPieces ()
 
void SetupOutputData ()
 
int ReadPiece (vtkXMLDataElement *ePiece)
 
int ReadPieceData ()
 
virtual int FillOutputPortInformation (int, vtkInformation *)
 
- Protected Member Functions inherited from vtkXMLStructuredDataReader
int ReadPrimaryElement (vtkXMLDataElement *ePrimary)
 
void ReadXMLData ()
 
void SetupEmptyOutput ()
 
virtual int ReadArrayForPoints (vtkXMLDataElement *da, vtkAbstractArray *outArray)
 
virtual int ReadArrayForCells (vtkXMLDataElement *da, vtkAbstractArray *outArray)
 
virtual int ReadSubExtent (int *inExtent, int *inDimensions, vtkIdType *inIncrements, int *outExtent, int *outDimensions, vtkIdType *outIncrements, int *subExtent, int *subDimensions, vtkXMLDataElement *da, vtkAbstractArray *array)
 
 vtkXMLStructuredDataReader ()
 
 ~vtkXMLStructuredDataReader ()
 
- 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)
 
int ReadPiece (vtkXMLDataElement *ePiece, int piece)
 
int ReadPieceData (int piece)
 
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 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 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

vtkXMLDataElement ** PointElements
 
- Protected Attributes inherited from vtkXMLStructuredDataReader
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
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkXMLDataReader
static void DataProgressCallbackFunction (vtkObject *, unsigned long, void *, void *)
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 
- Friends inherited from vtkObject

Detailed Description

Read VTK XML StructuredGrid files.

vtkXMLStructuredGridReader reads the VTK XML StructuredGrid file format. One structured grid file can be read to produce one output. Streaming is supported. The standard extension for this reader's file format is "vts". This reader is also used to read a single piece of the parallel file format.

See Also
vtkXMLPStructuredGridReader
Examples:
vtkXMLStructuredGridReader (Examples)
Tests:
vtkXMLStructuredGridReader (Tests)

Definition at line 41 of file vtkXMLStructuredGridReader.h.

Member Typedef Documentation

Definition at line 44 of file vtkXMLStructuredGridReader.h.

Constructor & Destructor Documentation

vtkXMLStructuredGridReader::vtkXMLStructuredGridReader ( )
protected
vtkXMLStructuredGridReader::~vtkXMLStructuredGridReader ( )
protected

Member Function Documentation

virtual const char* vtkXMLStructuredGridReader::GetClassName ( )
virtual

Reimplemented from vtkXMLStructuredDataReader.

static int vtkXMLStructuredGridReader::IsTypeOf ( const char *  type)
static
virtual int vtkXMLStructuredGridReader::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 vtkXMLStructuredDataReader.

static vtkXMLStructuredGridReader* vtkXMLStructuredGridReader::SafeDownCast ( vtkObject o)
static
void vtkXMLStructuredGridReader::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 vtkXMLStructuredDataReader.

static vtkXMLStructuredGridReader* vtkXMLStructuredGridReader::New ( )
static
vtkStructuredGrid* vtkXMLStructuredGridReader::GetOutput ( )

Get the reader's output.

vtkStructuredGrid* vtkXMLStructuredGridReader::GetOutput ( int  idx)

Get the reader's output.

const char* vtkXMLStructuredGridReader::GetDataSetName ( )
protectedvirtual

Implements vtkXMLReader.

void vtkXMLStructuredGridReader::SetOutputExtent ( int *  extent)
protectedvirtual
void vtkXMLStructuredGridReader::SetupPieces ( int  numPieces)
protectedvirtual

Reimplemented from vtkXMLStructuredDataReader.

void vtkXMLStructuredGridReader::DestroyPieces ( )
protectedvirtual

Reimplemented from vtkXMLStructuredDataReader.

void vtkXMLStructuredGridReader::SetupOutputData ( )
protectedvirtual

Reimplemented from vtkXMLDataReader.

int vtkXMLStructuredGridReader::ReadPiece ( vtkXMLDataElement ePiece)
protectedvirtual

Reimplemented from vtkXMLStructuredDataReader.

int vtkXMLStructuredGridReader::ReadPieceData ( )
protectedvirtual

Reimplemented from vtkXMLDataReader.

virtual int vtkXMLStructuredGridReader::FillOutputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

Fill the output port information objects for this algorithm. This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAlgorithm.

Member Data Documentation

vtkXMLDataElement** vtkXMLStructuredGridReader::PointElements
protected

Definition at line 70 of file vtkXMLStructuredGridReader.h.


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