vtkXMLReader Class Reference

#include <vtkXMLReader.h>

Inheritance diagram for vtkXMLReader:

Inheritance graph
[legend]
Collaboration diagram for vtkXMLReader:

Collaboration graph
[legend]

List of all members.


Detailed Description

Superclass for VTK's XML format readers.

vtkXMLReader uses vtkXMLDataParser to parse a VTK XML input file. Concrete subclasses then traverse the parsed file structure and extract data.

Definition at line 37 of file vtkXMLReader.h.


Public Types

typedef vtkAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual int CanReadFile (const char *name)
virtual void CopyOutputInformation (vtkInformation *vtkNotUsed(outInfo), int vtkNotUsed(port))
virtual int GetNumberOfTimeSteps ()
virtual void SetFileName (const char *)
virtual char * GetFileName ()
vtkDataSetGetOutputAsDataSet ()
vtkDataSetGetOutputAsDataSet (int index)
virtual vtkDataArraySelectionGetPointDataArraySelection ()
virtual vtkDataArraySelectionGetCellDataArraySelection ()
int GetNumberOfPointArrays ()
int GetNumberOfCellArrays ()
const char * GetPointArrayName (int index)
const char * GetCellArrayName (int index)
int GetPointArrayStatus (const char *name)
int GetCellArrayStatus (const char *name)
void SetPointArrayStatus (const char *name, int status)
void SetCellArrayStatus (const char *name, int status)
virtual void SetTimeStep (int)
virtual int GetTimeStep ()
virtual int * GetTimeStepRange ()
virtual void GetTimeStepRange (int &, int &)
virtual void GetTimeStepRange (int[2])
virtual void SetTimeStepRange (int, int)
void SetTimeStepRange (int[2])

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkXMLReaderSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkXMLReader ()
 ~vtkXMLReader ()
virtual int ReadXMLInformation ()
virtual void ReadXMLData ()
virtual const char * GetDataSetName ()=0
virtual int CanReadFileVersion (int major, int minor)
virtual void SetupEmptyOutput ()=0
virtual void SetupOutputInformation (vtkInformation *vtkNotUsed(outInfo))
virtual void SetupUpdateExtentInformation (vtkInformation *vtkNotUsed(outInfo))
virtual void SetupOutputData ()
virtual int ReadPrimaryElement (vtkXMLDataElement *ePrimary)
int ReadVTKFile (vtkXMLDataElement *eVTKFile)
vtkAbstractArrayCreateArray (vtkXMLDataElement *da)
virtual int OpenVTKFile ()
virtual void CloseVTKFile ()
virtual void CreateXMLParser ()
virtual void DestroyXMLParser ()
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 ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
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)

Static Protected Member Functions

static void SelectionModifiedCallback (vtkObject *caller, unsigned long eid, void *clientdata, void *calldata)
static int IsTimeStepInArray (int timestep, int *timesteps, int length)

Protected Attributes

vtkXMLDataParserXMLParser
vtkXMLDataElementFieldDataElement
char * FileName
istream * Stream
vtkDataArraySelectionPointDataArraySelection
vtkDataArraySelectionCellDataArraySelection
vtkCallbackCommandSelectionObserver
int InformationError
int DataError
int CurrentOutput
float ProgressRange [2]
vtkTimeStamp ReadMTime
int ReadError
int AxesEmpty [3]
int TimeStep
int CurrentTimeStep
int NumberOfTimeSteps
int * TimeSteps
int TimeStepRange [2]

Member Typedef Documentation


Constructor & Destructor Documentation

vtkXMLReader::vtkXMLReader (  )  [protected]

vtkXMLReader::~vtkXMLReader (  )  [protected]


Member Function Documentation

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

static int vtkXMLReader::IsTypeOf ( const char *  name  )  [static]

virtual int vtkXMLReader::IsA ( const char *  name  )  [virtual]

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

void vtkXMLReader::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

virtual void vtkXMLReader::SetFileName ( const char *   )  [virtual]

Get/Set the name of the input file.

virtual char* vtkXMLReader::GetFileName (  )  [virtual]

Get/Set the name of the input file.

virtual int vtkXMLReader::CanReadFile ( const char *  name  )  [virtual]

Test whether the file with the given name can be read by this reader.

vtkDataSet* vtkXMLReader::GetOutputAsDataSet (  ) 

Get the output as a vtkDataSet pointer.

vtkDataSet* vtkXMLReader::GetOutputAsDataSet ( int  index  ) 

Get the output as a vtkDataSet pointer.

virtual vtkDataArraySelection* vtkXMLReader::GetPointDataArraySelection (  )  [virtual]

Get the data array selection tables used to configure which data arrays are loaded by the reader.

virtual vtkDataArraySelection* vtkXMLReader::GetCellDataArraySelection (  )  [virtual]

Get the data array selection tables used to configure which data arrays are loaded by the reader.

