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

helper superclass for objects that read vtk data files More...

#include <vtkDataReader.h>

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

Public Types

enum  FieldType { POINT_DATA, CELL_DATA, FIELD_DATA }
 
typedef vtkSimpleReader Superclass
 
- Public Types inherited from vtkSimpleReader
typedef vtkReaderAlgorithm Superclass
 
- Public Types inherited from vtkReaderAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkDataReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetFileName (const char *fname)
 Specify file name of vtk data file to read. More...
 
const char * GetFileName () const
 
const char * GetFileName (int i) const
 
int IsFileValid (const char *dstype)
 Is the file a valid vtk file of the passed dataset type ? The dataset type is passed as a lower case string. More...
 
int IsFileStructuredPoints ()
 
int IsFilePolyData ()
 
int IsFileStructuredGrid ()
 
int IsFileUnstructuredGrid ()
 
int IsFileRectilinearGrid ()
 
void SetInputString (const char *in)
 Specify the InputString for use when reading from a character array. More...
 
virtual char * GetInputString ()
 
void SetInputString (const char *in, int len)
 
virtual int GetInputStringLength ()
 
void SetBinaryInputString (const char *, int len)
 
void SetInputString (const vtkStdString &input)
 
virtual void SetInputArray (vtkCharArray *)
 Specify the vtkCharArray to be used when reading from a string. More...
 
virtual vtkCharArrayGetInputArray ()
 
virtual char * GetHeader ()
 Get the header from the vtk data file. More...
 
virtual void SetReadFromInputString (vtkTypeBool)
 Enable reading from an InputString or InputArray instead of the default, a file. More...
 
virtual vtkTypeBool GetReadFromInputString ()
 
virtual void ReadFromInputStringOn ()
 
virtual void ReadFromInputStringOff ()
 
virtual int GetFileType ()
 Get the type of file (ASCII or BINARY). More...
 
int GetNumberOfScalarsInFile ()
 How many attributes of various types are in this file? This requires reading the file, so the filename must be set prior to invoking this operation. More...
 
int GetNumberOfVectorsInFile ()
 
int GetNumberOfTensorsInFile ()
 
int GetNumberOfNormalsInFile ()
 
int GetNumberOfTCoordsInFile ()
 
int GetNumberOfFieldDataInFile ()
 
const char * GetScalarsNameInFile (int i)
 What is the name of the ith attribute of a certain type in this file? This requires reading the file, so the filename must be set prior to invoking this operation. More...
 
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 *)
 Set the name of the scalar data to extract. More...
 
virtual char * GetScalarsName ()
 
virtual void SetVectorsName (const char *)
 Set the name of the vector data to extract. More...
 
virtual char * GetVectorsName ()
 
virtual void SetTensorsName (const char *)
 Set the name of the tensor data to extract. More...
 
virtual char * GetTensorsName ()
 
virtual void SetNormalsName (const char *)
 Set the name of the normal data to extract. More...
 
virtual char * GetNormalsName ()
 
virtual void SetTCoordsName (const char *)
 Set the name of the texture coordinate data to extract. More...
 
virtual char * GetTCoordsName ()
 
virtual void SetLookupTableName (const char *)
 Set the name of the lookup table data to extract. More...
 
virtual char * GetLookupTableName ()
 
virtual void SetFieldDataName (const char *)
 Set the name of the field data to extract. More...
 
virtual char * GetFieldDataName ()
 
virtual void SetReadAllScalars (vtkTypeBool)
 Enable reading all scalars. More...
 
virtual vtkTypeBool GetReadAllScalars ()
 
virtual void ReadAllScalarsOn ()
 
virtual void ReadAllScalarsOff ()
 
virtual void SetReadAllVectors (vtkTypeBool)
 Enable reading all vectors. More...
 
virtual vtkTypeBool GetReadAllVectors ()
 
virtual void ReadAllVectorsOn ()
 
virtual void ReadAllVectorsOff ()
 
virtual void SetReadAllNormals (vtkTypeBool)
 Enable reading all normals. More...
 
virtual vtkTypeBool GetReadAllNormals ()
 
virtual void ReadAllNormalsOn ()
 
virtual void ReadAllNormalsOff ()
 
virtual void SetReadAllTensors (vtkTypeBool)
 Enable reading all tensors. More...
 
virtual vtkTypeBool GetReadAllTensors ()
 
virtual void ReadAllTensorsOn ()
 
virtual void ReadAllTensorsOff ()
 
virtual void SetReadAllColorScalars (vtkTypeBool)
 Enable reading all color scalars. More...
 
virtual vtkTypeBool GetReadAllColorScalars ()
 
virtual void ReadAllColorScalarsOn ()
 
virtual void ReadAllColorScalarsOff ()
 
virtual void SetReadAllTCoords (vtkTypeBool)
 Enable reading all tcoords. More...
 
virtual vtkTypeBool GetReadAllTCoords ()
 
virtual void ReadAllTCoordsOn ()
 
virtual void ReadAllTCoordsOff ()
 
virtual void SetReadAllFields (vtkTypeBool)
 Enable reading all fields. More...
 
virtual vtkTypeBool GetReadAllFields ()
 
virtual void ReadAllFieldsOn ()
 
virtual void ReadAllFieldsOff ()
 
int OpenVTKFile (const char *fname=nullptr)
 Open a vtk data file. More...
 
int ReadHeader (const char *fname=nullptr)
 Read the header of a vtk data file. More...
 
int ReadCellData (vtkDataSet *ds, vtkIdType numCells)
 Read the cell data of a vtk data file. More...
 
