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

Read VTK XML Table files. More...

#include <vtkXMLTableReader.h>

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

Public Types

typedef vtkXMLReader Superclass
 
- Public Types inherited from vtkXMLReader
enum  FieldType { POINT_DATA, CELL_DATA, OTHER }
 
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...
 
vtkXMLTableReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkIdType GetNumberOfRows ()
 Get the number of rows in the output. More...
 
vtkIdType GetNumberOfPieces ()
 Get the number of pieces in the file. More...
 
void SetupUpdateExtent (int piece, int numberOfPieces)
 Setup the reader as if the given update extent were requested by its output. More...
 
void CopyOutputInformation (vtkInformation *outInfo, int port) override
 For the specified port, copy the information this reader sets up in SetupOutputInformation to outInfo. More...
 
vtkTableGetOutput ()
 Get the reader's output. More...
 
vtkTableGetOutput (int idx)
 Get the reader's output. More...
 
- Public Member Functions inherited from vtkXMLReader
vtkXMLReaderNewInstance () const
 
virtual int CanReadFile (const char *name)
 Test whether the file (type) with the given name can be read by this reader. More...
 
virtual void CopyOutputInformation (vtkInformation *vtkNotUsed(outInfo), int vtkNotUsed(port))
 
virtual int GetNumberOfTimeSteps ()
 
vtkXMLDataParserGetXMLParser ()
 Returns the internal XML parser. More...
 
int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. More...
 
virtual void SetFileName (const char *)
 Get/Set the name of the input file. More...
 
virtual char * GetFileName ()
 Get/Set the name of the input file. More...
 
virtual void SetReadFromInputString (vtkTypeBool)
 Enable reading from an InputString instead of the default, a file. More...
 
virtual vtkTypeBool GetReadFromInputString ()
 Enable reading from an InputString instead of the default, a file. More...
 
virtual void ReadFromInputStringOn ()
 Enable reading from an InputString instead of the default, a file. More...
 
virtual void ReadFromInputStringOff ()
 Enable reading from an InputString instead of the default, a file. More...
 
void SetInputString (const std::string &s)
 Enable reading from an InputString instead of the default, a file. More...
 
vtkDataSetGetOutputAsDataSet ()
 Get the output as a vtkDataSet pointer. More...
 
vtkDataSetGetOutputAsDataSet (int index)
 Get the output as a vtkDataSet pointer. More...
 
virtual vtkDataArraySelectionGetPointDataArraySelection ()
 Get the data array selection tables used to configure which data arrays are loaded by the reader. More...
 
virtual vtkDataArraySelectionGetCellDataArraySelection ()
 Get the data array selection tables used to configure which data arrays are loaded by the reader. More...
 
virtual vtkDataArraySelectionGetColumnArraySelection ()
 Get the data array selection tables used to configure which data arrays are loaded by the reader. More...
 
int GetNumberOfPointArrays ()
 Get the number of point, cell or column arrays available in the input. More...
 
int GetNumberOfCellArrays ()
 Get the number of point, cell or column arrays available in the input. More...
 
int GetNumberOfColumnArrays ()
 Get the number of point, cell or column arrays available in the input. More...
 
const char * GetPointArrayName (int index)
 Get the name of the point, cell or column array with the given index in the input. More...
 
const char * GetCellArrayName (int index)
 Get the name of the point, cell or column array with the given index in the input. More...
 
const char * GetColumnArrayName (int index)
 Get the name of the point, cell or column array with the given index in the input. More...
 
int GetPointArrayStatus (const char *name)
 Get/Set whether the point, cell or column array with the given name is to be read. More...
 
int GetCellArrayStatus (const char *name)
 Get/Set whether the point, cell or column array with the given name is to be read. More...
 
void SetPointArrayStatus (const char *name, int status)
 Get/Set whether the point, cell or column array with the given name is to be read. More...
 
void SetCellArrayStatus (const char *name, int status)
 Get/Set whether the point, cell or column array with the given name is to be read. More...
 
