read vtk structured points data file More...

#include <vtkStructuredPointsReader.h>

Inheritance diagram for vtkStructuredPointsReader:

Collaboration diagram for vtkStructuredPointsReader:

Public Types
typedef vtkDataReader	Superclass

Public Types inherited from vtkDataReader
enum	FieldType { POINT_DATA, CELL_DATA, FIELD_DATA }

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 int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkStructuredPointsReader *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual int	ReadMetaData (vtkInformation *outInfo)
	Read the meta information from the file. More...


void	SetOutput (vtkStructuredPoints *output)
	Set/Get the output of this reader. More...

vtkStructuredPoints *	GetOutput (int idx)
	Set/Get the output of this reader. More...

vtkStructuredPoints *	GetOutput ()
	Set/Get the output of this reader. More...

Public Member Functions inherited from vtkDataReader
vtkDataReader *	NewInstance () const

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

int	OpenVTKFile ()
	Open a vtk data file. More...

int	ReadHeader ()
	Read the header of a vtk data file. More...

int	ReadCellData (vtkDataSet *ds, int numCells)
	Read the cell data of a vtk data file. More...

int	ReadPointData (vtkDataSet *ds, int numPts)
	Read the point data of a vtk data file. More...

int	ReadPoints (vtkPointSet *ps, int numPts)
	Read point coordinates. More...

int	ReadPoints (vtkGraph *g, int numPts)
	Read point coordinates. More...

int	ReadVertexData (vtkGraph *g, int numVertices)
	Read the vertex data of a vtk data file. More...

int	ReadEdgeData (vtkGraph *g, int numEdges)
	Read the edge data of a vtk data file. More...

int	ReadRowData (vtkTable *t, int numEdges)
	Read the row data of a vtk data file. More...

int	ReadCells (int size, int *data)
	Read a bunch of "cells". More...