int ReadPointData (vtkDataSet *ds, vtkIdType numPts)
 Read the point data of a vtk data file. More...
 
int ReadPointCoordinates (vtkPointSet *ps, vtkIdType numPts)
 Read point coordinates. More...
 
int ReadPointCoordinates (vtkGraph *g, vtkIdType numPts)
 Read point coordinates. More...
 
int ReadVertexData (vtkGraph *g, vtkIdType numVertices)
 Read the vertex data of a vtk data file. More...
 
int ReadEdgeData (vtkGraph *g, vtkIdType numEdges)
 Read the edge data of a vtk data file. More...
 
int ReadRowData (vtkTable *t, vtkIdType numEdges)
 Read the row data of a vtk data file. More...
 
int ReadCells (vtkIdType size, int *data)
 Read a bunch of "cells". More...
 
int ReadCells (vtkIdType size, int *data, int skip1, int read2, int skip3)
 Read a piece of the cells (for streaming compliance) More...
 
int ReadCoordinates (vtkRectilinearGrid *rg, int axes, int numCoords)
 Read the coordinates for a rectilinear grid. More...
 
vtkAbstractArrayReadArray (const char *dataType, vtkIdType numTuples, vtkIdType numComp)
 Helper functions for reading data. More...
 
vtkFieldDataReadFieldData (FieldType fieldType=FIELD_DATA)
 
virtual int GetFileMajorVersion ()
 Return major and minor version of the file. More...
 
virtual int GetFileMinorVersion ()
 
int Read (char *)
 Internal function to read in a value. More...
 
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 (long long *result)
 
int Read (unsigned long long *result)
 
int Read (float *)
 
int Read (double *)
 
size_t Peek (char *str, size_t n)
 Read n character from the stream into str, then reset the stream position. More...
 
void CloseVTKFile ()
 Close the vtk file. More...
 
int ReadLine (char result[256])
 Internal function to read in a line up to 256 characters. More...
 
int ReadString (char result[256])
 Internal function to read in a string up to 256 characters. More...
 
char * LowerCase (char *str, const size_t len=256)
 Helper method for reading in data. More...
 
istream * GetIStream ()
 Return the istream being used to read in the data. More...
 
int ReadTimeDependentMetaData (int timestep, vtkInformation *metadata) override
 Overridden to handle reading from a string. More...
 
int ReadMesh (int piece, int npieces, int nghosts, int timestep, vtkDataObject *output) override
 Read the mesh (connectivity) for a given set of data partitioning, number of ghost levels and time step (index). More...
 
int ReadPoints (int, int, int, int, vtkDataObject *) override
 Read the points. More...
 
int ReadArrays (int, int, int, int, vtkDataObject *) override
 Read all the arrays (point, cell, field etc.). More...
 
int ReadMeshSimple (const std::string &, vtkDataObject *) override
 Overridden with default implementation of doing nothing so that subclasses only override what is needed (usually only ReadMesh). More...
 
int ReadPointsSimple (const std::string &, vtkDataObject *) override
 A method that needs to be override by the subclass to provide the point coordinates. More...
 
int ReadArraysSimple (const std::string &, vtkDataObject *) override
 A method that needs to be override by the subclass to provide data arrays. More...
 
- Public Member Functions inherited from vtkSimpleReader
vtkSimpleReaderNewInstance () const
 
void AddFileName (const char *fname)
 Add a filename to be read. More...
 
void ClearFileNames ()
 Removes all filenames stored by the reader. More...
 
int GetNumberOfFileNames () const
 Returns the number of filenames stored by the reader. More...
 
const char * GetFileName (int i) const
 Returns a particular filename stored by the reader. More...
 
const char * GetCurrentFileName () const
 Returns the filename that was last loaded by the reader. More...
 
int ReadMetaData (vtkInformation *metadata) override
 Provide meta-data for the pipeline. More...
 
virtual double GetTimeValue (const std::string &fname)
 A subclass can override this method to provide an actual time value for a given file (this method is called for each filename stored by the reader). More...
 
virtual int ReadMetaDataSimple (const std::string &, vtkInformation *)
 A subclass can override this method to provide meta data specific to a particular file. More...
 
- Public Member Functions inherited from vtkReaderAlgorithm
vtkReaderAlgorithmNewInstance () const
 
virtual vtkDataObjectCreateOutput (vtkDataObject *currentOutput)
 This can be overridden by a subclass to create an output that is determined by the file being read. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
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)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (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 ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkDataReaderNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataReaderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkSimpleReader
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkSimpleReaderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkReaderAlgorithm
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkReaderAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDataReader ()
 
 ~vtkDataReader () override
 
void SetScalarLut (const char *lut)
 
virtual char * GetScalarLut ()
 
int ReadScalarData (vtkDataSetAttributes *a, vtkIdType num)
 
int ReadVectorData (vtkDataSetAttributes *a, vtkIdType num)
 
int ReadNormalData (vtkDataSetAttributes *a, vtkIdType num)
 
int ReadTensorData (vtkDataSetAttributes *a, vtkIdType num, vtkIdType numComp=9)
 
int ReadCoScalarData (vtkDataSetAttributes *a, vtkIdType num)
 
int ReadLutData (vtkDataSetAttributes *a)
 
int ReadTCoordsData (vtkDataSetAttributes *a, vtkIdType num)
 
int ReadGlobalIds (vtkDataSetAttributes *a, vtkIdType num)
 
int ReadPedigreeIds (vtkDataSetAttributes *a, vtkIdType num)
 
int ReadEdgeFlags (vtkDataSetAttributes *a, vtkIdType num)
 
int ReadInformation (vtkInformation *info, vtkIdType numKeys)
 Format is detailed here. More...
 
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)
 Decode a string. More...
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. More...
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkSimpleReader
 vtkSimpleReader ()
 
 ~vtkSimpleReader () override
 