int GetColumnArrayStatus (const char *name)
 Get/Set whether the point, cell or column array with the given name is to be read. More...
 
void SetColumnArrayStatus (const char *name, int status)
 Get/Set whether the point, cell or column array with the given name is to be read. More...
 
virtual void SetTimeStep (int)
 Which TimeStep to read. More...
 
virtual int GetTimeStep ()
 Which TimeStep to read. More...
 
virtual intGetTimeStepRange ()
 Which TimeStepRange to read. More...
 
virtual void GetTimeStepRange (int &, int &)
 Which TimeStepRange to read. More...
 
virtual void GetTimeStepRange (int[2])
 Which TimeStepRange to read. More...
 
virtual void SetTimeStepRange (int, int)
 Which TimeStepRange to read. More...
 
void SetTimeStepRange (int[2])
 Which TimeStepRange to read. More...
 
void SetReaderErrorObserver (vtkCommand *)
 Set/get the ErrorObserver for the internal reader This is useful for applications that want to catch error messages. More...
 
virtual vtkCommandGetReaderErrorObserver ()
 Set/get the ErrorObserver for the internal reader This is useful for applications that want to catch error messages. More...
 
void SetParserErrorObserver (vtkCommand *)
 Set/get the ErrorObserver for the internal xml parser This is useful for applications that want to catch error messages. More...
 
