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

A concrete class to read an ASCII Tecplot file. More...

#include <vtkTecplotReader.h>

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

Public Types

typedef vtkMultiBlockDataSetAlgorithm Superclass
 
- Public Types inherited from vtkMultiBlockDataSetAlgorithm
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...
 
vtkTecplotReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual int GetNumberOfVariables ()
 Get the number of all variables (including 3D coordinates). More...
 
void SetFileName (const char *fileName)
 Specify a Tecplot ASCII file for data loading. More...
 
const char * GetDataTitle ()
 Get the Tecplot data title. More...
 
int GetNumberOfBlocks ()
 Get the number of blocks (i.e., zones in Tecplot terms). More...
 
const char * GetBlockName (int blockIdx)
 Get the name of a block specified by a zero-based index. More...
 
int GetNumberOfDataAttributes ()
 Get the number of standard data attributes (node-based and cell-based), excluding 3D coordinates. More...
 
const char * GetDataAttributeName (int attrIndx)
 Get the name of a zero-based data attribute (not 3D coordinates). More...
 
int IsDataAttributeCellBased (const char *attrName)
 Get the type (0 for node-based and 1 for cell-based) of a specified data attribute (not 3D coordinates). More...
 
int IsDataAttributeCellBased (int attrIndx)
 Get the type (0 for node-based and 1 for cell-based) of a specified data attribute (not 3D coordinates). More...
 
int GetNumberOfDataArrays ()
 Get the number of all data attributes (point data and cell data). More...
 
const char * GetDataArrayName (int arrayIdx)
 Get the name of a data array specified by the zero-based index (arrayIdx). More...
 
int GetDataArrayStatus (const char *arayName)
 Get the status of a specific data array (0: un-selected; 1: selected). More...
 
void SetDataArrayStatus (const char *arayName, int bChecked)
 Set the status of a specific data array (0: de-select; 1: select) specified by the name. More...
 
- Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
vtkMultiBlockDataSetAlgorithmNewInstance () const
 
vtkMultiBlockDataSetGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkMultiBlockDataSetGetOutput (int)
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 see vtkAlgorithm for details 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 vtkTecplotReaderNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkTecplotReaderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
static vtkMultiBlockDataSetAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkMultiBlockDataSetAlgorithmSafeDownCast (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
 
 vtkTecplotReader ()
 
 ~vtkTecplotReader () override
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 This is called by the superclass. More...
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
void Init ()
 This function initializes the context. More...
 
void GetDataArraysList ()
 Get the data arrays list from the tecplot file header. More...
 
void ReadFile (vtkMultiBlockDataSet *multZone)
 This function, the data loading engine, parses the Tecplot file to fill a vtkMultiBlockDataSet object. More...
 
void GetArraysFromBlockPackingZone (int numNodes, int numCells, vtkPoints *theNodes, vtkPointData *nodeData, vtkCellData *cellData)
 This function extracts each variable array from a block-packing (component- based) zone and collects the 3D point coordinates in addition to data attributes (node-based and / or cell-based). More...
 
void GetArraysFromPointPackingZone (int numNodes, vtkPoints *theNodes, vtkPointData *nodeData)
 This function extracts each variable array from a point-packing (tuple- based) zone and collects the 3D point coordbinates in addition to data attributes (node-based and / or cell-based). More...
 
void GetStructuredGridFromBlockPackingZone (int iDimSize, int jDimSize, int kDimSize, int zoneIndx, const char *zoneName, vtkMultiBlockDataSet *multZone)
 This function creates a vtkStructuredGrid object made up of a set of points and the associated attributes (node-based and / or cell-based) extracted from a block-packing (i.e., component-based) zone. More...
 
void GetStructuredGridFromPointPackingZone (int iDimSize, int jDimSize, int kDimSize, int zoneIndx, const char *zoneName, vtkMultiBlockDataSet *multZone)
 This function creates a vtkStructuredGrid object made up of a set of points and the associated attributes (node-based and / or cell-based) extracted from a point-packing (i.e., tuple-based) zone. More...
 
void GetUnstructuredGridFromBlockPackingZone (int numNodes, int numCells, const char *cellType, int zoneIndx, const char *zoneName, vtkMultiBlockDataSet *multZone)
 This function creates a vtkUnstructuredGrid object made up of a set of points and the associated attributes (node-based and / or cell-based) extracted from a block-packing (i.e., component-based) zone. More...
 
void GetPolyhedralGridFromBlockPackingZone (int numNodes, int numElements, int numFaces, int zoneIndex, const char *zoneName, vtkMultiBlockDataSet *multZone)
 This function creates a polyhedral vtkUnstructuredGrid object made up of a set of points and the associated attributes (node-based and / or cell-based) extracted from a block-packing (i.e., component-based) zone. More...
 
void GetPolygonalGridFromBlockPackingZone (int numNodes, int numElements, int numFaces, int zoneIndex, const char *zoneName, vtkMultiBlockDataSet *multZone)
 This function creates a polygonal vtkUnstructuredGrid object made up of a set of points and the associated attributes (node-based and / or cell-based) extracted from a block-packing (i.e., component-based) zone. More...
 
void GetPolyhedralGridCells (int numberCells, int numFaces, vtkUnstructuredGrid *unstruct) const
 This function fills an allocated vtkUnstructuredGrid object with numberCells polyhedral cells to define the grid topology. More...
 
void GetPolygonalGridCells (int numFaces, int numEdges, vtkUnstructuredGrid *unstruct) const
 This function fills an allocated vtkUnstructuredGrid object with numberCells polygonal cells to define the grid topology. More...
 
void GetUnstructuredGridFromPointPackingZone (int numNodes, int numCells, const char *cellType, int zoneIndx, const char *zoneName, vtkMultiBlockDataSet *multZone)
 This function creates a vtkUnstructuredGrid object made up of a set of points and the associated attributes (node-based and / or cell-based) extracted from a point-packing (i.e., tuple-based) zone. More...
 
void GetUnstructuredGridCells (int numberCells, const char *cellTypeStr, vtkUnstructuredGrid *unstrctGrid)
 This function fills an allocated vtkUnstructuredGrid object with numberCells cells of type cellTypeStr to define the grid topology. More...
 
- Protected Member Functions inherited from vtkMultiBlockDataSetAlgorithm
 vtkMultiBlockDataSetAlgorithm ()
 
 ~vtkMultiBlockDataSetAlgorithm () override
 
virtual int RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
vtkExecutiveCreateDefaultExecutive () override
 Create a default executive. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
vtkDataObjectGetInput (int port)
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
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 &)
 

Static Protected Member Functions

static void SelectionModifiedCallback (vtkObject *, unsigned long, void *tpReader, void *)
 A callback function registered with the selection observer. More...
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 

Protected Attributes

int NumberOfVariables
 
char * FileName
 
vtkCallbackCommandSelectionObserver
 
vtkDataArraySelectionDataArraySelection
 
vtkTecplotReaderInternal * Internal
 
std::string DataTitle
 
std::vector< intCellBased
 
std::vector< std::string > ZoneNames
 
std::vector< std::string > Variables
 
- 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 Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

A concrete class to read an ASCII Tecplot file.

vtkTecplotReader parses an ASCII Tecplot file to get a vtkMultiBlockDataSet object made up of several vtkDataSet objects, of which each is of type either vtkStructuredGrid or vtkUnstructuredGrid. Each vtkDataSet object maintains the geometry, topology, and some associated attributes describing physical properties.

Tecplot treats 3D coordinates (only one or two coordinates might be explicitly specified in a file) as variables too, whose names (e.g., 'X' / 'x' / 'I', 'Y' / 'y' / 'J', 'Z' / 'z' / 'K') are provided in the variables list (the 'VARIABLES' section). These names are then followed in the list by those of other traditional variables or attributes (node- based and / or cell-based data with the mode specified via token 'VAR LOCATION', to be extracted to create vtkPointData and / or vtkCellData). Each zone described afterwards (in the 'ZONE's section) provides the specific values of the aforementioned variables (including 3D coordinates), in the same order as indicated by the variable-names list, through either POINT-packing (i.e., tuple-based storage) or BLOCK-packing (component-based storage). In particular, the first / description line of each zone tells the type of all the constituent cells as the connectivity / topology information. In other words, the entire dataset is made up of multiple zones (blocks), of which each maintains a set of cells of the same type ('BRICK', 'TRIANGLE', 'QUADRILATERAL', 'TETRAHEDRON', and 'POINT' in Tecplot terms). In addition, the description line of each zone specifies the zone name, dimensionality information (size of each dimension for a structured zone), number of nodes, and number of cells. Information about the file format is available at http://download.tecplot.com/360/dataformat.pdf.