vtkExecutiveCreateDefaultExecutive () override
 Create a default executive. More...
 
- Protected Member Functions inherited from vtkReaderAlgorithm
 vtkReaderAlgorithm ()
 
 ~vtkReaderAlgorithm () override
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill the input port information objects for this algorithm. More...
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 Fill the output port information objects for this algorithm. More...
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

std::string CurrentFileName
 
int FileType
 
istream * IS
 
char * ScalarsName
 
char * VectorsName
 
char * TensorsName
 
char * TCoordsName
 
char * NormalsName
 
char * LookupTableName
 
char * FieldDataName
 
char * ScalarLut
 
vtkTypeBool 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
 
vtkTypeBool ReadAllScalars
 
vtkTypeBool ReadAllVectors
 
vtkTypeBool ReadAllNormals
 
vtkTypeBool ReadAllTensors
 
vtkTypeBool ReadAllColorScalars
 
vtkTypeBool ReadAllTCoords
 
vtkTypeBool ReadAllFields
 
int FileMajorVersion
 
int FileMinorVersion
 
std::locale CurrentLocale
 
vtkCharArrayInputArray
 
- Protected Attributes inherited from vtkSimpleReader
int CurrentFileIndex
 
bool HasTemporalMetaData
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

helper superclass for objects that read vtk data files

vtkDataReader is a helper superclass that reads the vtk data file header, dataset type, and attribute data (point and cell attributes such as scalars, vectors, normals, etc.) from a vtk data file. See text for the format of the various vtk file types.

See also
vtkPolyDataReader vtkStructuredPointsReader vtkStructuredGridReader vtkUnstructuredGridReader vtkRectilinearGridReader

Definition at line 51 of file vtkDataReader.h.

Member Typedef Documentation

◆ Superclass

Definition at line 62 of file vtkDataReader.h.

Member Enumeration Documentation

◆ FieldType

Enumerator
POINT_DATA 
CELL_DATA 
FIELD_DATA 

Definition at line 54 of file vtkDataReader.h.

Constructor & Destructor Documentation

◆ vtkDataReader()

vtkDataReader::vtkDataReader ( )
protected

◆ ~vtkDataReader()

vtkDataReader::~vtkDataReader ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkDataReader* vtkDataReader::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkDataReader::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkDataReader::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 vtkSimpleReader.

Reimplemented in vtkGenericDataObjectReader, vtkDataSetReader, vtkNewickTreeReader, vtkPolyDataReader, vtkStructuredGridReader, vtkStructuredPointsReader, vtkUnstructuredGridReader, vtkCompositeDataReader, vtkRectilinearGridReader, vtkDataObjectReader, vtkGraphReader, vtkTableReader, vtkOpenQubeMoleculeSource, vtkMultiNewickTreeReader, vtkTreeReader, and vtkBiomTableReader.

◆ SafeDownCast()

static vtkDataReader* vtkDataReader::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkDataReader::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkDataReader* vtkDataReader::NewInstance ( ) const

◆ PrintSelf()

void vtkDataReader::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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

Reimplemented in vtkGenericDataObjectReader, vtkDataSetReader, vtkPolyDataReader, vtkStructuredGridReader, vtkStructuredPointsReader, vtkUnstructuredGridReader, vtkRectilinearGridReader, vtkGraphReader, vtkTableReader, and vtkTreeReader.

◆ SetFileName()

void vtkDataReader::SetFileName ( const char *  fname)

Specify file name of vtk data file to read.

This is just a convenience method that calls the superclass' AddFileName method.

◆ GetFileName() [1/2]

const char* vtkDataReader::GetFileName ( ) const

◆ GetFileName() [2/2]

const char* vtkDataReader::GetFileName ( int  i) const
inline

Definition at line 73 of file vtkDataReader.h.

◆ IsFileValid()

int vtkDataReader::IsFileValid ( const char *  dstype)

Is the file a valid vtk file of the passed dataset type ? The dataset type is passed as a lower case string.

◆ IsFileStructuredPoints()

int vtkDataReader::IsFileStructuredPoints ( )
inline

Definition at line 85 of file vtkDataReader.h.

◆ IsFilePolyData()

int vtkDataReader::IsFilePolyData ( )
inline

Definition at line 87 of file vtkDataReader.h.

◆ IsFileStructuredGrid()

int vtkDataReader::IsFileStructuredGrid ( )
inline

Definition at line 89 of file vtkDataReader.h.

◆ IsFileUnstructuredGrid()

int vtkDataReader::IsFileUnstructuredGrid ( )
inline

Definition at line 91 of file vtkDataReader.h.

◆ IsFileRectilinearGrid()

int vtkDataReader::IsFileRectilinearGrid ( )
inline

Definition at line 93 of file vtkDataReader.h.

◆ SetInputString() [1/3]

void vtkDataReader::SetInputString ( const char *  in)

Specify the InputString for use when reading from a character array.

Optionally include the length for binary strings. Note that a copy of the string is made and stored. If this causes exceedingly large memory consumption, consider using InputArray instead.

◆ GetInputString()

virtual char* vtkDataReader::GetInputString ( )
virtual

◆ SetInputString() [2/3]

void vtkDataReader::SetInputString ( const char *  in,
int  len 
)