virtual vtkCommandGetParserErrorObserver ()
 Set/get the ErrorObserver for the internal xml parser This is useful for applications that want to catch error messages. 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...
 
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...
 
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...
 
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 SetProgress (double)
 SetProgress is deprecated. 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...
 
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 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 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]=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 vtkInformationGetInformation ()
 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 (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool 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 double GetProgress ()
 Get the execution progress of a 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 ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. 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...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (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 vtkProgressObserverGetProgressObserver ()
 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 ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool 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...
 
vtkCommandGetCommand (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...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool 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 vtkTypeBool IsTypeOf (const char *type)
 
static vtkXMLTableReaderSafeDownCast (vtkObjectBase *o)
 
static vtkXMLTableReaderNew ()
 
- Static Public Member Functions inherited from vtkXMLReader
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkXMLReaderSafeDownCast (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 ()
 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkXMLTableReader ()
 
 ~vtkXMLTableReader () override
 
int ColumnIsEnabled (vtkXMLDataElement *eRowData)
 Check whether the given array element is an enabled array. More...
 
void DestroyPieces ()
 
const char * GetDataSetName () override
 Get the name of the data set being read. More...
 
void GetOutputUpdateExtent (int &piece, int &numberOfPieces)
 Get the current piece index and the total number of piece in the dataset. More...
 
int RowDataNeedToReadTimeStep (vtkXMLDataElement *eNested)
 Specify the last time step read, useful to know if we need to read data. More...
 
void SetupEmptyOutput () override
 Initialize current output. More...
 
void SetupOutputTotals ()
 Initialize the total number of rows to be read. More...
 
void SetupNextPiece ()
 Initialize the index of the first row to be read in the next piece. More...
 
void SetupOutputData () override
 Initialize current output data: allocate arrays for RowData. More...
 
void SetupOutputInformation (vtkInformation *outInfo) override
 Setup the output's information. More...
 
void SetupPieces (int numPieces)
 Setup the number of pieces to be read and allocate space accordingly. More...
 
void ReadXMLData () override
 Pipeline execute data driver. More...
 
int ReadPrimaryElement (vtkXMLDataElement *ePrimary) override
 Pipeline execute data driver. More...
 
int ReadPiece (vtkXMLDataElement *ePiece, int piece)
 Setup the piece reader at the given index. More...
 
int ReadPiece (vtkXMLDataElement *ePiece)
 Setup the current piece reader. More...
 
int ReadPieceData (int)
 Actually read the current piece data. More...
 
int FillOutputPortInformation (int, vtkInformation *) override
 Fill the output port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkXMLReader
 vtkXMLReader ()
 
 ~vtkXMLReader () override
 
virtual int ReadXMLInformation ()
 
virtual int CanReadFileVersion (int major, int minor)
 
virtual void SetupOutputInformation (vtkInformation *vtkNotUsed(outInfo))
 
virtual int ReadVTKFile (vtkXMLDataElement *eVTKFile)
 
int GetLocalDataType (vtkXMLDataElement *da, int datatype)
 If the IdType argument is present in the provided XMLDataElement and the provided dataType has the same size with VTK_ID_TYPE on this build of VTK, returns VTK_ID_TYPE. More...
 
vtkAbstractArrayCreateArray (vtkXMLDataElement *da)
 
int CreateInformationKey (vtkXMLDataElement *eInfoKey, vtkInformation *info)
 
bool ReadInformation (vtkXMLDataElement *infoRoot, vtkInformation *info)
 
virtual int OpenStream ()
 
virtual void CloseStream ()
 
virtual int OpenVTKFile ()
 
virtual void CloseVTKFile ()
 
virtual int OpenVTKString ()
 
virtual void CloseVTKString ()
 
virtual void CreateXMLParser ()
 
virtual void DestroyXMLParser ()
 
void SetupCompressor (const char *type)
 
int CanReadFileVersionString (const char *version)
 
virtual int CanReadFileWithDataType (const char *dsname)
 This method is used by CanReadFile() to check if the reader can read an XML with the primary element with the given name. More...
 
virtual int GetFileMajorVersion ()
 
virtual int GetFileMinorVersion ()
 
int IntersectExtents (int *extent1, int *extent2, int *result)
 
int Min (int a, int b)
 
int Max (int a, int b)
 
void ComputePointDimensions (int *extent, int *dimensions)
 
void ComputePointIncrements (int *extent, vtkIdType *increments)
 
void ComputeCellDimensions (int *extent, int *dimensions)
 
void ComputeCellIncrements (int *extent, vtkIdType *increments)
 
vtkIdType GetStartTuple (int *extent, vtkIdType *increments, int i, int j, int k)
 
void ReadAttributeIndices (vtkXMLDataElement *eDSA, vtkDataSetAttributes *dsa)
 
char ** CreateStringArray (int numStrings)
 
void DestroyStringArray (int numStrings, char **strings)
 
virtual int ReadArrayValues (vtkXMLDataElement *da, vtkIdType arrayIndex, vtkAbstractArray *array, vtkIdType startIndex, vtkIdType numValues, FieldType type=OTHER)
 
void SetDataArraySelections (vtkXMLDataElement *eDSA, vtkDataArraySelection *sel)
 
int SetFieldDataInfo (vtkXMLDataElement *eDSA, int association, vtkIdType numTuples, vtkInformationVector *(&infoVector))
 
int PointDataArrayIsEnabled (vtkXMLDataElement *ePDA)
 
int CellDataArrayIsEnabled (vtkXMLDataElement *eCDA)
 
virtual void SqueezeOutputArrays (vtkDataObject *)
 
virtual void GetProgressRange (float *range)
 
virtual void SetProgressRange (const float range[2], int curStep, int numSteps)
 
virtual void SetProgressRange (const float range[2], int curStep, const float *fractions)
 
virtual void UpdateProgressDiscrete (float progress)
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestDataObject (vtkInformation *vtkNotUsed(request), vtkInformationVector **vtkNotUsed(inputVector), vtkInformationVector *vtkNotUsed(outputVector))
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
void SetNumberOfTimeSteps (int num)
 
vtkDataObjectGetCurrentOutput ()
 
vtkInformationGetCurrentOutputInformation ()
 
virtual void ConvertGhostLevelsToGhostType (FieldType, vtkAbstractArray *, vtkIdType, vtkIdType)
 
void ReadFieldData ()
 
- 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...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 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...
 
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)
 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, 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)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 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, 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)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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=nullptr)
 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 &)
 

