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

Read any type of vtk data object. More...

#include <vtkXMLGenericDataObjectReader.h>

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

List of all members.

Public Types

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

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
vtkIdType GetNumberOfPoints ()
vtkIdType GetNumberOfCells ()
void SetupEmptyOutput ()
virtual int ReadOutputType (const char *name, bool &parallel)
vtkDataObjectGetOutput ()
vtkDataObjectGetOutput (int idx)
vtkHierarchicalBoxDataSetGetHierarchicalBoxDataSetOutput ()
vtkHyperOctreeGetHyperOctreeOutput ()
vtkImageDataGetImageDataOutput ()
vtkMultiBlockDataSetGetMultiBlockDataSetOutput ()
vtkPolyDataGetPolyDataOutput ()
vtkRectilinearGridGetRectilinearGridOutput ()
vtkStructuredGridGetStructuredGridOutput ()
vtkUnstructuredGridGetUnstructuredGridOutput ()
- Public Member Functions inherited from vtkXMLDataReader
virtual void CopyOutputInformation (vtkInformation *outInfo, int port)
- Public Member Functions inherited from vtkXMLReader
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 ()
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])
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
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)
vtkDataObjectGetInputDataObject (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)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char 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)
vtkCommandGetCommand (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)
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 &os)
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
vtkXMLGenericDataObjectReader
SafeDownCast (vtkObject *o)
static
vtkXMLGenericDataObjectReader
New ()

Protected Member Functions

 vtkXMLGenericDataObjectReader ()
 ~vtkXMLGenericDataObjectReader ()