◆ GetInputStringLength()

virtual int vtkDataReader::GetInputStringLength ( )
virtual

◆ SetBinaryInputString()

void vtkDataReader::SetBinaryInputString ( const char *  ,
int  len 
)

◆ SetInputString() [3/3]

void vtkDataReader::SetInputString ( const vtkStdString input)
inline

Definition at line 109 of file vtkDataReader.h.

◆ SetInputArray()

virtual void vtkDataReader::SetInputArray ( vtkCharArray )
virtual

Specify the vtkCharArray to be used when reading from a string.

If set, this array has precedence over InputString. Use this instead of InputString to avoid the extra memory copy. It should be noted that if the underlying char* is owned by the user ( vtkCharArray::SetArray(array, 1); ) and is deleted before the reader, bad things will happen during a pipeline update.

◆ GetInputArray()

virtual vtkCharArray* vtkDataReader::GetInputArray ( )
virtual

◆ GetHeader()

virtual char* vtkDataReader::GetHeader ( )
virtual

Get the header from the vtk data file.

◆ SetReadFromInputString()

virtual void vtkDataReader::SetReadFromInputString ( vtkTypeBool  )
virtual

Enable reading from an InputString or InputArray instead of the default, a file.

◆ GetReadFromInputString()

virtual vtkTypeBool vtkDataReader::GetReadFromInputString ( )
virtual

◆ ReadFromInputStringOn()

virtual void vtkDataReader::ReadFromInputStringOn ( )
virtual

◆ ReadFromInputStringOff()

virtual void vtkDataReader::ReadFromInputStringOff ( )
virtual

◆ GetFileType()

virtual int vtkDataReader::GetFileType ( )
virtual

Get the type of file (ASCII or BINARY).

Returned value only valid after file has been read.

◆ GetNumberOfScalarsInFile()

int vtkDataReader::GetNumberOfScalarsInFile ( )
inline

How many attributes of various types are in this file? This requires reading the file, so the filename must be set prior to invoking this operation.

(Note: file characteristics are cached, so only a single read is necessary to return file characteristics.)

Definition at line 158 of file vtkDataReader.h.

◆ GetNumberOfVectorsInFile()

int vtkDataReader::GetNumberOfVectorsInFile ( )
inline

Definition at line 160 of file vtkDataReader.h.

◆ GetNumberOfTensorsInFile()

int vtkDataReader::GetNumberOfTensorsInFile ( )
inline

Definition at line 162 of file vtkDataReader.h.

◆ GetNumberOfNormalsInFile()

int vtkDataReader::GetNumberOfNormalsInFile ( )
inline

Definition at line 164 of file vtkDataReader.h.

◆ GetNumberOfTCoordsInFile()

int vtkDataReader::GetNumberOfTCoordsInFile ( )
inline

Definition at line 166 of file vtkDataReader.h.

◆ GetNumberOfFieldDataInFile()

int vtkDataReader::GetNumberOfFieldDataInFile ( )
inline

Definition at line 168 of file vtkDataReader.h.

◆ GetScalarsNameInFile()

const char* vtkDataReader::GetScalarsNameInFile ( int  i)

What is the name of the ith attribute of a certain type in this file? This requires reading the file, so the filename must be set prior to invoking this operation.

◆ GetVectorsNameInFile()

const char* vtkDataReader::GetVectorsNameInFile ( int  i)

◆ GetTensorsNameInFile()

const char* vtkDataReader::GetTensorsNameInFile ( int  i)

◆ GetNormalsNameInFile()

const char* vtkDataReader::GetNormalsNameInFile ( int  i)

◆ GetTCoordsNameInFile()

const char* vtkDataReader::GetTCoordsNameInFile ( int  i)

◆ GetFieldDataNameInFile()

const char* vtkDataReader::GetFieldDataNameInFile ( int  i)

◆ SetScalarsName()

virtual void vtkDataReader::SetScalarsName ( const char *  )
virtual

Set the name of the scalar data to extract.

If not specified, first scalar data encountered is extracted.

◆ GetScalarsName()

virtual char* vtkDataReader::GetScalarsName ( )
virtual

◆ SetVectorsName()

virtual void vtkDataReader::SetVectorsName ( const char *  )
virtual

Set the name of the vector data to extract.

If not specified, first vector data encountered is extracted.

◆ GetVectorsName()

virtual char* vtkDataReader::GetVectorsName ( )
virtual

◆ SetTensorsName()

virtual void vtkDataReader::SetTensorsName ( const char *  )
virtual

Set the name of the tensor data to extract.

If not specified, first tensor data encountered is extracted.

◆ GetTensorsName()

virtual char* vtkDataReader::GetTensorsName ( )
virtual

◆ SetNormalsName()

virtual void vtkDataReader::SetNormalsName ( const char *  )
virtual

Set the name of the normal data to extract.

If not specified, first normal data encountered is extracted.

◆ GetNormalsName()

virtual char* vtkDataReader::GetNormalsName ( )
virtual

◆ SetTCoordsName()

virtual void vtkDataReader::SetTCoordsName ( const char *  )
virtual

Set the name of the texture coordinate data to extract.

If not specified, first texture coordinate data encountered is extracted.

◆ GetTCoordsName()

virtual char* vtkDataReader::GetTCoordsName ( )
virtual

◆ SetLookupTableName()

virtual void vtkDataReader::SetLookupTableName ( const char *  )
virtual

Set the name of the lookup table data to extract.

If not specified, uses lookup table named by scalar. Otherwise, this specification supersedes.

◆ GetLookupTableName()