int	ReadCells (int 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...

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

virtual void	SetFileName (const char *)
	Specify file name of vtk data file to read. More...

virtual char *	GetFileName ()
	Specify file name of vtk data file to read. More...

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 ()
	Is the file a valid vtk file of the passed dataset type ? The dataset type is passed as a lower case string. More...

int	IsFilePolyData ()
	Is the file a valid vtk file of the passed dataset type ? The dataset type is passed as a lower case string. More...

int	IsFileStructuredGrid ()
	Is the file a valid vtk file of the passed dataset type ? The dataset type is passed as a lower case string. More...

int	IsFileUnstructuredGrid ()
	Is the file a valid vtk file of the passed dataset type ? The dataset type is passed as a lower case string. More...

int	IsFileRectilinearGrid ()
	Is the file a valid vtk file of the passed dataset type ? The dataset type is passed as a lower case string. More...

void	SetInputString (const char *in)
	Specify the InputString for use when reading from a character array. More...

virtual char *	GetInputString ()
	Specify the InputString for use when reading from a character array. More...

void	SetInputString (const char *in, int len)
	Specify the InputString for use when reading from a character array. More...

virtual int	GetInputStringLength ()
	Specify the InputString for use when reading from a character array. More...

void	SetBinaryInputString (const char *, int len)
	Specify the InputString for use when reading from a character array. More...

void	SetInputString (const vtkStdString &input)
	Specify the InputString for use when reading from a character array. More...

virtual void	SetInputArray (vtkCharArray *)
	Specify the vtkCharArray to be used when reading from a string. More...

virtual vtkCharArray *	GetInputArray ()
	Specify the vtkCharArray to be used when reading from a string. More...

virtual char *	GetHeader ()
	Get the header from the vtk data file. More...

virtual void	SetReadFromInputString (int)
	Enable reading from an InputString or InputArray instead of the default, a file. More...

virtual int	GetReadFromInputString ()
	Enable reading from an InputString or InputArray instead of the default, a file. More...

virtual void	ReadFromInputStringOn ()
	Enable reading from an InputString or InputArray instead of the default, a file. More...

virtual void	ReadFromInputStringOff ()
	Enable reading from an InputString or InputArray instead of the default, a file. More...

virtual int	GetFileType ()
	Get the type of file (ASCII or BINARY). More...

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)
	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 *	GetTensorsNameInFile (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 *	GetNormalsNameInFile (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 *	GetTCoordsNameInFile (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 *	GetFieldDataNameInFile (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...

virtual void	SetScalarsName (const char *)
	Set the name of the scalar data to extract. More...

virtual char *	GetScalarsName ()
	Set the name of the scalar data to extract. More...

virtual void	SetVectorsName (const char *)
	Set the name of the vector data to extract. More...

virtual char *	GetVectorsName ()
	Set the name of the vector data to extract. More...

virtual void	SetTensorsName (const char *)
	Set the name of the tensor data to extract. More...

virtual char *	GetTensorsName ()
	Set the name of the tensor data to extract. More...

virtual void	SetNormalsName (const char *)
	Set the name of the normal data to extract. More...

virtual char *	GetNormalsName ()
	Set the name of the normal data to extract. More...

virtual void	SetTCoordsName (const char *)
	Set the name of the texture coordinate data to extract. More...

virtual char *	GetTCoordsName ()
	Set the name of the texture coordinate data to extract. More...

virtual void	SetLookupTableName (const char *)
	Set the name of the lookup table data to extract. More...

virtual char *	GetLookupTableName ()
	Set the name of the lookup table data to extract. More...

virtual void	SetFieldDataName (const char *)
	Set the name of the field data to extract. More...

virtual char *	GetFieldDataName ()
	Set the name of the field data to extract. More...

virtual void	SetReadAllScalars (int)
	Enable reading all scalars. More...

virtual int	GetReadAllScalars ()
	Enable reading all scalars. More...

virtual void	ReadAllScalarsOn ()
	Enable reading all scalars. More...

virtual void	ReadAllScalarsOff ()
	Enable reading all scalars. More...

virtual void	SetReadAllVectors (int)
	Enable reading all vectors. More...

virtual int	GetReadAllVectors ()
	Enable reading all vectors. More...

virtual void	ReadAllVectorsOn ()
	Enable reading all vectors. More...

virtual void	ReadAllVectorsOff ()
	Enable reading all vectors. More...

virtual void	SetReadAllNormals (int)
	Enable reading all normals. More...

virtual int	GetReadAllNormals ()
	Enable reading all normals. More...

virtual void	ReadAllNormalsOn ()
	Enable reading all normals. More...

virtual void	ReadAllNormalsOff ()
	Enable reading all normals. More...

virtual void	SetReadAllTensors (int)
	Enable reading all tensors. More...

virtual int	GetReadAllTensors ()
	Enable reading all tensors. More...

virtual void	ReadAllTensorsOn ()
	Enable reading all tensors. More...

virtual void	ReadAllTensorsOff ()
	Enable reading all tensors. More...

virtual void	SetReadAllColorScalars (int)
	Enable reading all color scalars. More...

virtual int	GetReadAllColorScalars ()
	Enable reading all color scalars. More...

virtual void	ReadAllColorScalarsOn ()
	Enable reading all color scalars. More...

virtual void	ReadAllColorScalarsOff ()
	Enable reading all color scalars. More...

virtual void	SetReadAllTCoords (int)
	Enable reading all tcoords. More...

virtual int	GetReadAllTCoords ()
	Enable reading all tcoords. More...

virtual void	ReadAllTCoordsOn ()
	Enable reading all tcoords. More...

virtual void	ReadAllTCoordsOff ()
	Enable reading all tcoords. More...

virtual void	SetReadAllFields (int)
	Enable reading all fields. More...

virtual int	GetReadAllFields ()
	Enable reading all fields. More...

virtual void	ReadAllFieldsOn ()
	Enable reading all fields. More...

virtual void	ReadAllFieldsOff ()
	Enable reading all fields. More...

vtkAbstractArray *	ReadArray (const char *dataType, int numTuples, int numComp)
	Helper functions for reading data. More...

vtkFieldData *	ReadFieldData (FieldType fieldType=FIELD_DATA)
	Helper functions for reading data. More...

virtual int	GetFileMajorVersion ()
	Return major and minor version of the file. More...

virtual int	GetFileMinorVersion ()
	Return major and minor version of the file. More...

int	Read (char *)
	Internal function to read in a value. More...

int	Read (unsigned char *)
	Internal function to read in a value. More...

int	Read (short *)
	Internal function to read in a value. More...

int	Read (unsigned short *)
	Internal function to read in a value. More...

int	Read (int *)
	Internal function to read in a value. More...

int	Read (unsigned int *)
	Internal function to read in a value. More...

int	Read (long *)
	Internal function to read in a value. More...

int	Read (unsigned long *)
	Internal function to read in a value. More...

int	Read (long long *result)
	Internal function to read in a value. More...

int	Read (unsigned long long *result)
	Internal function to read in a value. More...

int	Read (float *)
	Internal function to read in a value. More...

int	Read (double *)
	Internal function to read in a value. More...

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()
	Check whether this algorithm has an assigned executive. More...

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive. More...

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive. More...

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

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port. More...

vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port. More...

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	UpdateProgress (double amount)
	Update the progress of the process object. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	String based versions of SetInputArrayToProcess(). More...

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm. More...

void	RemoveAllInputs ()
	Remove all the input data. More...

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port. More...

vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection. More...

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)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm. More...

vtkAlgorithmOutput *	GetOutputPort ()

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

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port. More...

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair. More...

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0). More...

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection. More...

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0) More...

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection. More...

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0) More...

vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port. More...

virtual int	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 int	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]=0)
	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]=0)
	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...