int vtkXMLReader::GetNumberOfPointArrays (  ) 

Get the number of point or cell arrays available in the input.

int vtkXMLReader::GetNumberOfCellArrays (  ) 

Get the number of point or cell arrays available in the input.

const char* vtkXMLReader::GetPointArrayName ( int  index  ) 

Get the name of the point or cell array with the given index in the input.

const char* vtkXMLReader::GetCellArrayName ( int  index  ) 

Get the name of the point or cell array with the given index in the input.

int vtkXMLReader::GetPointArrayStatus ( const char *  name  ) 

Get/Set whether the point or cell array with the given name is to be read.

int vtkXMLReader::GetCellArrayStatus ( const char *  name  ) 

Get/Set whether the point or cell array with the given name is to be read.

void vtkXMLReader::SetPointArrayStatus ( const char *  name,
int  status 
)

Get/Set whether the point or cell array with the given name is to be read.

void vtkXMLReader::SetCellArrayStatus ( const char *  name,
int  status 
)

Get/Set whether the point or cell array with the given name is to be read.

virtual void vtkXMLReader::CopyOutputInformation ( vtkInformation vtkNotUsedoutInfo,
int   vtkNotUsedport 
) [inline, virtual]

Definition at line 89 of file vtkXMLReader.h.

virtual void vtkXMLReader::SetTimeStep ( int   )  [virtual]

Which TimeStep to read.

virtual int vtkXMLReader::GetTimeStep (  )  [virtual]

Which TimeStep to read.

virtual int vtkXMLReader::GetNumberOfTimeSteps (  )  [virtual]

virtual int* vtkXMLReader::GetTimeStepRange (  )  [virtual]

Which TimeStepRange to read

virtual void vtkXMLReader::GetTimeStepRange ( int &  ,
int &   
) [virtual]

Which TimeStepRange to read

virtual void vtkXMLReader::GetTimeStepRange ( int  [2]  )  [virtual]

Which TimeStepRange to read

virtual void vtkXMLReader::SetTimeStepRange ( int  ,
int   
) [virtual]

Which TimeStepRange to read

void vtkXMLReader::SetTimeStepRange ( int  [2]  ) 

Which TimeStepRange to read

virtual int vtkXMLReader::ReadXMLInformation (  )  [protected, virtual]

Reimplemented in vtkXMLPDataReader.

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

virtual const char* vtkXMLReader::GetDataSetName (  )  [protected, pure virtual]

virtual int vtkXMLReader::CanReadFileVersion ( int  major,
int  minor 
) [protected, virtual]

virtual void vtkXMLReader::SetupEmptyOutput (  )  [protected, pure virtual]

virtual void vtkXMLReader::SetupOutputInformation ( vtkInformation vtkNotUsedoutInfo  )  [inline, protected, virtual]

Definition at line 125 of file vtkXMLReader.h.

virtual void vtkXMLReader::SetupUpdateExtentInformation ( vtkInformation vtkNotUsedoutInfo  )  [inline, protected, virtual]

Definition at line 129 of file vtkXMLReader.h.

virtual void vtkXMLReader::SetupOutputData (  )  [protected, virtual]

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

int vtkXMLReader::ReadVTKFile ( vtkXMLDataElement eVTKFile  )  [protected]

vtkAbstractArray* vtkXMLReader::CreateArray ( vtkXMLDataElement da  )  [protected]

virtual int vtkXMLReader::OpenVTKFile (  )  [protected, virtual]

virtual void vtkXMLReader::CloseVTKFile (  )  [protected, virtual]

virtual void vtkXMLReader::CreateXMLParser (  )  [protected, virtual]

Reimplemented in vtkXMLDataReader.

virtual void vtkXMLReader::DestroyXMLParser (  )  [protected, virtual]

Reimplemented in vtkXMLDataReader.

void vtkXMLReader::SetupCompressor ( const char *  type  )  [protected]

int vtkXMLReader::CanReadFileVersionString ( const char *  version  )  [protected]

virtual int vtkXMLReader::GetFileMajorVersion (  )  [protected, virtual]

virtual int vtkXMLReader::GetFileMinorVersion (  )  [protected, virtual]

int vtkXMLReader::IntersectExtents ( int *  extent1,
int *  extent2,
int *  result 
) [protected]

int vtkXMLReader::Min ( int  a,
int  b 
) [protected]

int vtkXMLReader::Max ( int  a,
int  b 
) [protected]

void vtkXMLReader::ComputePointDimensions ( int *  extent,
int *  dimensions 
) [protected]

void vtkXMLReader::ComputePointIncrements ( int *  extent,
vtkIdType increments 
) [protected]

void vtkXMLReader::ComputeCellDimensions ( int *  extent,
int *  dimensions 
) [protected]

void vtkXMLReader::ComputeCellIncrements ( int *  extent,
vtkIdType increments 
) [protected]