Protected Attributes

int UpdatedPiece
 The update request. More...
 
int UpdateNumberOfPieces
 
int StartPiece
 The range of pieces from the file that will form the UpdatedPiece. More...
 
int EndPiece
 
vtkIdType TotalNumberOfRows
 
vtkIdType StartPoint
 
vtkXMLDataElement ** RowElements
 The Points element for each piece. More...
 
vtkIdTypeNumberOfRows
 
int NumberOfPieces
 The number of Pieces of data found in the file. More...
 
int Piece
 The piece currently being read. More...
 
vtkXMLDataElement ** RowDataElements
 The RowData element representations for each piece. More...
 
int NumberOfColumns
 The number of columns arrays in the output. More...
 
intRowDataTimeStep
 
vtkTypeInt64 * RowDataOffset
 
- Protected Attributes inherited from vtkXMLReader
vtkXMLDataParserXMLParser
 
vtkXMLDataElementFieldDataElement
 
char * FileName
 
istream * Stream
 
vtkTypeBool ReadFromInputString
 
std::string InputString
 
vtkDataArraySelectionPointDataArraySelection
 
vtkDataArraySelectionCellDataArraySelection
 
vtkDataArraySelectionColumnArraySelection
 
vtkCallbackCommandSelectionObserver
 
int InformationError
 
int DataError
 
float ProgressRange [2]
 
vtkTimeStamp ReadMTime
 
int ReadError
 
int AxesEmpty [3]
 
int TimeStep
 
int CurrentTimeStep
 
int NumberOfTimeSteps
 
intTimeSteps
 
int TimeStepRange [2]
 
int InReadData
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
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
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkXMLReader
static void SelectionModifiedCallback (vtkObject *caller, unsigned long eid, void *clientdata, void *calldata)
 
static int IsTimeStepInArray (int timestep, int *timesteps, int length)
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

Read VTK XML Table files.

vtkXMLTableReader provides a functionality for reading .vtt files as vtkTable

Tests:
vtkXMLTableReader (Tests)

Definition at line 38 of file vtkXMLTableReader.h.

Member Typedef Documentation

Definition at line 41 of file vtkXMLTableReader.h.

Constructor & Destructor Documentation

vtkXMLTableReader::vtkXMLTableReader ( )
protected
vtkXMLTableReader::~vtkXMLTableReader ( )
overrideprotected

Member Function Documentation

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

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

Reimplemented from vtkXMLReader.

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

static vtkXMLTableReader* vtkXMLTableReader::New ( )
static
vtkTable* vtkXMLTableReader::GetOutput ( )

Get the reader's output.

vtkTable* vtkXMLTableReader::GetOutput ( int  idx)

Get the reader's output.

vtkIdType vtkXMLTableReader::GetNumberOfRows ( )

Get the number of rows in the output.

vtkIdType vtkXMLTableReader::GetNumberOfPieces ( )

Get the number of pieces in the file.

void vtkXMLTableReader::SetupUpdateExtent ( int  piece,
int  numberOfPieces 
)

Setup the reader as if the given update extent were requested by its output.

This can be used after an UpdateInformation to validate GetNumberOfPoints() and GetNumberOfCells() without actually reading data.

void vtkXMLTableReader::CopyOutputInformation ( vtkInformation outInfo,
int  port 
)
override

For the specified port, copy the information this reader sets up in SetupOutputInformation to outInfo.

int vtkXMLTableReader::ColumnIsEnabled ( vtkXMLDataElement eRowData)
protected

Check whether the given array element is an enabled array.

void vtkXMLTableReader::DestroyPieces ( )
protected
const char* vtkXMLTableReader::GetDataSetName ( )
overrideprotectedvirtual

Get the name of the data set being read.

Implements vtkXMLReader.

void vtkXMLTableReader::GetOutputUpdateExtent ( int piece,
int numberOfPieces 
)
protected

Get the current piece index and the total number of piece in the dataset.