Warning
vtkTecplotReader is currently a simplified ASCII Tecplot reader and some functionalities (e.g., extraction of sections 'GEOMETRY', 'TEXT', and 'DATA SETAUXDATA', access to multiple time steps, in addition to the construction of vtkRectilinearGrid and vtkImageData objects) are not supported.
Thanks:
This class is a VTK implementation of VisIt's ASCII Tecplot reader.
See also
vtkPoints vtkStructuredGrid vtkUnstructuredGrid vtkPointData vtkCellData vtkDataSet vtkMultiBlockDataSet
Tests:
vtkTecplotReader (Tests)

Definition at line 96 of file vtkTecplotReader.h.

Member Typedef Documentation

◆ Superclass

Definition at line 100 of file vtkTecplotReader.h.

Constructor & Destructor Documentation

◆ vtkTecplotReader()

vtkTecplotReader::vtkTecplotReader ( )
protected

◆ ~vtkTecplotReader()

vtkTecplotReader::~vtkTecplotReader ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkTecplotReader* vtkTecplotReader::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkTecplotReader::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 vtkMultiBlockDataSetAlgorithm.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkTecplotReader::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkMultiBlockDataSetAlgorithm.

◆ NewInstance()

vtkTecplotReader* vtkTecplotReader::NewInstance ( ) const

◆ PrintSelf()

void vtkTecplotReader::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 vtkMultiBlockDataSetAlgorithm.

◆ GetNumberOfVariables()

virtual int vtkTecplotReader::GetNumberOfVariables ( )
virtual

Get the number of all variables (including 3D coordinates).

◆ SetFileName()

void vtkTecplotReader::SetFileName ( const char *  fileName)

Specify a Tecplot ASCII file for data loading.

◆ GetDataTitle()

const char* vtkTecplotReader::GetDataTitle ( )

Get the Tecplot data title.

◆ GetNumberOfBlocks()

int vtkTecplotReader::GetNumberOfBlocks ( )

Get the number of blocks (i.e., zones in Tecplot terms).

◆ GetBlockName()

const char* vtkTecplotReader::GetBlockName ( int  blockIdx)

Get the name of a block specified by a zero-based index.

nullptr is returned for an invalid block index.

◆ GetNumberOfDataAttributes()

int vtkTecplotReader::GetNumberOfDataAttributes ( )

Get the number of standard data attributes (node-based and cell-based), excluding 3D coordinates.

◆ GetDataAttributeName()

const char* vtkTecplotReader::GetDataAttributeName ( int  attrIndx)

Get the name of a zero-based data attribute (not 3D coordinates).

nullptr is returned for an invalid attribute index.

◆ IsDataAttributeCellBased() [1/2]

int vtkTecplotReader::IsDataAttributeCellBased ( const char *  attrName)

Get the type (0 for node-based and 1 for cell-based) of a specified data attribute (not 3D coordinates).

-1 is returned for an invalid attribute name.

◆ IsDataAttributeCellBased() [2/2]

int vtkTecplotReader::IsDataAttributeCellBased ( int  attrIndx)

Get the type (0 for node-based and 1 for cell-based) of a specified data attribute (not 3D coordinates).

-1 is returned for an invalid attribute index.

◆ GetNumberOfDataArrays()

int vtkTecplotReader::GetNumberOfDataArrays ( )

Get the number of all data attributes (point data and cell data).

◆ GetDataArrayName()

const char* vtkTecplotReader::GetDataArrayName ( int  arrayIdx)

Get the name of a data array specified by the zero-based index (arrayIdx).

◆ GetDataArrayStatus()