virtual char* vtkDataReader::GetLookupTableName ( )
virtual

◆ SetFieldDataName()

virtual void vtkDataReader::SetFieldDataName ( const char *  )
virtual

Set the name of the field data to extract.

If not specified, uses first field data encountered in file.

◆ GetFieldDataName()

virtual char* vtkDataReader::GetFieldDataName ( )
virtual

◆ SetReadAllScalars()

virtual void vtkDataReader::SetReadAllScalars ( vtkTypeBool  )
virtual

Enable reading all scalars.

◆ GetReadAllScalars()

virtual vtkTypeBool vtkDataReader::GetReadAllScalars ( )
virtual

◆ ReadAllScalarsOn()

virtual void vtkDataReader::ReadAllScalarsOn ( )
virtual

◆ ReadAllScalarsOff()

virtual void vtkDataReader::ReadAllScalarsOff ( )
virtual

◆ SetReadAllVectors()

virtual void vtkDataReader::SetReadAllVectors ( vtkTypeBool  )
virtual

Enable reading all vectors.

◆ GetReadAllVectors()

virtual vtkTypeBool vtkDataReader::GetReadAllVectors ( )
virtual

◆ ReadAllVectorsOn()

virtual void vtkDataReader::ReadAllVectorsOn ( )
virtual

◆ ReadAllVectorsOff()

virtual void vtkDataReader::ReadAllVectorsOff ( )
virtual

◆ SetReadAllNormals()

virtual void vtkDataReader::SetReadAllNormals ( vtkTypeBool  )
virtual

Enable reading all normals.

◆ GetReadAllNormals()

virtual vtkTypeBool vtkDataReader::GetReadAllNormals ( )
virtual

◆ ReadAllNormalsOn()

virtual void vtkDataReader::ReadAllNormalsOn ( )
virtual

◆ ReadAllNormalsOff()

virtual void vtkDataReader::ReadAllNormalsOff ( )
virtual

◆ SetReadAllTensors()

virtual void vtkDataReader::SetReadAllTensors ( vtkTypeBool  )
virtual

Enable reading all tensors.

◆ GetReadAllTensors()

virtual vtkTypeBool vtkDataReader::GetReadAllTensors ( )
virtual

◆ ReadAllTensorsOn()

virtual void vtkDataReader::ReadAllTensorsOn ( )
virtual

◆ ReadAllTensorsOff()

virtual void vtkDataReader::ReadAllTensorsOff ( )
virtual

◆ SetReadAllColorScalars()

virtual void vtkDataReader::SetReadAllColorScalars ( vtkTypeBool  )
virtual

Enable reading all color scalars.

◆ GetReadAllColorScalars()

virtual vtkTypeBool vtkDataReader::GetReadAllColorScalars ( )
virtual

◆ ReadAllColorScalarsOn()

virtual void vtkDataReader::ReadAllColorScalarsOn ( )
virtual

◆ ReadAllColorScalarsOff()

virtual void vtkDataReader::ReadAllColorScalarsOff ( )
virtual

◆ SetReadAllTCoords()

virtual void vtkDataReader::SetReadAllTCoords ( vtkTypeBool  )
virtual

Enable reading all tcoords.

◆ GetReadAllTCoords()

virtual vtkTypeBool vtkDataReader::GetReadAllTCoords ( )
virtual

◆ ReadAllTCoordsOn()

virtual void vtkDataReader::ReadAllTCoordsOn ( )
virtual

◆ ReadAllTCoordsOff()

virtual void vtkDataReader::ReadAllTCoordsOff ( )
virtual

◆ SetReadAllFields()

virtual void vtkDataReader::SetReadAllFields ( vtkTypeBool  )
virtual

Enable reading all fields.

◆ GetReadAllFields()

virtual vtkTypeBool vtkDataReader::GetReadAllFields ( )
virtual

◆ ReadAllFieldsOn()

virtual void vtkDataReader::ReadAllFieldsOn ( )
virtual

◆ ReadAllFieldsOff()

virtual void vtkDataReader::ReadAllFieldsOff ( )
virtual

◆ OpenVTKFile()

int vtkDataReader::OpenVTKFile ( const char *  fname = nullptr)

Open a vtk data file.

Returns zero if error.

◆ ReadHeader()

int vtkDataReader::ReadHeader ( const char *  fname = nullptr)

Read the header of a vtk data file.

Returns 0 if error.

◆ ReadCellData()

int vtkDataReader::ReadCellData ( vtkDataSet ds,
vtkIdType  numCells 
)

Read the cell data of a vtk data file.

The number of cells (from the dataset) must match the number of cells defined in cell attributes (unless no geometry was defined).

◆ ReadPointData()

int vtkDataReader::ReadPointData ( vtkDataSet ds,
vtkIdType  numPts 
)

Read the point data of a vtk data file.

The number of points (from the dataset) must match the number of points defined in point attributes (unless no geometry was defined).

◆ ReadPointCoordinates() [1/2]

int vtkDataReader::ReadPointCoordinates ( vtkPointSet ps,
vtkIdType  numPts 
)

Read point coordinates.

Return 0 if error.

◆ ReadPointCoordinates() [2/2]

int vtkDataReader::ReadPointCoordinates ( vtkGraph g,
vtkIdType  numPts 
)

Read point coordinates.

Return 0 if error.

◆ ReadVertexData()

int vtkDataReader::ReadVertexData ( vtkGraph g,
vtkIdType  numVertices 
)

Read the vertex data of a vtk data file.

The number of vertices (from the graph) must match the number of vertices defined in vertex attributes (unless no geometry was defined).