vtkIdType vtkXMLReader::GetStartTuple ( int *  extent,
vtkIdType increments,
int  i,
int  j,
int  k 
) [protected]

void vtkXMLReader::ReadAttributeIndices ( vtkXMLDataElement eDSA,
vtkDataSetAttributes dsa 
) [protected]

char** vtkXMLReader::CreateStringArray ( int  numStrings  )  [protected]

void vtkXMLReader::DestroyStringArray ( int  numStrings,
char **  strings 
) [protected]

void vtkXMLReader::SetDataArraySelections ( vtkXMLDataElement eDSA,
vtkDataArraySelection sel 
) [protected]

int vtkXMLReader::SetFieldDataInfo ( vtkXMLDataElement eDSA,
int  association,
int  numTuples,
vtkInformationVector *&  infoVector 
) [protected]

int vtkXMLReader::PointDataArrayIsEnabled ( vtkXMLDataElement ePDA  )  [protected]

int vtkXMLReader::CellDataArrayIsEnabled ( vtkXMLDataElement eCDA  )  [protected]

static void vtkXMLReader::SelectionModifiedCallback ( vtkObject caller,
unsigned long  eid,
void *  clientdata,
void *  calldata 
) [static, protected]

virtual void vtkXMLReader::GetProgressRange ( float *  range  )  [protected, virtual]

virtual void vtkXMLReader::SetProgressRange ( float *  range,
int  curStep,
int  numSteps 
) [protected, virtual]

virtual void vtkXMLReader::SetProgressRange ( float *  range,
int  curStep,
float *  fractions 
) [protected, virtual]

virtual void vtkXMLReader::UpdateProgressDiscrete ( float  progress  )  [protected, virtual]

virtual int vtkXMLReader::ProcessRequest ( vtkInformation request,
vtkInformationVector **  inInfo,
vtkInformationVector outInfo 
) [protected, virtual]

Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. Upstream requests correspond to information flow from the algorithm's outputs to its inputs. Downstream requests correspond to information flow from the algorithm's inputs to its outputs. A downstream request is defined by the contents of the request information object. The input to the request is stored in the input information vector passed to ProcessRequest. The results of an downstream request are stored in the output information vector passed to ProcessRequest. An upstream request is defined by the contents of the request information object. The input to the request is stored in the output information vector passed to ProcessRequest. The results of an upstream request are stored in the input information vector passed to ProcessRequest. It returns the boolean status of the pipeline (false means failure).

Reimplemented from vtkAlgorithm.

virtual int vtkXMLReader::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

virtual int vtkXMLReader::RequestDataObject ( vtkInformation vtkNotUsedrequest,
vtkInformationVector **  vtkNotUsedinputVector,
vtkInformationVector vtkNotUsedoutputVector 
) [inline, protected, virtual]

Definition at line 236 of file vtkXMLReader.h.

virtual int vtkXMLReader::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

Reimplemented in vtkXMLCompositeDataReader.

virtual int vtkXMLReader::RequestUpdateExtentInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

void vtkXMLReader::SetNumberOfTimeSteps ( int  num  )  [protected]

static int vtkXMLReader::IsTimeStepInArray ( int  timestep,
int *  timesteps,
int  length 
) [static, protected]


Member Data Documentation

Definition at line 193 of file vtkXMLReader.h.

Definition at line 196 of file vtkXMLReader.h.

char* vtkXMLReader::FileName [protected]

Definition at line 199 of file vtkXMLReader.h.

istream* vtkXMLReader::Stream [protected]

Definition at line 202 of file vtkXMLReader.h.

Definition at line 205 of file vtkXMLReader.h.

Definition at line 206 of file vtkXMLReader.h.

Definition at line 210 of file vtkXMLReader.h.

Definition at line 213 of file vtkXMLReader.h.

int vtkXMLReader::DataError [protected]

Definition at line 216 of file vtkXMLReader.h.

int vtkXMLReader::CurrentOutput [protected]

Definition at line 220 of file vtkXMLReader.h.

float vtkXMLReader::ProgressRange[2] [protected]

Definition at line 228 of file vtkXMLReader.h.

Definition at line 248 of file vtkXMLReader.h.

int vtkXMLReader::ReadError [protected]

Definition at line 251 of file vtkXMLReader.h.

int vtkXMLReader::AxesEmpty[3] [protected]

Definition at line 256 of file vtkXMLReader.h.

int vtkXMLReader::TimeStep [protected]

Definition at line 259 of file vtkXMLReader.h.

Definition at line 260 of file vtkXMLReader.h.

Definition at line 261 of file vtkXMLReader.h.

int* vtkXMLReader::TimeSteps [protected]

Definition at line 265 of file vtkXMLReader.h.

int vtkXMLReader::TimeStepRange[2] [protected]

Definition at line 267 of file vtkXMLReader.h.


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

Generated on Sat Dec 27 14:01:37 2008 for VTK by  doxygen 1.5.6