int vtkTecplotReader::GetDataArrayStatus ( const char *  arayName)

Get the status of a specific data array (0: un-selected; 1: selected).

◆ SetDataArrayStatus()

void vtkTecplotReader::SetDataArrayStatus ( const char *  arayName,
int  bChecked 
)

Set the status of a specific data array (0: de-select; 1: select) specified by the name.

◆ FillOutputPortInformation()

int vtkTecplotReader::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 vtkMultiBlockDataSetAlgorithm.

◆ RequestInformation()

int vtkTecplotReader::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

◆ RequestData()

int vtkTecplotReader::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

◆ SelectionModifiedCallback()

static void vtkTecplotReader::SelectionModifiedCallback ( vtkObject ,
unsigned long  ,
void *  tpReader,
void *   
)
staticprotected

A callback function registered with the selection observer.

◆ Init()

void vtkTecplotReader::Init ( )
protected

This function initializes the context.

Note that the Tecplot file name must NOT be addressed (either specified or inited) in this function. It is addressed in constructor, destructor, and SetTecplotFile() only.

◆ GetDataArraysList()

void vtkTecplotReader::GetDataArraysList ( )
protected

Get the data arrays list from the tecplot file header.

◆ ReadFile()

void vtkTecplotReader::ReadFile ( vtkMultiBlockDataSet multZone)
protected

This function, the data loading engine, parses the Tecplot file to fill a vtkMultiBlockDataSet object.

◆ GetArraysFromBlockPackingZone()

void vtkTecplotReader::GetArraysFromBlockPackingZone ( int  numNodes,
int  numCells,
vtkPoints theNodes,
vtkPointData nodeData,
vtkCellData cellData 
)
protected

This function extracts each variable array from a block-packing (component- based) zone and collects the 3D point coordinates in addition to data attributes (node-based and / or cell-based).

Note that Tecplot treats 3D coordinates as variables too, though three special ones.

◆ GetArraysFromPointPackingZone()

void vtkTecplotReader::GetArraysFromPointPackingZone ( int  numNodes,
vtkPoints theNodes,
vtkPointData nodeData 
)
protected

This function extracts each variable array from a point-packing (tuple- based) zone and collects the 3D point coordbinates in addition to data attributes (node-based and / or cell-based).

Note that Tecplot treats 3D coordinates as variables too, though three special ones. A point-packing zone does not contain any cell data at all, instead it is supposed to contain point data only, if any.

◆ GetStructuredGridFromBlockPackingZone()

void vtkTecplotReader::GetStructuredGridFromBlockPackingZone ( int  iDimSize,
int  jDimSize,
int  kDimSize,
int  zoneIndx,
const char *  zoneName,
vtkMultiBlockDataSet multZone 
)
protected

This function creates a vtkStructuredGrid object made up of a set of points and the associated attributes (node-based and / or cell-based) extracted from a block-packing (i.e., component-based) zone.

This vtkStructuredGrid is then inserted, with a specified zone name, to a vtkMultiBlockDataSet object.

◆ GetStructuredGridFromPointPackingZone()

void vtkTecplotReader::GetStructuredGridFromPointPackingZone ( int  iDimSize,
int  jDimSize,
int  kDimSize,
int  zoneIndx,
const char *  zoneName,
vtkMultiBlockDataSet multZone 
)
protected

This function creates a vtkStructuredGrid object made up of a set of points and the associated attributes (node-based and / or cell-based) extracted from a point-packing (i.e., tuple-based) zone.

This vtkStructuredGrid is then inserted, with a specified zone name, to a vtkMultiBlockDataSet object.

◆ GetUnstructuredGridFromBlockPackingZone()

void vtkTecplotReader::GetUnstructuredGridFromBlockPackingZone ( int  numNodes,
int  numCells,
const char *  cellType,
int  zoneIndx,
const char *  zoneName,
vtkMultiBlockDataSet multZone 
)
protected

This function creates a vtkUnstructuredGrid object made up of a set of points and the associated attributes (node-based and / or cell-based) extracted from a block-packing (i.e., component-based) zone.

This vtkUnstructuredGrid is then inserted, with a specified zone name, to a vtkMultiBlockDataSet object.

