ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkTecplotReader Class Reference

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

Inheritance diagram for Kitware.VTK.vtkTecplotReader:
[legend]
Collaboration diagram for Kitware.VTK.vtkTecplotReader:
[legend]

List of all members.

Public Member Functions

 vtkTecplotReader (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkTecplotReader ()
 Undocumented Block.
string GetBlockName (int blockIdx)
 Get the name of a block specified by a zero-based index. NULL is returned for an invalid block index.
string GetDataArrayName (int arrayIdx)
 Get the name of a data array specified by the zero-based index (arrayIdx).
int GetDataArrayStatus (string arayName)
 Get the status of a specific data array (0: un-selected; 1: selected).
string GetDataAttributeName (int attrIndx)
 Get the name of a zero-based data attribute (not 3D coordinates). NULL is returned for an invalid attribute index.
string GetDataTitle ()
 Get the Tecplot data title.
int GetNumberOfBlocks ()
 Get the number of blocks (i.e., zones in Tecplot terms).
int GetNumberOfDataArrays ()
 Get the number of all data attributes (point data and cell data).
int GetNumberOfDataAttributes ()
 Get the number of standard data attributes (node-based and cell-based), excluding 3D coordinates.
virtual int GetNumberOfVariables ()
 Get the number of all variables (including 3D coordinates).
override int IsA (string type)
 Undocumented Block.
int IsDataAttributeCellBased (string 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.
int 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.
new vtkTecplotReader NewInstance ()
 Undocumented Block.
void SetDataArrayStatus (string arayName, int bChecked)
 Set the status of a specific data array (0: de-select; 1: select) specified by the name.
void SetFileName (string fileName)
 Specify a Tecplot ASCII file for data loading.

Static Public Member Functions

static new vtkTecplotReader New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkTecplotReader SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkTecplotReader"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "16vtkTecplotReader"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkTecplotReader_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkTecplotReader_GetBlockName_01 (HandleRef pThis, int blockIdx)
static internal IntPtr vtkTecplotReader_GetDataArrayName_02 (HandleRef pThis, int arrayIdx)
static internal int vtkTecplotReader_GetDataArrayStatus_03 (HandleRef pThis, string arayName)
static internal IntPtr vtkTecplotReader_GetDataAttributeName_04 (HandleRef pThis, int attrIndx)
static internal IntPtr vtkTecplotReader_GetDataTitle_05 (HandleRef pThis)
static internal int vtkTecplotReader_GetNumberOfBlocks_06 (HandleRef pThis)
static internal int vtkTecplotReader_GetNumberOfDataArrays_07 (HandleRef pThis)
static internal int vtkTecplotReader_GetNumberOfDataAttributes_08 (HandleRef pThis)
static internal int vtkTecplotReader_GetNumberOfVariables_09 (HandleRef pThis)
static internal int vtkTecplotReader_IsA_10 (HandleRef pThis, string type)
static internal int vtkTecplotReader_IsDataAttributeCellBased_11 (HandleRef pThis, string attrName)
static internal int vtkTecplotReader_IsDataAttributeCellBased_12 (HandleRef pThis, int attrIndx)
static internal int vtkTecplotReader_IsTypeOf_13 (string type)
static internal IntPtr vtkTecplotReader_NewInstance_15 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkTecplotReader_SafeDownCast_16 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkTecplotReader_SetDataArrayStatus_17 (HandleRef pThis, string arayName, int bChecked)
static internal void vtkTecplotReader_SetFileName_18 (HandleRef pThis, string fileName)

Static Private Member Functions

static vtkTecplotReader ()
 Automatically generated type registration mechanics.

Detailed Description

vtkTecplotReader - A concrete class to read an ASCII Tecplot file.

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

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

vtkPoints vtkStructuredGrid vtkUnstructuredGrid vtkPointData vtkCellData vtkDataSet vtkMultiBlockDataSet


Constructor & Destructor Documentation

static Kitware.VTK.vtkTecplotReader.vtkTecplotReader ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkTecplotReader.vtkTecplotReader ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

override void Kitware.VTK.vtkTecplotReader.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkMultiBlockDataSetAlgorithm.

Get the name of a block specified by a zero-based index. NULL is returned for an invalid block index.

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

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

Get the name of a zero-based data attribute (not 3D coordinates). NULL is returned for an invalid attribute index.

Get the Tecplot data title.

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

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

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

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

override int Kitware.VTK.vtkTecplotReader.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkMultiBlockDataSetAlgorithm.

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.

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.

static new int Kitware.VTK.vtkTecplotReader.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkMultiBlockDataSetAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkMultiBlockDataSetAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkMultiBlockDataSetAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkMultiBlockDataSetAlgorithm.

Here is the call graph for this function:

void Kitware.VTK.vtkTecplotReader.SetDataArrayStatus ( string  arayName,
int  bChecked 
)

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

void Kitware.VTK.vtkTecplotReader.SetFileName ( string  fileName)

Specify a Tecplot ASCII file for data loading.

static internal IntPtr Kitware.VTK.vtkTecplotReader.vtkTecplotReader_GetBlockName_01 ( HandleRef  pThis,
int  blockIdx 
) [private]
static internal IntPtr Kitware.VTK.vtkTecplotReader.vtkTecplotReader_GetDataArrayName_02 ( HandleRef  pThis,
int  arrayIdx 
) [private]
static internal int Kitware.VTK.vtkTecplotReader.vtkTecplotReader_GetDataArrayStatus_03 ( HandleRef  pThis,
string  arayName 
) [private]
static internal IntPtr Kitware.VTK.vtkTecplotReader.vtkTecplotReader_GetDataAttributeName_04 ( HandleRef  pThis,
int  attrIndx 
) [private]
static internal IntPtr Kitware.VTK.vtkTecplotReader.vtkTecplotReader_GetDataTitle_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTecplotReader.vtkTecplotReader_GetNumberOfBlocks_06 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTecplotReader.vtkTecplotReader_GetNumberOfDataArrays_07 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTecplotReader.vtkTecplotReader_GetNumberOfDataAttributes_08 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTecplotReader.vtkTecplotReader_GetNumberOfVariables_09 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTecplotReader.vtkTecplotReader_IsA_10 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkTecplotReader.vtkTecplotReader_IsDataAttributeCellBased_11 ( HandleRef  pThis,
string  attrName 
) [private]
static internal int Kitware.VTK.vtkTecplotReader.vtkTecplotReader_IsDataAttributeCellBased_12 ( HandleRef  pThis,
int  attrIndx 
) [private]
static internal int Kitware.VTK.vtkTecplotReader.vtkTecplotReader_IsTypeOf_13 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkTecplotReader.vtkTecplotReader_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkTecplotReader.vtkTecplotReader_NewInstance_15 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkTecplotReader.vtkTecplotReader_SafeDownCast_16 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkTecplotReader.vtkTecplotReader_SetDataArrayStatus_17 ( HandleRef  pThis,
string  arayName,
int  bChecked 
) [private]
static internal void Kitware.VTK.vtkTecplotReader.vtkTecplotReader_SetFileName_18 ( HandleRef  pThis,
string  fileName 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkTecplotReader.MRClassNameKey = "16vtkTecplotReader" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkMultiBlockDataSetAlgorithm.

new const string Kitware.VTK.vtkTecplotReader.MRFullTypeName = "Kitware.VTK.vtkTecplotReader"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkMultiBlockDataSetAlgorithm.


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