int	SetUpdateExtentToWholeExtent (int port)
	If the whole output extent is required, this method can be called to set the output update extent to the whole extent. More...

int	SetUpdateExtentToWholeExtent ()
	Convenience function equivalent to SetUpdateExtentToWholeExtent(0) This method assumes that the whole extent is known (that UpdateInformation has been called). More...

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
	Set the output update extent in terms of piece and ghost levels. More...

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)
	Convenience function equivalent to SetUpdateExtent(0, piece, numPieces, ghostLevel) More...

void	SetUpdateExtent (int port, int extent[6])
	Set the output update extent for data objects that use 3D extents. More...

void	SetUpdateExtent (int extent[6])
	Convenience function equivalent to SetUpdateExtent(0, extent) More...

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm. More...

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm. More...

void	Register (vtkObjectBase *o) override
	Participate in garbage collection. More...

void	UnRegister (vtkObjectBase *o) override
	Participate in garbage collection. More...

virtual void	SetAbortExecute (int)
	Set/Get the AbortExecute flag for the process object. More...

virtual int	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	SetProgress (double)
	Set/Get the execution progress of a process object. More...

virtual double	GetProgress ()
	Set/Get the execution progress of a process object. More...

void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state. More...

virtual char *	GetProgressText ()
	Set the current text message associated with the progress state. More...

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)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index. More...

virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index. More...

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...

virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...

virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date. More...

virtual void	Update ()
	Bring this algorithm's outputs up-to-date. More...

virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports. More...

virtual int	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports. More...

void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports. More...

void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports. More...

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)
	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 *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents. More...

int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents. More...

int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents. More...

void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...

virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...

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

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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)
	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, 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)
	This method invokes an event and return whether the event was aborted or not. More...

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

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkStructuredPointsReader *	New ()

static int	IsTypeOf (const char *type)

static vtkStructuredPointsReader *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkDataReader
static vtkDataReader *	New ()

static int	IsTypeOf (const char *type)

static vtkDataReader *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements. More...

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...

static vtkInformationIntegerKey *	CAN_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 vtkObject *	New ()
	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 ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkStructuredPointsReader ()

	~vtkStructuredPointsReader ()

virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual int	FillOutputPortInformation (int, vtkInformation *)
	Fill the output port information objects for this algorithm. More...

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	ReadEdgeFlags (vtkDataSetAttributes *a, int num)

int	ReadInformation (vtkInformation *info, int 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...

virtual int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector )
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. More...

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )

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

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive. 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)

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)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (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...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (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...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...

virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file. More...

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=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute

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

int	FileMajorVersion

int	FileMinorVersion

vtkCharArray *	InputArray

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file. More...

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

read vtk structured points data file

vtkStructuredPointsReader is a source object that reads ASCII or binary structured points data files in vtk format (see text for format details). The output of this reader is a single vtkStructuredPoints data object. 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: vtkStructuredPoints vtkDataReader

Examples:: vtkStructuredPointsReader (Examples)

Tests:: vtkStructuredPointsReader (Tests)

Definition at line 45 of file vtkStructuredPointsReader.h.

Member Typedef Documentation

typedef vtkDataReader vtkStructuredPointsReader::Superclass

Definition at line 49 of file vtkStructuredPointsReader.h.

Constructor & Destructor Documentation

vtkStructuredPointsReader::vtkStructuredPointsReader ( )

protected

vtkStructuredPointsReader::~vtkStructuredPointsReader ( )

protected

Member Function Documentation

static vtkStructuredPointsReader* vtkStructuredPointsReader::New ( )

static

static int vtkStructuredPointsReader::IsTypeOf ( const char * type )

static

virtual int vtkStructuredPointsReader::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 vtkStructuredPointsReader* vtkStructuredPointsReader::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkStructuredPointsReader::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDataReader.

vtkStructuredPointsReader* vtkStructuredPointsReader::NewInstance ( ) const

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

void vtkStructuredPointsReader::SetOutput ( vtkStructuredPoints * output )

Set/Get the output of this reader.

vtkStructuredPoints* vtkStructuredPointsReader::GetOutput ( int idx )

Set/Get the output of this reader.

vtkStructuredPoints* vtkStructuredPointsReader::GetOutput ( )

Set/Get the output of this reader.

virtual int vtkStructuredPointsReader::ReadMetaData ( vtkInformation * outInfo )

virtual

Read the meta information from the file.

This needs to be public to it can be accessed by vtkDataSetReader.

Reimplemented from vtkDataReader.

virtual int vtkStructuredPointsReader::RequestData	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

protectedvirtual

Reimplemented from vtkDataReader.

virtual int vtkStructuredPointsReader::RequestInformation	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

protectedvirtual

Reimplemented from vtkDataReader.

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

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/IO/Legacy/vtkStructuredPointsReader.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation