VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkXMLUnstructuredDataReader Class Referenceabstract

Superclass for unstructured data XML readers. More...

#include <vtkXMLUnstructuredDataReader.h>

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

Public Types

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)
 
virtual vtkIdType GetNumberOfPoints ()
 
virtual vtkIdType GetNumberOfCells ()
 
void SetupUpdateExtent (int piece, int numberOfPieces, int ghostLevel)
 
virtual void CopyOutputInformation (vtkInformation *outInfo, int port)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static
vtkXMLUnstructuredDataReader
SafeDownCast (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

 vtkXMLUnstructuredDataReader ()
 
 ~vtkXMLUnstructuredDataReader ()
 
vtkPointSetGetOutputAsPointSet ()
 
vtkXMLDataElementFindDataArrayWithName (vtkXMLDataElement *eParent, const char *name)
 
vtkIdTypeArrayConvertToIdTypeArray (vtkDataArray *a)
 
vtkUnsignedCharArrayConvertToUnsignedCharArray (vtkDataArray *a)
 
void ReadXMLData ()
 
virtual void SetupEmptyOutput ()
 
virtual void GetOutputUpdateExtent (int &piece, int &numberOfPieces, int &ghostLevel)=0
 
virtual void SetupOutputTotals ()
 
virtual void SetupNextPiece ()
 
void SetupPieces (int numPieces)
 
void DestroyPieces ()
 
void SetupOutputInformation (vtkInformation *outInfo)
 
void SetupOutputData ()
 
int ReadPiece (vtkXMLDataElement *ePiece)
 
int ReadPieceData ()
 
int ReadCellArray (vtkIdType numberOfCells, vtkIdType totalNumberOfCells, vtkXMLDataElement *eCells, vtkCellArray *outCells)
 
int ReadFaceArray (vtkIdType numberOfCells, vtkXMLDataElement *eCells, vtkIdTypeArray *outFaces, vtkIdTypeArray *outFaceOffsets)
 
virtual int ReadArrayForPoints (vtkXMLDataElement *da, vtkAbstractArray *outArray)
 
virtual vtkIdType GetNumberOfPointsInPiece (int piece)
 
virtual vtkIdType GetNumberOfCellsInPiece (int piece)=0
 
int PointsNeedToReadTimeStep (vtkXMLDataElement *eNested)
 
int CellsNeedToReadTimeStep (vtkXMLDataElement *eNested, int &cellstimestep, unsigned long &cellsoffset)
 
- 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 SetupUpdateExtentInformation (vtkInformation *outInfo)
 
int ReadPrimaryElement (vtkXMLDataElement *ePrimary)
 
int ReadPiece (vtkXMLDataElement *ePiece, int piece)
 
int ReadPieceData (int piece)
 
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)
 
- 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 UpdatePiece
 
int UpdateNumberOfPieces
 
int UpdateGhostLevel
 
int StartPiece
 
int EndPiece
 
vtkIdType TotalNumberOfPoints
 
vtkIdType TotalNumberOfCells
 
vtkIdType StartPoint
 
vtkXMLDataElement ** PointElements
 
vtkIdTypeNumberOfPoints
 
int PointsTimeStep
 
unsigned long PointsOffset
 
- 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

Superclass for unstructured data XML readers.

vtkXMLUnstructuredDataReader provides functionality common to all unstructured data format readers.

See Also
vtkXMLPolyDataReader vtkXMLUnstructuredGridReader

Definition at line 35 of file vtkXMLUnstructuredDataReader.h.

Member Typedef Documentation

Definition at line 38 of file vtkXMLUnstructuredDataReader.h.

Constructor & Destructor Documentation

vtkXMLUnstructuredDataReader::vtkXMLUnstructuredDataReader ( )
protected
vtkXMLUnstructuredDataReader::~vtkXMLUnstructuredDataReader ( )
protected

Member Function Documentation

virtual const char* vtkXMLUnstructuredDataReader::GetClassName ( )
virtual
static int vtkXMLUnstructuredDataReader::IsTypeOf ( const char *  type)
static
virtual int vtkXMLUnstructuredDataReader::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 vtkXMLUnstructuredGridReader, vtkXMLPolyDataReader, and vtkRTXMLPolyDataReader.

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

virtual vtkIdType vtkXMLUnstructuredDataReader::GetNumberOfPoints ( )
virtual

Get the number of points in the output.

Implements vtkXMLDataReader.

virtual vtkIdType vtkXMLUnstructuredDataReader::GetNumberOfCells ( )
virtual

Get the number of cells in the output.

Implements vtkXMLDataReader.

void vtkXMLUnstructuredDataReader::SetupUpdateExtent ( int  piece,
int  numberOfPieces,
int  ghostLevel 
)

Setup the reader as if the given update extent were requested by its output. This can be used after an UpdateInformation to validate GetNumberOfPoints() and GetNumberOfCells() without actually reading data.

virtual void vtkXMLUnstructuredDataReader::CopyOutputInformation ( vtkInformation outInfo,
int  port 
)
virtual

Reimplemented from vtkXMLDataReader.

vtkPointSet* vtkXMLUnstructuredDataReader::GetOutputAsPointSet ( )
protected
vtkXMLDataElement* vtkXMLUnstructuredDataReader::FindDataArrayWithName ( vtkXMLDataElement eParent,
const char *  name 
)
protected
vtkIdTypeArray* vtkXMLUnstructuredDataReader::ConvertToIdTypeArray ( vtkDataArray a)
protected
vtkUnsignedCharArray* vtkXMLUnstructuredDataReader::ConvertToUnsignedCharArray ( vtkDataArray a)
protected
void vtkXMLUnstructuredDataReader::ReadXMLData ( )
protectedvirtual

Reimplemented from vtkXMLDataReader.

virtual void vtkXMLUnstructuredDataReader::SetupEmptyOutput ( )
protectedvirtual

Implements vtkXMLReader.

virtual void vtkXMLUnstructuredDataReader::GetOutputUpdateExtent ( int &  piece,
int &  numberOfPieces,
int &  ghostLevel 
)
protectedpure virtual
virtual void vtkXMLUnstructuredDataReader::SetupOutputTotals ( )
protectedvirtual
virtual void vtkXMLUnstructuredDataReader::SetupNextPiece ( )
protectedvirtual
void vtkXMLUnstructuredDataReader::SetupPieces ( int  numPieces)
protectedvirtual

Reimplemented from vtkXMLDataReader.

Reimplemented in vtkXMLUnstructuredGridReader.

void vtkXMLUnstructuredDataReader::DestroyPieces ( )
protectedvirtual

Reimplemented from vtkXMLDataReader.

Reimplemented in vtkXMLUnstructuredGridReader.

void vtkXMLUnstructuredDataReader::SetupOutputInformation ( vtkInformation outInfo)
protectedvirtual

Reimplemented from vtkXMLDataReader.

void vtkXMLUnstructuredDataReader::SetupOutputData ( )
protectedvirtual

Reimplemented from vtkXMLDataReader.

Reimplemented in vtkXMLUnstructuredGridReader.

int vtkXMLUnstructuredDataReader::ReadPiece ( vtkXMLDataElement ePiece)
protectedvirtual

Reimplemented from vtkXMLDataReader.

Reimplemented in vtkXMLUnstructuredGridReader.

int vtkXMLUnstructuredDataReader::ReadPieceData ( )
protectedvirtual

Reimplemented from vtkXMLDataReader.

Reimplemented in vtkXMLUnstructuredGridReader.

int vtkXMLUnstructuredDataReader::ReadCellArray ( vtkIdType  numberOfCells,
vtkIdType  totalNumberOfCells,
vtkXMLDataElement eCells,
vtkCellArray outCells 
)
protected
int vtkXMLUnstructuredDataReader::ReadFaceArray ( vtkIdType  numberOfCells,
vtkXMLDataElement eCells,
vtkIdTypeArray outFaces,
vtkIdTypeArray outFaceOffsets 
)
protected
virtual int vtkXMLUnstructuredDataReader::ReadArrayForPoints ( vtkXMLDataElement da,
vtkAbstractArray outArray 
)
protectedvirtual

Reimplemented from vtkXMLDataReader.

virtual vtkIdType vtkXMLUnstructuredDataReader::GetNumberOfPointsInPiece ( int  piece)
protectedvirtual
virtual vtkIdType vtkXMLUnstructuredDataReader::GetNumberOfCellsInPiece ( int  piece)
protectedpure virtual
int vtkXMLUnstructuredDataReader::PointsNeedToReadTimeStep ( vtkXMLDataElement eNested)
protected
int vtkXMLUnstructuredDataReader::CellsNeedToReadTimeStep ( vtkXMLDataElement eNested,
int &  cellstimestep,
unsigned long &  cellsoffset 
)
protected

Member Data Documentation

int vtkXMLUnstructuredDataReader::UpdatePiece
protected

Definition at line 101 of file vtkXMLUnstructuredDataReader.h.

int vtkXMLUnstructuredDataReader::UpdateNumberOfPieces
protected

Definition at line 102 of file vtkXMLUnstructuredDataReader.h.

int vtkXMLUnstructuredDataReader::UpdateGhostLevel
protected

Definition at line 103 of file vtkXMLUnstructuredDataReader.h.

int vtkXMLUnstructuredDataReader::StartPiece
protected

Definition at line 106 of file vtkXMLUnstructuredDataReader.h.

int vtkXMLUnstructuredDataReader::EndPiece
protected

Definition at line 107 of file vtkXMLUnstructuredDataReader.h.

vtkIdType vtkXMLUnstructuredDataReader::TotalNumberOfPoints
protected

Definition at line 108 of file vtkXMLUnstructuredDataReader.h.

vtkIdType vtkXMLUnstructuredDataReader::TotalNumberOfCells
protected

Definition at line 109 of file vtkXMLUnstructuredDataReader.h.

vtkIdType vtkXMLUnstructuredDataReader::StartPoint
protected

Definition at line 110 of file vtkXMLUnstructuredDataReader.h.

vtkXMLDataElement** vtkXMLUnstructuredDataReader::PointElements
protected

Definition at line 113 of file vtkXMLUnstructuredDataReader.h.

vtkIdType* vtkXMLUnstructuredDataReader::NumberOfPoints
protected

Definition at line 114 of file vtkXMLUnstructuredDataReader.h.

int vtkXMLUnstructuredDataReader::PointsTimeStep
protected

Definition at line 116 of file vtkXMLUnstructuredDataReader.h.

unsigned long vtkXMLUnstructuredDataReader::PointsOffset
protected

Definition at line 117 of file vtkXMLUnstructuredDataReader.h.


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