◆ ReadEdgeData()

int vtkDataReader::ReadEdgeData ( vtkGraph g,
vtkIdType  numEdges 
)

Read the edge data of a vtk data file.

The number of edges (from the graph) must match the number of edges defined in edge attributes (unless no geometry was defined).

◆ ReadRowData()

int vtkDataReader::ReadRowData ( vtkTable t,
vtkIdType  numEdges 
)

Read the row data of a vtk data file.

◆ ReadCells() [1/2]

int vtkDataReader::ReadCells ( vtkIdType  size,
int data 
)

Read a bunch of "cells".

Return 0 if error.

◆ ReadCells() [2/2]

int vtkDataReader::ReadCells ( vtkIdType  size,
int data,
int  skip1,
int  read2,
int  skip3 
)

Read a piece of the cells (for streaming compliance)

◆ ReadCoordinates()

int vtkDataReader::ReadCoordinates ( vtkRectilinearGrid rg,
int  axes,
int  numCoords 
)

Read the coordinates for a rectilinear grid.

The axes parameter specifies which coordinate axes (0,1,2) is being read.

◆ ReadArray()

vtkAbstractArray* vtkDataReader::ReadArray ( const char *  dataType,
vtkIdType  numTuples,
vtkIdType  numComp 
)

Helper functions for reading data.

◆ ReadFieldData()

vtkFieldData* vtkDataReader::ReadFieldData ( FieldType  fieldType = FIELD_DATA)

◆ GetFileMajorVersion()

virtual int vtkDataReader::GetFileMajorVersion ( )
virtual

Return major and minor version of the file.

Returns version 3.0 if the version cannot be read from file.

◆ GetFileMinorVersion()

virtual int vtkDataReader::GetFileMinorVersion ( )
virtual

◆ Read() [1/12]

int vtkDataReader::Read ( char *  )

Internal function to read in a value.

Returns zero if there was an error.

◆ Read() [2/12]

int vtkDataReader::Read ( unsigned char *  )

◆ Read() [3/12]

int vtkDataReader::Read ( short *  )

◆ Read() [4/12]

int vtkDataReader::Read ( unsigned short *  )

◆ Read() [5/12]

int vtkDataReader::Read ( int )

◆ Read() [6/12]

int vtkDataReader::Read ( unsigned int )

◆ Read() [7/12]

int vtkDataReader::Read ( long *  )

◆ Read() [8/12]

int vtkDataReader::Read ( unsigned long *  )

◆ Read() [9/12]

int vtkDataReader::Read ( long long *  result)

◆ Read() [10/12]

int vtkDataReader::Read ( unsigned long long *  result)

◆ Read() [11/12]

int vtkDataReader::Read ( float )

◆ Read() [12/12]

int vtkDataReader::Read ( double )

◆ Peek()

size_t vtkDataReader::Peek ( char *  str,
size_t  n 
)

Read n character from the stream into str, then reset the stream position.

Returns the number of characters actually read.

◆ CloseVTKFile()

void vtkDataReader::CloseVTKFile ( )

Close the vtk file.

◆ ReadLine()

int vtkDataReader::ReadLine ( char  result[256])

Internal function to read in a line up to 256 characters.

Returns zero if there was an error.

◆ ReadString()

int vtkDataReader::ReadString ( char  result[256])

Internal function to read in a string up to 256 characters.

Returns zero if there was an error.

◆ LowerCase()

char* vtkDataReader::LowerCase ( char *  str,
const size_t  len = 256 
)

Helper method for reading in data.

◆ GetIStream()

istream* vtkDataReader::GetIStream ( )
inline

Return the istream being used to read in the data.

Definition at line 448 of file vtkDataReader.h.

◆ ReadTimeDependentMetaData()

int vtkDataReader::ReadTimeDependentMetaData ( int  timestep,
vtkInformation metadata 
)
overridevirtual

Overridden to handle reading from a string.

The superclass only knows about files.

Reimplemented from vtkSimpleReader.

◆ ReadMesh()

int vtkDataReader::ReadMesh ( int  piece,
int  npieces,
int  nghosts,
int  timestep,
vtkDataObject output 
)
overridevirtual

Read the mesh (connectivity) for a given set of data partitioning, number of ghost levels and time step (index).

The reader populates the data object passed in as the last argument. It is OK to read more than the mesh (points, arrays etc.). However, this may interfere with any caching implemented by the executive (i.e. cause more reads).

Reimplemented from vtkSimpleReader.

◆ ReadPoints()

int vtkDataReader::ReadPoints ( int  piece,
int  npieces,
int  nghosts,
int  timestep,
vtkDataObject output 
)
inlineoverridevirtual

Read the points.

The reader populates the input data object. This is called after ReadMesh() so the data object should already contain the mesh.

Reimplemented from vtkSimpleReader.

Definition at line 460 of file vtkDataReader.h.

◆ ReadArrays()

int vtkDataReader::ReadArrays ( int  piece,
int  npieces,
int  nghosts,
int  timestep,
vtkDataObject output 
)
inlineoverridevirtual

Read all the arrays (point, cell, field etc.).

This is called after ReadPoints() so the data object should already contain the mesh and points.

Reimplemented from vtkSimpleReader.

Definition at line 463 of file vtkDataReader.h.

◆ ReadMeshSimple()

int vtkDataReader::ReadMeshSimple ( const std::string &  ,
vtkDataObject  
)
inlineoverridevirtual

Overridden with default implementation of doing nothing so that subclasses only override what is needed (usually only ReadMesh).