const char * GetDataSetName ()
virtual int RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestUpdateExtent (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int FillOutputPortInformation (int, vtkInformation *)
- 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 ReadPrimaryElement (vtkXMLDataElement *ePrimary)
void SetupOutputData ()
virtual void SetupPieces (int numPieces)
virtual void DestroyPieces ()
int ReadPiece (vtkXMLDataElement *ePiece, int piece)
virtual int ReadPiece (vtkXMLDataElement *ePiece)
int ReadPieceData (int piece)
virtual int ReadPieceData ()
virtual void ReadXMLData ()
virtual int ReadArrayForPoints (vtkXMLDataElement *da, vtkAbstractArray *outArray)
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 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 RequestDataObject (vtkInformation *vtkNotUsed(request), vtkInformationVector **vtkNotUsed(inputVector), vtkInformationVector *vtkNotUsed(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

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

- Static Protected Member Functions inherited from vtkXMLDataReader
static void DataProgressCallbackFunction (vtkObject *, unsigned long, void *, void *)
- Static Protected Member Functions inherited from vtkXMLReader
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 vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()

Detailed Description

Read any type of vtk data object.

vtkXMLGenericDataObjectReader reads any type of vtk data object encoded in XML format.

See also:
vtkGenericDataObjectReader
Tests:
vtkXMLGenericDataObjectReader (Tests)

Definition at line 42 of file vtkXMLGenericDataObjectReader.h.


Member Typedef Documentation

Reimplemented from vtkXMLDataReader.

Definition at line 45 of file vtkXMLGenericDataObjectReader.h.


Constructor & Destructor Documentation

vtkXMLGenericDataObjectReader::vtkXMLGenericDataObjectReader ( )
protected
vtkXMLGenericDataObjectReader::~vtkXMLGenericDataObjectReader ( )
protected

Member Function Documentation

virtual const char* vtkXMLGenericDataObjectReader::GetClassName ( )
virtual

Reimplemented from vtkXMLDataReader.

static int vtkXMLGenericDataObjectReader::IsTypeOf ( const char *  name)
static

Return 1 if this class type 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.

virtual int vtkXMLGenericDataObjectReader::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.

static vtkXMLGenericDataObjectReader* vtkXMLGenericDataObjectReader::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkXMLDataReader.

void vtkXMLGenericDataObjectReader::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.

static vtkXMLGenericDataObjectReader* vtkXMLGenericDataObjectReader::New ( )
static

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkAlgorithm.

vtkDataObject* vtkXMLGenericDataObjectReader::GetOutput ( )

Get the reader's output.

vtkDataObject* vtkXMLGenericDataObjectReader::GetOutput ( int  idx)

Get the reader's output.

vtkHierarchicalBoxDataSet* vtkXMLGenericDataObjectReader::GetHierarchicalBoxDataSetOutput ( )

Get the output as various concrete types. This method is typically used when you know exactly what type of data is being read. Otherwise, use the general GetOutput() method. If the wrong type is used NULL is returned. (You must also set the filename of the object prior to getting the output.)

vtkHyperOctree* vtkXMLGenericDataObjectReader::GetHyperOctreeOutput ( )

Get the output as various concrete types. This method is typically used when you know exactly what type of data is being read. Otherwise, use the general GetOutput() method. If the wrong type is used NULL is returned. (You must also set the filename of the object prior to getting the output.)

vtkImageData* vtkXMLGenericDataObjectReader::GetImageDataOutput ( )

Get the output as various concrete types. This method is typically used when you know exactly what type of data is being read. Otherwise, use the general GetOutput() method. If the wrong type is used NULL is returned. (You must also set the filename of the object prior to getting the output.)

vtkMultiBlockDataSet* vtkXMLGenericDataObjectReader::GetMultiBlockDataSetOutput ( )

Get the output as various concrete types. This method is typically used when you know exactly what type of data is being read. Otherwise, use the general GetOutput() method. If the wrong type is used NULL is returned. (You must also set the filename of the object prior to getting the output.)

vtkPolyData* vtkXMLGenericDataObjectReader::GetPolyDataOutput ( )

Get the output as various concrete types. This method is typically used when you know exactly what type of data is being read. Otherwise, use the general GetOutput() method. If the wrong type is used NULL is returned. (You must also set the filename of the object prior to getting the output.)

vtkRectilinearGrid* vtkXMLGenericDataObjectReader::GetRectilinearGridOutput ( )

Get the output as various concrete types. This method is typically used when you know exactly what type of data is being read. Otherwise, use the general GetOutput() method. If the wrong type is used NULL is returned. (You must also set the filename of the object prior to getting the output.)

vtkStructuredGrid* vtkXMLGenericDataObjectReader::GetStructuredGridOutput ( )

Get the output as various concrete types. This method is typically used when you know exactly what type of data is being read. Otherwise, use the general GetOutput() method. If the wrong type is used NULL is returned. (You must also set the filename of the object prior to getting the output.)

vtkUnstructuredGrid* vtkXMLGenericDataObjectReader::GetUnstructuredGridOutput ( )

Get the output as various concrete types. This method is typically used when you know exactly what type of data is being read. Otherwise, use the general GetOutput() method. If the wrong type is used NULL is returned. (You must also set the filename of the object prior to getting the output.)

vtkIdType vtkXMLGenericDataObjectReader::GetNumberOfPoints ( )
virtual

Overridden method.

Implements vtkXMLDataReader.

vtkIdType vtkXMLGenericDataObjectReader::GetNumberOfCells ( )
virtual

Overridden method.

Implements vtkXMLDataReader.

void vtkXMLGenericDataObjectReader::SetupEmptyOutput ( )
virtual

Overridden method. Not Used. Delegated.

Implements vtkXMLReader.

virtual int vtkXMLGenericDataObjectReader::ReadOutputType ( const char *  name,
bool &  parallel 
)
virtual

This method can be used to find out the type of output expected without needing to read the whole file.

const char* vtkXMLGenericDataObjectReader::GetDataSetName ( )
protectedvirtual

Overridden method. Not used. Return "vtkDataObject".

Implements vtkXMLReader.

virtual int vtkXMLGenericDataObjectReader::RequestDataObject ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual
virtual int vtkXMLGenericDataObjectReader::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

Reimplemented from vtkXMLReader.

virtual int vtkXMLGenericDataObjectReader::RequestUpdateExtent ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual
virtual int vtkXMLGenericDataObjectReader::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

Reimplemented from vtkXMLReader.

virtual int vtkXMLGenericDataObjectReader::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

vtkXMLReader* vtkXMLGenericDataObjectReader::Reader
protected

Definition at line 104 of file vtkXMLGenericDataObjectReader.h.


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