VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkGenericDataObjectReader Class Reference

class to read any type of vtk data object More...

#include <vtkGenericDataObjectReader.h>

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

Public Types

typedef vtkDataReader Superclass
- Public Types inherited from vtkDataReader
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 int ReadOutputType ()
vtkDataObjectGetOutput ()
vtkDataObjectGetOutput (int idx)
vtkGraphGetGraphOutput ()
vtkPolyDataGetPolyDataOutput ()
vtkRectilinearGridGetRectilinearGridOutput ()
vtkStructuredGridGetStructuredGridOutput ()
vtkStructuredPointsGetStructuredPointsOutput ()
vtkTableGetTableOutput ()
vtkTreeGetTreeOutput ()
vtkUnstructuredGridGetUnstructuredGridOutput ()
- Public Member Functions inherited from vtkDataReader
int OpenVTKFile ()
int ReadHeader ()
int ReadCellData (vtkDataSet *ds, int numCells)
int ReadPointData (vtkDataSet *ds, int numPts)
int ReadPoints (vtkPointSet *ps, int numPts)
int ReadPoints (vtkGraph *g, int numPts)
int ReadVertexData (vtkGraph *g, int numVertices)
int ReadEdgeData (vtkGraph *g, int numEdges)
int ReadRowData (vtkTable *t, int numEdges)
int ReadCells (int size, int *data)
int ReadCells (int size, int *data, int skip1, int read2, int skip3)
int ReadCoordinates (vtkRectilinearGrid *rg, int axes, int numCoords)
void CloseVTKFile ()
int ReadLine (char result[256])
int ReadString (char result[256])
char * LowerCase (char *str, const size_t len=256)
virtual int ReadMetaData (vtkInformation *)
virtual void SetFileName (const char *)
virtual char * GetFileName ()
int IsFileValid (const char *dstype)
int IsFileStructuredPoints ()
int IsFilePolyData ()
int IsFileStructuredGrid ()
int IsFileUnstructuredGrid ()
int IsFileRectilinearGrid ()
void SetInputString (const char *in)
virtual char * GetInputString ()
void SetInputString (const char *in, int len)
virtual int GetInputStringLength ()
void SetBinaryInputString (const char *, int len)
virtual void SetInputArray (vtkCharArray *)
virtual vtkCharArrayGetInputArray ()
virtual char * GetHeader ()
virtual void SetReadFromInputString (int)
virtual int GetReadFromInputString ()
virtual void ReadFromInputStringOn ()
virtual void ReadFromInputStringOff ()
virtual int GetFileType ()
int GetNumberOfScalarsInFile ()
int GetNumberOfVectorsInFile ()
int GetNumberOfTensorsInFile ()
int GetNumberOfNormalsInFile ()
int GetNumberOfTCoordsInFile ()
int GetNumberOfFieldDataInFile ()
const char * GetScalarsNameInFile (int i)
const char * GetVectorsNameInFile (int i)
const char * GetTensorsNameInFile (int i)
const char * GetNormalsNameInFile (int i)
const char * GetTCoordsNameInFile (int i)
const char * GetFieldDataNameInFile (int i)
virtual void SetScalarsName (const char *)
virtual char * GetScalarsName ()
virtual void SetVectorsName (const char *)
virtual char * GetVectorsName ()
virtual void SetTensorsName (const char *)
virtual char * GetTensorsName ()
virtual void SetNormalsName (const char *)
virtual char * GetNormalsName ()
virtual void SetTCoordsName (const char *)
virtual char * GetTCoordsName ()
virtual void SetLookupTableName (const char *)
virtual char * GetLookupTableName ()
virtual void SetFieldDataName (const char *)
virtual char * GetFieldDataName ()
virtual void SetReadAllScalars (int)
virtual int GetReadAllScalars ()
virtual void ReadAllScalarsOn ()
virtual void ReadAllScalarsOff ()
virtual void SetReadAllVectors (int)
virtual int GetReadAllVectors ()
virtual void ReadAllVectorsOn ()
virtual void ReadAllVectorsOff ()
virtual void SetReadAllNormals (int)
virtual int GetReadAllNormals ()
virtual void ReadAllNormalsOn ()
virtual void ReadAllNormalsOff ()
virtual void SetReadAllTensors (int)
virtual int GetReadAllTensors ()
virtual void ReadAllTensorsOn ()
virtual void ReadAllTensorsOff ()
virtual void SetReadAllColorScalars (int)
virtual int GetReadAllColorScalars ()
virtual void ReadAllColorScalarsOn ()
virtual void ReadAllColorScalarsOff ()
virtual void SetReadAllTCoords (int)
virtual int GetReadAllTCoords ()
virtual void ReadAllTCoordsOn ()
virtual void ReadAllTCoordsOff ()
virtual void SetReadAllFields (int)
virtual int GetReadAllFields ()
virtual void ReadAllFieldsOn ()
virtual void ReadAllFieldsOff ()
vtkAbstractArrayReadArray (const char *dataType, int numTuples, int numComp)
vtkFieldDataReadFieldData ()
int Read (char *)
int Read (unsigned char *)
int Read (short *)
int Read (unsigned short *)
int Read (int *)
int Read (unsigned int *)
int Read (long *)
int Read (unsigned long *)
int Read (float *)
int Read (double *)
istream * GetIStream ()
- 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 vtkGenericDataObjectReaderNew ()
static int IsTypeOf (const char *type)
static vtkGenericDataObjectReaderSafeDownCast (vtkObject *o)