Implements vtkSimpleReader.

Reimplemented in vtkGenericDataObjectReader, vtkDataSetReader, vtkStructuredGridReader, vtkStructuredPointsReader, vtkRectilinearGridReader, vtkPolyDataReader, vtkUnstructuredGridReader, vtkTableReader, vtkGraphReader, and vtkTreeReader.

Definition at line 474 of file vtkDataReader.h.

◆ ReadPointsSimple()

int vtkDataReader::ReadPointsSimple ( const std::string &  fname,
vtkDataObject output 
)
inlineoverridevirtual

A method that needs to be override by the subclass to provide the point coordinates.

Note that the filename is passed to this method and should be used by the subclass. The subclass directly adds the coordinates to the provided data object.

Implements vtkSimpleReader.

Definition at line 476 of file vtkDataReader.h.

◆ ReadArraysSimple()

int vtkDataReader::ReadArraysSimple ( const std::string &  fname,
vtkDataObject output 
)
inlineoverridevirtual

A method that needs to be override by the subclass to provide data arrays.

Note that the filename is passed to this method and should be used by the subclass. The subclass directly adds data arrays to the provided data object.

Implements vtkSimpleReader.

Definition at line 478 of file vtkDataReader.h.

◆ SetScalarLut()

void vtkDataReader::SetScalarLut ( const char *  lut)
protected

◆ GetScalarLut()

virtual char* vtkDataReader::GetScalarLut ( )
protectedvirtual

◆ ReadScalarData()

int vtkDataReader::ReadScalarData ( vtkDataSetAttributes a,
vtkIdType  num 
)
protected

◆ ReadVectorData()

int vtkDataReader::ReadVectorData ( vtkDataSetAttributes a,
vtkIdType  num 
)
protected

◆ ReadNormalData()

int vtkDataReader::ReadNormalData ( vtkDataSetAttributes a,
vtkIdType  num 
)
protected

◆ ReadTensorData()

int vtkDataReader::ReadTensorData ( vtkDataSetAttributes a,
vtkIdType  num,
vtkIdType  numComp = 9 
)
protected

◆ ReadCoScalarData()

int vtkDataReader::ReadCoScalarData ( vtkDataSetAttributes a,
vtkIdType  num 
)
protected

◆ ReadLutData()

int vtkDataReader::ReadLutData ( vtkDataSetAttributes a)
protected

◆ ReadTCoordsData()

int vtkDataReader::ReadTCoordsData ( vtkDataSetAttributes a,
vtkIdType  num 
)
protected

◆ ReadGlobalIds()

int vtkDataReader::ReadGlobalIds ( vtkDataSetAttributes a,
vtkIdType  num 
)
protected

◆ ReadPedigreeIds()

int vtkDataReader::ReadPedigreeIds ( vtkDataSetAttributes a,
vtkIdType  num 
)
protected

◆ ReadEdgeFlags()

int vtkDataReader::ReadEdgeFlags ( vtkDataSetAttributes a,
vtkIdType  num 
)
protected

◆ ReadInformation()

int vtkDataReader::ReadInformation ( vtkInformation info,
vtkIdType  numKeys 
)
protected

Format is detailed here.

◆ ReadDataSetData()

int vtkDataReader::ReadDataSetData ( vtkDataSet ds)
protected

◆ InitializeCharacteristics()

void vtkDataReader::InitializeCharacteristics ( )
protected

◆ CharacterizeFile()

int vtkDataReader::CharacterizeFile ( )
protected

◆ CheckFor()

void vtkDataReader::CheckFor ( const char *  name,
char *  line,
int num,
char **&  array,
int allocSize 
)
protected

◆ DecodeString()

int vtkDataReader::DecodeString ( char *  resname,
const char *  name 
)
protected

Decode a string.

This method is the inverse of vtkWriter::EncodeString. Returns the length of the result string.

◆ ProcessRequest()

vtkTypeBool vtkDataReader::ProcessRequest ( vtkInformation request,
vtkInformationVector **  inInfo,
vtkInformationVector outInfo 
)
overrideprotectedvirtual

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.

◆ RequestData()

virtual int vtkDataReader::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
inlineprotectedvirtual

Reimplemented in vtkOpenQubeMoleculeSource.

Definition at line 577 of file vtkDataReader.h.

◆ RequestUpdateExtent()

virtual int vtkDataReader::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
inlineprotectedvirtual

Definition at line 580 of file vtkDataReader.h.

◆ RequestInformation()

virtual int vtkDataReader::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
inlineprotectedvirtual

Definition at line 583 of file vtkDataReader.h.

Member Data Documentation

◆ CurrentFileName

std::string vtkDataReader::CurrentFileName
protected

Definition at line 487 of file vtkDataReader.h.

◆ FileType

int vtkDataReader::FileType
protected

Definition at line 488 of file vtkDataReader.h.

◆ IS

istream* vtkDataReader::IS
protected

Definition at line 489 of file vtkDataReader.h.

◆ ScalarsName

char* vtkDataReader::ScalarsName
protected

Definition at line 491 of file vtkDataReader.h.

◆ VectorsName

char* vtkDataReader::VectorsName
protected

Definition at line 492 of file vtkDataReader.h.

◆ TensorsName

char* vtkDataReader::TensorsName
protected

Definition at line 493 of file vtkDataReader.h.

◆ TCoordsName

char* vtkDataReader::TCoordsName
protected

Definition at line 494 of file vtkDataReader.h.

◆ NormalsName

char* vtkDataReader::NormalsName
protected

Definition at line 495 of file vtkDataReader.h.

