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

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

#include <vtkXMLReader.h>

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

Public Types

typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkXMLReader * NewInstance () 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)
 
vtkDataSet * GetOutputAsDataSet ()
 
vtkDataSet * GetOutputAsDataSet (int index)
 
virtual vtkDataArraySelection * GetPointDataArraySelection ()
 
virtual vtkDataArraySelection * GetCellDataArraySelection ()
 
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])
 
vtkXMLDataParser * GetXMLParser ()
 
void SetReaderErrorObserver (vtkCommand *)
 
virtual vtkCommand * GetReaderErrorObserver ()
 
void SetParserErrorObserver (vtkCommand *)
 
virtual vtkCommand * GetParserErrorObserver ()
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm * NewInstance () const
 
int HasExecutive ()
 
vtkExecutive * GetExecutive ()
 
virtual void SetExecutive (vtkExecutive *executive)
 
virtual int ModifyRequest (vtkInformation *request, int when)
 
vtkInformation * GetInputPortInformation (int port)
 
vtkInformation * GetOutputPortInformation (int port)
 
int GetNumberOfInputPorts ()
 
int GetNumberOfOutputPorts ()
 
void UpdateProgress (double amount)
 
vtkInformation * GetInputArrayInformation (int idx)
 
void RemoveAllInputs ()
 
vtkDataObject * GetOutputDataObject (int port)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, int idx)
 
virtual void RemoveAllInputConnections (int port)
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutput * GetInputConnection (int port, int index)
 
vtkAlgorithm * GetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithm * GetInputAlgorithm (int port, int index)
 
vtkExecutive * GetInputExecutive (int port, int index)
 
vtkInformation * GetInputInformation (int port, int index)
 
vtkInformation * GetOutputInformation (int port)
 
virtual void UpdateInformation ()
 
virtual void UpdateDataObject ()
 
virtual void PropagateUpdateExtent ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
int SetUpdateExtentToWholeExtent (int port)
 
int SetUpdateExtentToWholeExtent ()
 
void SetUpdateExtent (int port, int extent[6])
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
 
virtual vtkInformation * GetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
virtual void SetAbortExecute (int)
 
virtual int GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual void SetProgress (double)
 
virtual double GetProgress ()
 
void SetProgressText (const char *ptext)
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 
vtkDataObject * GetInputDataObject (int port, int connection)
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutput * GetOutputPort (int index)
 
vtkAlgorithmOutput * GetOutputPort ()
 
vtkAlgorithm * GetInputAlgorithm ()
 
vtkExecutive * GetInputExecutive ()
 
vtkInformation * GetInputInformation ()
 
virtual void Update (int port)
 
virtual void Update ()
 
virtual void SetReleaseDataFlag (int)
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
void SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int extent[6])
 
int * GetUpdateExtent ()
 
int * GetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 
virtual vtkProgressObserver * GetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
vtkObject * NewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommand * GetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkXMLReader * SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm * New ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithm * SafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKey * INPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKey * INPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKey * INPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKey * INPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKey * INPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKey * INPUT_PORT ()
 
static vtkInformationIntegerKey * INPUT_CONNECTION ()
 
static vtkInformationIntegerKey * CAN_PRODUCE_SUB_EXTENT ()
 
static vtkInformationIntegerKey * CAN_HANDLE_PIECE_REQUEST ()
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObject * SafeDownCast (vtkObjectBase *o)
 
static vtkObject * New ()
 
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 vtkObjectBase * New ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () 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)
 
vtkAbstractArray * CreateArray (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)
 
vtkDataObject * GetCurrentOutput ()
 
vtkInformation * GetCurrentOutputInformation ()
 
- 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 vtkExecutive * CreateDefaultExecutive ()
 
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)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformation * GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 
void SetInputDataInternal (int port, vtkDataObject *input)
 
void AddInputDataInternal (int port, vtkDataObject *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 &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

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)
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey * PORT_REQUIREMENTS_FILLED ()
 

Protected Attributes

vtkXMLDataParser * XMLParser
 
vtkXMLDataElement * FieldDataElement
 
char * FileName
 
istream * Stream
 
int ReadFromInputString
 
std::string InputString
 
vtkDataArraySelection * PointDataArraySelection
 
vtkDataArraySelection * CellDataArraySelection
 
vtkCallbackCommand * SelectionObserver
 
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
vtkInformation * Information
 
double Progress
 
char * ProgressText
 
vtkProgressObserver * ProgressObserver
 