◆ GetPolyhedralGridFromBlockPackingZone()

void vtkTecplotReader::GetPolyhedralGridFromBlockPackingZone ( int  numNodes,
int  numElements,
int  numFaces,
int  zoneIndex,
const char *  zoneName,
vtkMultiBlockDataSet multZone 
)
protected

This function creates a polyhedral vtkUnstructuredGrid object made up of a set of points and the associated attributes (node-based and / or cell-based) extracted from a block-packing (i.e., component-based) zone.

This vtkUnstructuredGrid is then inserted, with a specified zone name, to a vtkMultiBlockDataSet object.

◆ GetPolygonalGridFromBlockPackingZone()

void vtkTecplotReader::GetPolygonalGridFromBlockPackingZone ( int  numNodes,
int  numElements,
int  numFaces,
int  zoneIndex,
const char *  zoneName,
vtkMultiBlockDataSet multZone 
)
protected

This function creates a polygonal vtkUnstructuredGrid object made up of a set of points and the associated attributes (node-based and / or cell-based) extracted from a block-packing (i.e., component-based) zone.

This vtkUnstructuredGrid is then inserted, with a specified zone name, to a vtkMultiBlockDataSet object.

◆ GetPolyhedralGridCells()

void vtkTecplotReader::GetPolyhedralGridCells ( int  numberCells,
int  numFaces,
vtkUnstructuredGrid unstruct 
) const
protected

This function fills an allocated vtkUnstructuredGrid object with numberCells polyhedral cells to define the grid topology.

◆ GetPolygonalGridCells()

void vtkTecplotReader::GetPolygonalGridCells ( int  numFaces,
int  numEdges,
vtkUnstructuredGrid unstruct 
) const
protected

This function fills an allocated vtkUnstructuredGrid object with numberCells polygonal cells to define the grid topology.

◆ GetUnstructuredGridFromPointPackingZone()

void vtkTecplotReader::GetUnstructuredGridFromPointPackingZone ( int  numNodes,
int  numCells,
const char *  cellType,
int  zoneIndx,
const char *  zoneName,
vtkMultiBlockDataSet multZone 
)
protected

This function creates a vtkUnstructuredGrid object made up of a set of points and the associated attributes (node-based and / or cell-based) extracted from a point-packing (i.e., tuple-based) zone.

This vtkUnstructuredGrid is then inserted, with a specified zone name, to a vtkMultiBlockDataSet object.

◆ GetUnstructuredGridCells()

void vtkTecplotReader::GetUnstructuredGridCells ( int  numberCells,
const char *  cellTypeStr,
vtkUnstructuredGrid unstrctGrid 
)
protected

This function fills an allocated vtkUnstructuredGrid object with numberCells cells of type cellTypeStr to define the grid topology.

Member Data Documentation

◆ NumberOfVariables

int vtkTecplotReader::NumberOfVariables
protected

Definition at line 321 of file vtkTecplotReader.h.

◆ FileName

char* vtkTecplotReader::FileName
protected

Definition at line 322 of file vtkTecplotReader.h.

◆ SelectionObserver

vtkCallbackCommand* vtkTecplotReader::SelectionObserver
protected

Definition at line 323 of file vtkTecplotReader.h.

◆ DataArraySelection

vtkDataArraySelection* vtkTecplotReader::DataArraySelection
protected

Definition at line 324 of file vtkTecplotReader.h.

◆ Internal

vtkTecplotReaderInternal* vtkTecplotReader::Internal
protected

Definition at line 325 of file vtkTecplotReader.h.

◆ DataTitle

std::string vtkTecplotReader::DataTitle
protected

Definition at line 327 of file vtkTecplotReader.h.

◆ CellBased

std::vector< int > vtkTecplotReader::CellBased
protected

Definition at line 328 of file vtkTecplotReader.h.

◆ ZoneNames

std::vector< std::string > vtkTecplotReader::ZoneNames
protected

Definition at line 329 of file vtkTecplotReader.h.

◆ Variables

std::vector< std::string > vtkTecplotReader::Variables
protected

Definition at line 330 of file vtkTecplotReader.h.


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