int vtkXMLTableReader::RowDataNeedToReadTimeStep ( vtkXMLDataElement eNested)
protected

Specify the last time step read, useful to know if we need to read data.

void vtkXMLTableReader::SetupEmptyOutput ( )
overrideprotectedvirtual

Initialize current output.

Implements vtkXMLReader.

void vtkXMLTableReader::SetupOutputTotals ( )
protected

Initialize the total number of rows to be read.

void vtkXMLTableReader::SetupNextPiece ( )
protected

Initialize the index of the first row to be read in the next piece.

void vtkXMLTableReader::SetupOutputData ( )
overrideprotectedvirtual

Initialize current output data: allocate arrays for RowData.

Reimplemented from vtkXMLReader.

void vtkXMLTableReader::SetupOutputInformation ( vtkInformation outInfo)
overrideprotected

Setup the output's information.

void vtkXMLTableReader::SetupPieces ( int  numPieces)
protected

Setup the number of pieces to be read and allocate space accordingly.

void vtkXMLTableReader::ReadXMLData ( )
overrideprotectedvirtual

Pipeline execute data driver.

Called by vtkXMLReader.

Reimplemented from vtkXMLReader.

int vtkXMLTableReader::ReadPrimaryElement ( vtkXMLDataElement ePrimary)
overrideprotectedvirtual

Pipeline execute data driver.

Called by vtkXMLReader.

Reimplemented from vtkXMLReader.

int vtkXMLTableReader::ReadPiece ( vtkXMLDataElement ePiece,
int  piece 
)
protected

Setup the piece reader at the given index.

int vtkXMLTableReader::ReadPiece ( vtkXMLDataElement ePiece)
protected

Setup the current piece reader.

int vtkXMLTableReader::ReadPieceData ( int  )
protected

Actually read the current piece data.

int vtkXMLTableReader::FillOutputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

Fill the output port information objects for this algorithm.

This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAlgorithm.

Member Data Documentation

int vtkXMLTableReader::UpdatedPiece
protected

The update request.

Definition at line 163 of file vtkXMLTableReader.h.

int vtkXMLTableReader::UpdateNumberOfPieces
protected

Definition at line 164 of file vtkXMLTableReader.h.

int vtkXMLTableReader::StartPiece
protected

The range of pieces from the file that will form the UpdatedPiece.

Definition at line 168 of file vtkXMLTableReader.h.

int vtkXMLTableReader::EndPiece
protected

Definition at line 169 of file vtkXMLTableReader.h.

vtkIdType vtkXMLTableReader::TotalNumberOfRows
protected

Definition at line 170 of file vtkXMLTableReader.h.

vtkIdType vtkXMLTableReader::StartPoint
protected

Definition at line 171 of file vtkXMLTableReader.h.

vtkXMLDataElement** vtkXMLTableReader::RowElements
protected

The Points element for each piece.

Definition at line 176 of file vtkXMLTableReader.h.

vtkIdType* vtkXMLTableReader::NumberOfRows
protected

Definition at line 177 of file vtkXMLTableReader.h.

int vtkXMLTableReader::NumberOfPieces
protected

The number of Pieces of data found in the file.

Definition at line 182 of file vtkXMLTableReader.h.

int vtkXMLTableReader::Piece
protected

The piece currently being read.

Definition at line 187 of file vtkXMLTableReader.h.

vtkXMLDataElement** vtkXMLTableReader::RowDataElements
protected

The RowData element representations for each piece.

Definition at line 192 of file vtkXMLTableReader.h.

int vtkXMLTableReader::NumberOfColumns
protected

The number of columns arrays in the output.

Valid after SetupOutputData has been called.

Definition at line 198 of file vtkXMLTableReader.h.

int* vtkXMLTableReader::RowDataTimeStep
protected

Definition at line 200 of file vtkXMLTableReader.h.

vtkTypeInt64* vtkXMLTableReader::RowDataOffset
protected

Definition at line 201 of file vtkXMLTableReader.h.


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