Protected Member Functions

virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int FillOutputPortInformation (int, vtkInformation *)
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
- Protected Member Functions inherited from vtkDataReader
 vtkDataReader ()
 ~vtkDataReader ()
void SetScalarLut (const char *lut)
virtual char * GetScalarLut ()
int ReadScalarData (vtkDataSetAttributes *a, int num)
int ReadVectorData (vtkDataSetAttributes *a, int num)
int ReadNormalData (vtkDataSetAttributes *a, int num)
int ReadTensorData (vtkDataSetAttributes *a, int num)
int ReadCoScalarData (vtkDataSetAttributes *a, int num)
int ReadLutData (vtkDataSetAttributes *a)
int ReadTCoordsData (vtkDataSetAttributes *a, int num)
int ReadGlobalIds (vtkDataSetAttributes *a, int num)
int ReadPedigreeIds (vtkDataSetAttributes *a, int num)
int ReadDataSetData (vtkDataSet *ds)
void InitializeCharacteristics ()
int CharacterizeFile ()
void CheckFor (const char *name, char *line, int &num, char **&array, int &allocSize)
int DecodeString (char *resname, const char *name)
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
- 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 &)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 vtkGenericDataObjectReader ()
 ~vtkGenericDataObjectReader ()

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
- Protected Attributes inherited from vtkDataReader
char * FileName
int FileType
istream * IS
char * ScalarsName
char * VectorsName
char * TensorsName
char * TCoordsName
char * NormalsName
char * LookupTableName
char * FieldDataName
char * ScalarLut
int ReadFromInputString
char * InputString
int InputStringLength
int InputStringPos
char * Header
int NumberOfScalarsInFile
char ** ScalarsNameInFile
int ScalarsNameAllocSize
int NumberOfVectorsInFile
char ** VectorsNameInFile
int VectorsNameAllocSize
int NumberOfTensorsInFile
char ** TensorsNameInFile
int TensorsNameAllocSize
int NumberOfTCoordsInFile
char ** TCoordsNameInFile
int TCoordsNameAllocSize
int NumberOfNormalsInFile
char ** NormalsNameInFile
int NormalsNameAllocSize
int NumberOfFieldDataInFile
char ** FieldDataNameInFile
int FieldDataNameAllocSize
vtkTimeStamp CharacteristicsTime
int ReadAllScalars
int ReadAllVectors
int ReadAllNormals
int ReadAllTensors
int ReadAllColorScalars
int ReadAllTCoords
int ReadAllFields
vtkCharArrayInputArray
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
- Friends inherited from vtkObject

Detailed Description

class to read any type of vtk data object

vtkGenericDataObjectReader is a class that provides instance variables and methods to read any type of data object in Visualization Toolkit (vtk) format. The output type of this class will vary depending upon the type of data file. Convenience methods are provided to return the data as a particular type. (See text for format description details). The superclass of this class, vtkDataReader, provides many methods for controlling the reading of the data file, see vtkDataReader for more information.

Warning
Binary files written on one system may not be readable on other systems.
See Also
vtkDataReader vtkGraphReader vtkPolyDataReader vtkRectilinearGridReader vtkStructuredPointsReader vtkStructuredGridReader vtkTableReader vtkTreeReader vtkUnstructuredGridReader
Tests:
vtkGenericDataObjectReader (Tests)

Definition at line 52 of file vtkGenericDataObjectReader.h.

Member Typedef Documentation

Definition at line 56 of file vtkGenericDataObjectReader.h.

Constructor & Destructor Documentation

vtkGenericDataObjectReader::vtkGenericDataObjectReader ( )
protected

See vtkAlgorithm for information.

vtkGenericDataObjectReader::~vtkGenericDataObjectReader ( )
protected

See vtkAlgorithm for information.

Member Function Documentation

static vtkGenericDataObjectReader* vtkGenericDataObjectReader::New ( )
static

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

Reimplemented from vtkDataReader.

virtual const char* vtkGenericDataObjectReader::GetClassName ( )
virtual

Reimplemented from vtkDataReader.

static int vtkGenericDataObjectReader::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 vtkDataReader.

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

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

Reimplemented from vtkDataReader.

void vtkGenericDataObjectReader::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 vtkDataReader.

vtkDataObject* vtkGenericDataObjectReader::GetOutput ( )

Get the output of this filter

vtkDataObject* vtkGenericDataObjectReader::GetOutput ( int  idx)

Get the output of this filter

vtkGraph* vtkGenericDataObjectReader::GetGraphOutput ( )

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* vtkGenericDataObjectReader::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* vtkGenericDataObjectReader::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* vtkGenericDataObjectReader::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.)

vtkStructuredPoints* vtkGenericDataObjectReader::GetStructuredPointsOutput ( )

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

vtkTable* vtkGenericDataObjectReader::GetTableOutput ( )

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

vtkTree* vtkGenericDataObjectReader::GetTreeOutput ( )

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* vtkGenericDataObjectReader::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.)

virtual int vtkGenericDataObjectReader::ReadOutputType ( )
virtual

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

virtual int vtkGenericDataObjectReader::ProcessRequest ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
virtual

See vtkAlgorithm for information.

Reimplemented from vtkDataReader.

virtual int vtkGenericDataObjectReader::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

Reimplemented from vtkDataReader.

virtual int vtkGenericDataObjectReader::RequestDataObject ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual
virtual int vtkGenericDataObjectReader::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.

virtual int vtkGenericDataObjectReader::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

Reimplemented from vtkDataReader.


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