◆ LookupTableName

char* vtkDataReader::LookupTableName
protected

Definition at line 496 of file vtkDataReader.h.

◆ FieldDataName

char* vtkDataReader::FieldDataName
protected

Definition at line 497 of file vtkDataReader.h.

◆ ScalarLut

char* vtkDataReader::ScalarLut
protected

Definition at line 498 of file vtkDataReader.h.

◆ ReadFromInputString

vtkTypeBool vtkDataReader::ReadFromInputString
protected

Definition at line 500 of file vtkDataReader.h.

◆ InputString

char* vtkDataReader::InputString
protected

Definition at line 501 of file vtkDataReader.h.

◆ InputStringLength

int vtkDataReader::InputStringLength
protected

Definition at line 502 of file vtkDataReader.h.

◆ InputStringPos

int vtkDataReader::InputStringPos
protected

Definition at line 503 of file vtkDataReader.h.

◆ Header

char* vtkDataReader::Header
protected

Definition at line 506 of file vtkDataReader.h.

◆ NumberOfScalarsInFile

int vtkDataReader::NumberOfScalarsInFile
protected

Definition at line 529 of file vtkDataReader.h.

◆ ScalarsNameInFile

char** vtkDataReader::ScalarsNameInFile
protected

Definition at line 530 of file vtkDataReader.h.

◆ ScalarsNameAllocSize

int vtkDataReader::ScalarsNameAllocSize
protected

Definition at line 531 of file vtkDataReader.h.

◆ NumberOfVectorsInFile

int vtkDataReader::NumberOfVectorsInFile
protected

Definition at line 532 of file vtkDataReader.h.

◆ VectorsNameInFile

char** vtkDataReader::VectorsNameInFile
protected

Definition at line 533 of file vtkDataReader.h.

◆ VectorsNameAllocSize

int vtkDataReader::VectorsNameAllocSize
protected

Definition at line 534 of file vtkDataReader.h.

◆ NumberOfTensorsInFile

int vtkDataReader::NumberOfTensorsInFile
protected

Definition at line 535 of file vtkDataReader.h.

◆ TensorsNameInFile

char** vtkDataReader::TensorsNameInFile
protected

Definition at line 536 of file vtkDataReader.h.

◆ TensorsNameAllocSize

int vtkDataReader::TensorsNameAllocSize
protected

Definition at line 537 of file vtkDataReader.h.

◆ NumberOfTCoordsInFile

int vtkDataReader::NumberOfTCoordsInFile
protected

Definition at line 538 of file vtkDataReader.h.

◆ TCoordsNameInFile

char** vtkDataReader::TCoordsNameInFile
protected

Definition at line 539 of file vtkDataReader.h.

◆ TCoordsNameAllocSize

int vtkDataReader::TCoordsNameAllocSize
protected

Definition at line 540 of file vtkDataReader.h.

◆ NumberOfNormalsInFile

int vtkDataReader::NumberOfNormalsInFile
protected

Definition at line 541 of file vtkDataReader.h.

◆ NormalsNameInFile

char** vtkDataReader::NormalsNameInFile
protected

Definition at line 542 of file vtkDataReader.h.

◆ NormalsNameAllocSize

int vtkDataReader::NormalsNameAllocSize
protected

Definition at line 543 of file vtkDataReader.h.

◆ NumberOfFieldDataInFile

int vtkDataReader::NumberOfFieldDataInFile
protected

Definition at line 544 of file vtkDataReader.h.

◆ FieldDataNameInFile

char** vtkDataReader::FieldDataNameInFile
protected

Definition at line 545 of file vtkDataReader.h.

◆ FieldDataNameAllocSize

int vtkDataReader::FieldDataNameAllocSize
protected

Definition at line 546 of file vtkDataReader.h.

◆ CharacteristicsTime

vtkTimeStamp vtkDataReader::CharacteristicsTime
protected

Definition at line 547 of file vtkDataReader.h.

◆ ReadAllScalars

vtkTypeBool vtkDataReader::ReadAllScalars
protected

Definition at line 549 of file vtkDataReader.h.

◆ ReadAllVectors

vtkTypeBool vtkDataReader::ReadAllVectors
protected

Definition at line 550 of file vtkDataReader.h.

◆ ReadAllNormals

vtkTypeBool vtkDataReader::ReadAllNormals
protected

Definition at line 551 of file vtkDataReader.h.

◆ ReadAllTensors

vtkTypeBool vtkDataReader::ReadAllTensors
protected

Definition at line 552 of file vtkDataReader.h.

◆ ReadAllColorScalars

vtkTypeBool vtkDataReader::ReadAllColorScalars
protected

Definition at line 553 of file vtkDataReader.h.

◆ ReadAllTCoords

vtkTypeBool vtkDataReader::ReadAllTCoords
protected

Definition at line 554 of file vtkDataReader.h.

◆ ReadAllFields

vtkTypeBool vtkDataReader::ReadAllFields
protected

Definition at line 555 of file vtkDataReader.h.

◆ FileMajorVersion

int vtkDataReader::FileMajorVersion
protected

Definition at line 556 of file vtkDataReader.h.

◆ FileMinorVersion

int vtkDataReader::FileMinorVersion
protected

Definition at line 557 of file vtkDataReader.h.

◆ CurrentLocale

std::locale vtkDataReader::CurrentLocale
protected

Definition at line 559 of file vtkDataReader.h.

◆ InputArray

vtkCharArray* vtkDataReader::InputArray
protected

Definition at line 566 of file vtkDataReader.h.


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