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

Superclass for VTK's XML format readers. More...

#include <vtkXMLReader.h>

Inheritance diagram for vtkXMLReader:
Inheritance graph
[legend]
Collaboration diagram for vtkXMLReader:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkAlgorithm Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkXMLReaderNewInstance () const
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 int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual void SetFileName (const char *)
virtual char * GetFileName ()
virtual void SetReadFromInputString (int)
virtual int GetReadFromInputString ()
virtual void ReadFromInputStringOn ()
virtual void ReadFromInputStringOff ()
void SetInputString (std::string s)
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 intGetTimeStepRange ()
virtual void GetTimeStepRange (int &, int &)
virtual void GetTimeStepRange (int[2])
virtual void SetTimeStepRange (int, int)
void SetTimeStepRange (int[2])
vtkXMLDataParserGetXMLParser ()

Static Public Member Functions

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

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 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 SetupOutputData ()
virtual int ReadPrimaryElement (vtkXMLDataElement *ePrimary)
virtual int ReadVTKFile (vtkXMLDataElement *eVTKFile)
vtkAbstractArrayCreateArray (vtkXMLDataElement *da)
int CreateInformationKey (vtkXMLDataElement *eInfoKey, vtkInformation *info)
virtual int OpenStream ()
virtual void CloseStream ()
virtual int OpenVTKFile ()
virtual void CloseVTKFile ()
virtual int OpenVTKString ()
virtual void CloseVTKString ()
virtual void CreateXMLParser ()
virtual void DestroyXMLParser ()
void SetupCompressor (const char *type)
int CanReadFileVersionString (const char *version)
virtual int CanReadFileWithDataType (const char *dsname)
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 (const float range[2], int curStep, int numSteps)
virtual void SetProgressRange (const float range[2], int curStep, const 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)
void SetNumberOfTimeSteps (int num)
vtkDataObjectGetCurrentOutput ()
vtkInformationGetCurrentOutputInformation ()

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
int ReadFromInputString
std::string InputString
vtkDataArraySelectionPointDataArraySelection
vtkDataArraySelectionCellDataArraySelection
vtkCallbackCommandSelectionObserver
int InformationError
int DataError
float ProgressRange [2]
vtkTimeStamp ReadMTime
int ReadError
int AxesEmpty [3]
int TimeStep
int CurrentTimeStep
int NumberOfTimeSteps
intTimeSteps
int TimeStepRange [2]

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 41 of file vtkXMLReader.h.


Member Typedef Documentation


Constructor & Destructor Documentation

vtkXMLReader::vtkXMLReader ( ) [protected]
vtkXMLReader::~vtkXMLReader ( ) [protected]

Member Function Documentation

static int vtkXMLReader::IsTypeOf ( const char *  name) [static]
virtual int vtkXMLReader::IsA ( const char *  name) [virtual]
virtual vtkObjectBase* vtkXMLReader::NewInstanceInternal ( ) const [protected, virtual]
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 void vtkXMLReader::SetReadFromInputString ( int  ) [virtual]

Enable writing to an InputString instead of the default, a file.

Enable writing to an InputString instead of the default, a file.

virtual void vtkXMLReader::ReadFromInputStringOn ( ) [virtual]

Enable writing to an InputString instead of the default, a file.

virtual void vtkXMLReader::ReadFromInputStringOff ( ) [virtual]

Enable writing to an InputString instead of the default, a file.

void vtkXMLReader::SetInputString ( std::string  s) [inline]

Enable writing to an InputString instead of the default, a file.

Definition at line 58 of file vtkXMLReader.h.

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

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

Get the output as a vtkDataSet pointer.

Get the output as a vtkDataSet pointer.

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

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

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

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 101 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

Which TimeStepRange to read

Returns the internal XML parser. This can be used to access the XML DOM after RequestInformation() was called.

Definition at line 120 of file vtkXMLReader.h.

virtual int vtkXMLReader::ProcessRequest ( vtkInformation request,
vtkInformationVector **  inInfo,
vtkInformationVector outInfo 
) [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::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]

Reimplemented in vtkXMLUniformGridAMRReader.

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

Definition at line 150 of file vtkXMLReader.h.

virtual void vtkXMLReader::SetupOutputData ( ) [protected, virtual]
virtual int vtkXMLReader::ReadPrimaryElement ( vtkXMLDataElement ePrimary) [protected, virtual]
virtual int vtkXMLReader::ReadVTKFile ( vtkXMLDataElement eVTKFile) [protected, virtual]

Reimplemented in vtkXMLUniformGridAMRReader.

int vtkXMLReader::CreateInformationKey ( vtkXMLDataElement eInfoKey,
vtkInformation info 
) [protected]
virtual int vtkXMLReader::OpenStream ( ) [protected, virtual]
virtual void vtkXMLReader::CloseStream ( ) [protected, virtual]
virtual int vtkXMLReader::OpenVTKFile ( ) [protected, virtual]
virtual void vtkXMLReader::CloseVTKFile ( ) [protected, virtual]
virtual int vtkXMLReader::OpenVTKString ( ) [protected, virtual]
virtual void vtkXMLReader::CloseVTKString ( ) [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::CanReadFileWithDataType ( const char *  dsname) [protected, virtual]

This method is used by CanReadFile() to check if the reader can read an XML with the primary element with the given name. Default implementation compares the name with the text returned by this->GetDataSetName().

Reimplemented in vtkXMLUniformGridAMRReader.

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]
char** vtkXMLReader::CreateStringArray ( int  numStrings) [protected]
void vtkXMLReader::DestroyStringArray ( int  numStrings,
char **  strings 
) [protected]
int vtkXMLReader::SetFieldDataInfo ( vtkXMLDataElement eDSA,
int  association,
int  numTuples,
vtkInformationVector *&  infoVector 
) [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 ( const float  range[2],
int  curStep,
int  numSteps 
) [protected, virtual]
virtual void vtkXMLReader::SetProgressRange ( const float  range[2],
int  curStep,
const float fractions 
) [protected, virtual]
virtual void vtkXMLReader::UpdateProgressDiscrete ( float  progress) [protected, virtual]
virtual int vtkXMLReader::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

Reimplemented in vtkXMLGenericDataObjectReader.

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

Definition at line 270 of file vtkXMLReader.h.

virtual int vtkXMLReader::RequestInformation ( 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 228 of file vtkXMLReader.h.

Definition at line 231 of file vtkXMLReader.h.

char* vtkXMLReader::FileName [protected]

Definition at line 234 of file vtkXMLReader.h.

istream* vtkXMLReader::Stream [protected]

Definition at line 237 of file vtkXMLReader.h.

Definition at line 241 of file vtkXMLReader.h.

std::string vtkXMLReader::InputString [protected]

Definition at line 244 of file vtkXMLReader.h.

Definition at line 247 of file vtkXMLReader.h.

Definition at line 248 of file vtkXMLReader.h.

Definition at line 252 of file vtkXMLReader.h.

Definition at line 255 of file vtkXMLReader.h.

Definition at line 258 of file vtkXMLReader.h.

Definition at line 265 of file vtkXMLReader.h.

Definition at line 277 of file vtkXMLReader.h.

Definition at line 280 of file vtkXMLReader.h.

int vtkXMLReader::AxesEmpty[3] [protected]

Definition at line 285 of file vtkXMLReader.h.

Definition at line 288 of file vtkXMLReader.h.

Definition at line 289 of file vtkXMLReader.h.

Definition at line 290 of file vtkXMLReader.h.

Definition at line 294 of file vtkXMLReader.h.

Definition at line 296 of file vtkXMLReader.h.


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