unsigned long ErrorCode
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive * DefaultExecutivePrototype
 

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

Member Typedef Documentation

typedef vtkAlgorithm vtkXMLReader::Superclass

Definition at line 45 of file vtkXMLReader.h.

Constructor & Destructor Documentation

vtkXMLReader::vtkXMLReader ( )
protected
vtkXMLReader::~vtkXMLReader ( )
protected

Member Function Documentation

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

Reimplemented in vtkPhyloXMLTreeReader, vtkXMLUniformGridAMRReader, vtkXMLHyperOctreeReader, vtkXMLGenericDataObjectReader, vtkXMLUnstructuredGridReader, vtkXMLHierarchicalBoxDataReader, vtkXMLImageDataReader, vtkXMLPolyDataReader, vtkXMLRectilinearGridReader, vtkXMLStructuredGridReader, vtkXMLCompositeDataReader, vtkXMLDataReader, vtkXMLMultiBlockDataReader, vtkXMLPImageDataReader, vtkXMLPRectilinearGridReader, vtkXMLPStructuredGridReader, vtkXMLPUnstructuredGridReader, vtkXMLHierarchicalDataReader, vtkXMLPDataReader, vtkXMLPPolyDataReader, vtkXMLUnstructuredDataReader, vtkXMLPStructuredDataReader, vtkXMLPUnstructuredDataReader, vtkXMLStructuredDataReader, vtkRTXMLPolyDataReader, and vtkXMLMultiGroupDataReader.

static vtkXMLReader* vtkXMLReader::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkXMLReader::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkAlgorithm.

Reimplemented in vtkPhyloXMLTreeReader, vtkXMLUniformGridAMRReader, vtkXMLHyperOctreeReader, vtkXMLGenericDataObjectReader, vtkXMLUnstructuredGridReader, vtkXMLHierarchicalBoxDataReader, vtkXMLImageDataReader, vtkXMLPolyDataReader, vtkXMLRectilinearGridReader, vtkXMLStructuredGridReader, vtkXMLCompositeDataReader, vtkXMLDataReader, vtkXMLMultiBlockDataReader, vtkXMLPImageDataReader, vtkXMLPRectilinearGridReader, vtkXMLPStructuredGridReader, vtkXMLPUnstructuredGridReader, vtkXMLHierarchicalDataReader, vtkXMLPDataReader, vtkXMLPPolyDataReader, vtkXMLUnstructuredDataReader, vtkXMLPStructuredDataReader, vtkXMLPUnstructuredDataReader, vtkXMLStructuredDataReader, vtkRTXMLPolyDataReader, and vtkXMLMultiGroupDataReader.

vtkXMLReader* vtkXMLReader::NewInstance ( ) const
void vtkXMLReader::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 vtkAlgorithm.

Reimplemented in vtkXMLUniformGridAMRReader, vtkXMLUnstructuredGridReader, vtkXMLRectilinearGridReader, vtkXMLStructuredGridReader, vtkXMLUnstructuredDataReader, and vtkXMLStructuredDataReader.

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.

virtual int vtkXMLReader::GetReadFromInputString ( )
virtual

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

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

Test whether the file (type) with the given name can be read by this reader. If the file has a newer version than the reader, we still say we can read the file type and we fail later, when we try to read the file. This enables clients (ParaView) to distinguish between failures when we need to look for another reader and failures when we don't.

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 
)
inlinevirtual

Definition at line 106 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

vtkXMLDataParser* vtkXMLReader::GetXMLParser ( )
inline

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

Definition at line 125 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.

void vtkXMLReader::SetReaderErrorObserver ( vtkCommand *  )

Set/get the ErrorObserver for the internal reader This is useful for applications that want to catch error messages.

virtual vtkCommand* vtkXMLReader::GetReaderErrorObserver ( )
virtual

Set/get the ErrorObserver for the internal reader This is useful for applications that want to catch error messages.

void vtkXMLReader::SetParserErrorObserver ( vtkCommand *  )

Set/get the ErrorObserver for the internal xml parser This is useful for applications that want to catch error messages.

virtual vtkCommand* vtkXMLReader::GetParserErrorObserver ( )
virtual

Set/get the ErrorObserver for the internal xml parser This is useful for applications that want to catch error messages.

virtual int vtkXMLReader::ReadXMLInformation ( )
protectedvirtual

Reimplemented in vtkXMLPDataReader.

virtual void vtkXMLReader::ReadXMLData ( )
protectedvirtual

Reimplemented in vtkXMLHyperOctreeReader, vtkXMLDataReader, vtkXMLPUnstructuredDataReader, vtkXMLUnstructuredDataReader, vtkXMLStructuredDataReader, vtkPhyloXMLTreeReader, vtkXMLCompositeDataReader, and vtkXMLPStructuredDataReader.

virtual const char* vtkXMLReader::GetDataSetName ( )
protectedpure virtual

Implemented in vtkPhyloXMLTreeReader, vtkXMLUniformGridAMRReader, vtkXMLGenericDataObjectReader, vtkXMLImageDataReader, vtkXMLPolyDataReader, vtkXMLPImageDataReader, vtkXMLMultiBlockDataReader, vtkXMLHyperOctreeReader, vtkXMLUnstructuredGridReader, vtkXMLPRectilinearGridReader, vtkXMLPStructuredGridReader, vtkXMLRectilinearGridReader, vtkXMLStructuredGridReader, vtkXMLCompositeDataReader, vtkXMLPUnstructuredGridReader, vtkXMLPPolyDataReader, vtkXMLHierarchicalDataReader, and vtkXMLMultiGroupDataReader.

virtual int vtkXMLReader::CanReadFileVersion ( int  major,
int  minor 
)
protectedvirtual
virtual void vtkXMLReader::SetupEmptyOutput ( )
protectedpure virtual

Implemented in vtkPhyloXMLTreeReader, vtkXMLStructuredDataReader, vtkXMLGenericDataObjectReader, vtkXMLUnstructuredDataReader, vtkXMLCompositeDataReader, vtkXMLPImageDataReader, vtkXMLHyperOctreeReader, vtkXMLPUnstructuredDataReader, vtkXMLPRectilinearGridReader, and vtkXMLPStructuredGridReader.

virtual void vtkXMLReader::SetupOutputInformation ( vtkInformation *  vtkNotUsedoutInfo)
inlineprotectedvirtual

Definition at line 169 of file vtkXMLReader.h.

virtual void vtkXMLReader::SetupOutputData ( )
protectedvirtual

Reimplemented in vtkXMLUnstructuredDataReader, vtkXMLPolyDataReader, vtkXMLPUnstructuredDataReader, vtkXMLDataReader, vtkXMLUnstructuredGridReader, vtkXMLRectilinearGridReader, vtkXMLStructuredGridReader, vtkXMLPRectilinearGridReader, vtkXMLPStructuredGridReader, vtkXMLPDataReader, vtkXMLPPolyDataReader, vtkXMLPStructuredDataReader, and vtkXMLPUnstructuredGridReader.

virtual int vtkXMLReader::ReadPrimaryElement ( vtkXMLDataElement *  ePrimary)
protectedvirtual

Reimplemented in vtkXMLUniformGridAMRReader, vtkXMLPUnstructuredDataReader, vtkXMLImageDataReader, vtkXMLPImageDataReader, vtkXMLDataReader, vtkXMLStructuredDataReader, vtkXMLCompositeDataReader, vtkXMLPRectilinearGridReader, vtkXMLPStructuredGridReader, vtkXMLPDataReader, and vtkXMLPStructuredDataReader.

virtual int vtkXMLReader::ReadVTKFile ( vtkXMLDataElement *  eVTKFile)
protectedvirtual

Reimplemented in vtkXMLUniformGridAMRReader.

vtkAbstractArray* vtkXMLReader::CreateArray ( vtkXMLDataElement *  da)
protected
int vtkXMLReader::CreateInformationKey ( vtkXMLDataElement *  eInfoKey,
vtkInformation *  info 
)
protected
virtual int vtkXMLReader::OpenStream ( )
protectedvirtual
virtual void vtkXMLReader::CloseStream ( )
protectedvirtual
virtual int vtkXMLReader::OpenVTKFile ( )
protectedvirtual
virtual void vtkXMLReader::CloseVTKFile ( )
protectedvirtual
virtual int vtkXMLReader::OpenVTKString ( )
protectedvirtual
virtual void vtkXMLReader::CloseVTKString ( )
protectedvirtual
virtual void vtkXMLReader::CreateXMLParser ( )
protectedvirtual

Reimplemented in vtkXMLDataReader.

virtual void vtkXMLReader::DestroyXMLParser ( )
protectedvirtual

Reimplemented in vtkXMLDataReader.

void vtkXMLReader::SetupCompressor ( const char *  type)
protected
int vtkXMLReader::CanReadFileVersionString ( const char *  version)
protected
virtual int vtkXMLReader::CanReadFileWithDataType ( const char *  dsname)
protectedvirtual

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 ( )
protectedvirtual
virtual int vtkXMLReader::GetFileMinorVersion ( )
protectedvirtual
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 
)
staticprotected
virtual void vtkXMLReader::GetProgressRange ( float *  range)
protectedvirtual
virtual void vtkXMLReader::SetProgressRange ( const float  range[2],
int  curStep,
int  numSteps 
)
protectedvirtual
virtual void vtkXMLReader::SetProgressRange ( const float  range[2],
int  curStep,
const float *  fractions 
)
protectedvirtual
virtual void vtkXMLReader::UpdateProgressDiscrete ( float  progress)
protectedvirtual
virtual int vtkXMLReader::RequestData ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

Reimplemented in vtkXMLGenericDataObjectReader.

virtual int vtkXMLReader::RequestDataObject ( vtkInformation *  vtkNotUsedrequest,
vtkInformationVector **  vtkNotUsedinputVector,
vtkInformationVector *  vtkNotUsedoutputVector 
)
inlineprotectedvirtual

Definition at line 289 of file vtkXMLReader.h.

virtual int vtkXMLReader::RequestInformation ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

Reimplemented in vtkXMLGenericDataObjectReader, vtkXMLUniformGridAMRReader, vtkXMLPStructuredDataReader, vtkXMLCompositeDataReader, vtkXMLMultiBlockDataReader, and vtkXMLPUnstructuredDataReader.

void vtkXMLReader::SetNumberOfTimeSteps ( int  num)
protected
static int vtkXMLReader::IsTimeStepInArray ( int  timestep,
int *  timesteps,
int  length 
)
staticprotected
vtkDataObject* vtkXMLReader::GetCurrentOutput ( )
protected
vtkInformation* vtkXMLReader::GetCurrentOutputInformation ( )
protected

Member Data Documentation

vtkXMLDataParser* vtkXMLReader::XMLParser
protected

Definition at line 247 of file vtkXMLReader.h.

vtkXMLDataElement* vtkXMLReader::FieldDataElement
protected

Definition at line 250 of file vtkXMLReader.h.

char* vtkXMLReader::FileName
protected

Definition at line 253 of file vtkXMLReader.h.

istream* vtkXMLReader::Stream
protected

Definition at line 256 of file vtkXMLReader.h.

int vtkXMLReader::ReadFromInputString
protected

Definition at line 260 of file vtkXMLReader.h.

std::string vtkXMLReader::InputString
protected

Definition at line 263 of file vtkXMLReader.h.

vtkDataArraySelection* vtkXMLReader::PointDataArraySelection
protected

Definition at line 266 of file vtkXMLReader.h.

vtkDataArraySelection* vtkXMLReader::CellDataArraySelection
protected

Definition at line 267 of file vtkXMLReader.h.

vtkCallbackCommand* vtkXMLReader::SelectionObserver
protected

Definition at line 271 of file vtkXMLReader.h.

int vtkXMLReader::InformationError
protected

Definition at line 274 of file vtkXMLReader.h.

int vtkXMLReader::DataError
protected

Definition at line 277 of file vtkXMLReader.h.

float vtkXMLReader::ProgressRange[2]
protected

Definition at line 284 of file vtkXMLReader.h.

vtkTimeStamp vtkXMLReader::ReadMTime
protected

Definition at line 296 of file vtkXMLReader.h.

int vtkXMLReader::ReadError
protected

Definition at line 299 of file vtkXMLReader.h.

int vtkXMLReader::AxesEmpty[3]
protected

Definition at line 304 of file vtkXMLReader.h.

int vtkXMLReader::TimeStep
protected

Definition at line 307 of file vtkXMLReader.h.

int vtkXMLReader::CurrentTimeStep
protected

Definition at line 308 of file vtkXMLReader.h.

int vtkXMLReader::NumberOfTimeSteps
protected

Definition at line 309 of file vtkXMLReader.h.

int* vtkXMLReader::TimeSteps
protected

Definition at line 313 of file vtkXMLReader.h.

int vtkXMLReader::TimeStepRange[2]
protected

Definition at line 315 of file vtkXMLReader.h.

The documentation for this class was generated from the following file:
Generated on Wed Dec 16 2015 17:21:39 for VTK by   doxygen 1.8.9.1