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.vtkTable Class Reference

vtkTable - A table, which contains similar-typed columns of data More...

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

List of all members.

Public Member Functions

 vtkTable (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkTable ()
 Undocumented Block.
void AddColumn (vtkAbstractArray arr)
 Add a column to the table.
override void DeepCopy (vtkDataObject src)
 Shallow/deep copy the data from src into this object.
void Dump (uint colWidth)
 Dump table contents.
override uint GetActualMemorySize ()
 Return the actual size of the data in kilobytes. This number is valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than or equal to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the return value).
override vtkFieldData GetAttributesAsFieldData (int type)
 Returns the attributes of the data object as a vtkFieldData. This returns non-null values in all the same cases as GetAttributes, in addition to the case of FIELD, which will return the field data for any vtkDataObject subclass.
vtkAbstractArray GetColumn (int col)
 Get a column of the table by its column index.
vtkAbstractArray GetColumnByName (string name)
 Get a column of the table by its name.
string GetColumnName (int col)
 Get the name of a column of the table.
override int GetDataObjectType ()
 Return what type of dataset this is.
int GetNumberOfColumns ()
 Get the number of columns in the table.
override int GetNumberOfElements (int type)
 Get the number of elements for a specific attribute type (ROW, etc.).
int GetNumberOfRows ()
 Get the number of rows in the table.
vtkVariantArray GetRow (int row)
 Get a row of the table as a vtkVariantArray which has one entry for each column. NOTE: This version of the method is NOT thread safe.
void GetRow (int row, vtkVariantArray values)
 Get a row of the table as a vtkVariantArray which has one entry for each column.
virtual vtkDataSetAttributes GetRowData ()
 Get/Set the main data (columns) of the table.
override void Initialize ()
 Initialize to an empty table.
int InsertNextBlankRow (double default_num_val)
 Insert a blank row at the end of the table.
int InsertNextRow (vtkVariantArray arr)
 Insert a row specified by a vtkVariantArray. The number of entries in the array should match the number of columns in the table.
override int IsA (string type)
 Undocumented Block.
new vtkTable NewInstance ()
 Undocumented Block.
void RemoveColumn (int col)
 Remove a column from the table by its column index.
void RemoveColumnByName (string name)
 Remove a column from the table by its name.
void RemoveRow (int row)
 Delete a row from the table. Rows below the deleted row are shifted up.
void SetNumberOfRows (int arg0)
 Set the number of rows in the table. Note that memory allocation might be performed as a result of this, but no memory will be released.
void SetRow (int row, vtkVariantArray values)
 Set a row of the table with a vtkVariantArray which has one entry for each column.
virtual void SetRowData (vtkDataSetAttributes data)
 Get/Set the main data (columns) of the table.
override void ShallowCopy (vtkDataObject src)
 Shallow/deep copy the data from src into this object.

Static Public Member Functions

static new vtkTable New ()
 Undocumented Block.
static new vtkTable GetData (vtkInformation info)
 Retrieve the table from vtkInformation.
static new vtkTable GetData (vtkInformationVector v, int i)
 Retrieve the table from vtkInformation.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkTable SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "8vtkTable"
 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 vtkTable_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkTable_AddColumn_01 (HandleRef pThis, HandleRef arr)
static internal void vtkTable_DeepCopy_02 (HandleRef pThis, HandleRef src)
static internal void vtkTable_Dump_03 (HandleRef pThis, uint colWidth)
static internal uint vtkTable_GetActualMemorySize_04 (HandleRef pThis)
static internal IntPtr vtkTable_GetAttributesAsFieldData_05 (HandleRef pThis, int type, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkTable_GetColumn_06 (HandleRef pThis, int col, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkTable_GetColumnByName_07 (HandleRef pThis, string name, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkTable_GetColumnName_08 (HandleRef pThis, int col)
static internal IntPtr vtkTable_GetData_09 (HandleRef info, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkTable_GetData_10 (HandleRef v, int i, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkTable_GetDataObjectType_11 (HandleRef pThis)
static internal int vtkTable_GetNumberOfColumns_12 (HandleRef pThis)
static internal int vtkTable_GetNumberOfElements_13 (HandleRef pThis, int type)
static internal int vtkTable_GetNumberOfRows_14 (HandleRef pThis)
static internal IntPtr vtkTable_GetRow_15 (HandleRef pThis, int row, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkTable_GetRow_16 (HandleRef pThis, int row, HandleRef values)
static internal IntPtr vtkTable_GetRowData_17 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkTable_Initialize_18 (HandleRef pThis)
static internal int vtkTable_InsertNextBlankRow_19 (HandleRef pThis, double default_num_val)
static internal int vtkTable_InsertNextRow_20 (HandleRef pThis, HandleRef arr)
static internal int vtkTable_IsA_21 (HandleRef pThis, string type)
static internal int vtkTable_IsTypeOf_22 (string type)
static internal IntPtr vtkTable_NewInstance_24 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkTable_RemoveColumn_25 (HandleRef pThis, int col)
static internal void vtkTable_RemoveColumnByName_26 (HandleRef pThis, string name)
static internal void vtkTable_RemoveRow_27 (HandleRef pThis, int row)
static internal IntPtr vtkTable_SafeDownCast_28 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkTable_SetNumberOfRows_29 (HandleRef pThis, int arg0)
static internal void vtkTable_SetRow_30 (HandleRef pThis, int row, HandleRef values)
static internal void vtkTable_SetRowData_31 (HandleRef pThis, HandleRef data)
static internal void vtkTable_ShallowCopy_32 (HandleRef pThis, HandleRef src)

Static Private Member Functions

static vtkTable ()
 Automatically generated type registration mechanics.

Detailed Description

vtkTable - A table, which contains similar-typed columns of data

Description vtkTable is a basic data structure for storing columns of data. Internally, columns are stored in a vtkDataSetAttributes structure called RowData. However, using the vtkTable API additionally ensures that every column has the same number of entries, and provides row access (using vtkVariantArray) and single entry access (using vtkVariant).

The field data inherited from vtkDataObject may be used to store metadata related to the table.

Caveats You should use the vtkTable API to change the table data. Performing operations on the object returned by GetRowData() may yield unexpected results. vtkTable does allow the user to set the field data using SetRowData(); the number of rows in the table is determined by the number of tuples in the first array (it is assumed that all arrays are the same length).

Each column added with AddColumn <b>must</b> have its name set to a unique, non-empty string in order for GetValue() to function properly.

Thanks Thanks to Patricia Crossno, Ken Moreland, Andrew Wilson and Brian Wylie from Sandia National Laboratories for their help in developing this class API.


Constructor & Destructor Documentation

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

Automatically generated type registration mechanics.

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

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

Undocumented Block.


Member Function Documentation

Add a column to the table.

override void Kitware.VTK.vtkTable.DeepCopy ( vtkDataObject  src) [virtual]

Shallow/deep copy the data from src into this object.

Reimplemented from Kitware.VTK.vtkDataObject.

override void Kitware.VTK.vtkTable.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.vtkDataObject.

void Kitware.VTK.vtkTable.Dump ( uint  colWidth)

Dump table contents.

override uint Kitware.VTK.vtkTable.GetActualMemorySize ( ) [virtual]

Return the actual size of the data in kilobytes. This number is valid only after the pipeline has updated. The memory size returned is guaranteed to be greater than or equal to the memory required to represent the data (e.g., extra space in arrays, etc. are not included in the return value).

Reimplemented from Kitware.VTK.vtkDataObject.

Returns the attributes of the data object as a vtkFieldData. This returns non-null values in all the same cases as GetAttributes, in addition to the case of FIELD, which will return the field data for any vtkDataObject subclass.

Reimplemented from Kitware.VTK.vtkDataObject.

Here is the call graph for this function:

Get a column of the table by its column index.

Here is the call graph for this function:

Get a column of the table by its name.

Here is the call graph for this function:

Get the name of a column of the table.

static new vtkTable Kitware.VTK.vtkTable.GetData ( vtkInformation  info) [static]

Retrieve the table from vtkInformation.

Reimplemented from Kitware.VTK.vtkDataObject.

Here is the call graph for this function:

static new vtkTable Kitware.VTK.vtkTable.GetData ( vtkInformationVector  v,
int  i 
) [static]

Retrieve the table from vtkInformation.

Reimplemented from Kitware.VTK.vtkDataObject.

Here is the call graph for this function:

override int Kitware.VTK.vtkTable.GetDataObjectType ( ) [virtual]

Return what type of dataset this is.

Reimplemented from Kitware.VTK.vtkDataObject.

Get the number of columns in the table.

override int Kitware.VTK.vtkTable.GetNumberOfElements ( int  type) [virtual]

Get the number of elements for a specific attribute type (ROW, etc.).

Reimplemented from Kitware.VTK.vtkDataObject.

Get the number of rows in the table.

Get a row of the table as a vtkVariantArray which has one entry for each column. NOTE: This version of the method is NOT thread safe.

Here is the call graph for this function:

void Kitware.VTK.vtkTable.GetRow ( int  row,
vtkVariantArray  values 
)

Get a row of the table as a vtkVariantArray which has one entry for each column.

Get/Set the main data (columns) of the table.

Here is the call graph for this function:

override void Kitware.VTK.vtkTable.Initialize ( ) [virtual]

Initialize to an empty table.

Reimplemented from Kitware.VTK.vtkDataObject.

int Kitware.VTK.vtkTable.InsertNextBlankRow ( double  default_num_val)

Insert a blank row at the end of the table.

Insert a row specified by a vtkVariantArray. The number of entries in the array should match the number of columns in the table.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataObject.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataObject.

static new vtkTable Kitware.VTK.vtkTable.New ( ) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataObject.

Remove a column from the table by its column index.

Remove a column from the table by its name.

void Kitware.VTK.vtkTable.RemoveRow ( int  row)

Delete a row from the table. Rows below the deleted row are shifted up.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkDataObject.

Here is the call graph for this function:

Set the number of rows in the table. Note that memory allocation might be performed as a result of this, but no memory will be released.

void Kitware.VTK.vtkTable.SetRow ( int  row,
vtkVariantArray  values 
)

Set a row of the table with a vtkVariantArray which has one entry for each column.

virtual void Kitware.VTK.vtkTable.SetRowData ( vtkDataSetAttributes  data) [virtual]

Get/Set the main data (columns) of the table.

override void Kitware.VTK.vtkTable.ShallowCopy ( vtkDataObject  src) [virtual]

Shallow/deep copy the data from src into this object.

Reimplemented from Kitware.VTK.vtkDataObject.

static internal void Kitware.VTK.vtkTable.vtkTable_AddColumn_01 ( HandleRef  pThis,
HandleRef  arr 
) [private]
static internal void Kitware.VTK.vtkTable.vtkTable_DeepCopy_02 ( HandleRef  pThis,
HandleRef  src 
) [private]
static internal void Kitware.VTK.vtkTable.vtkTable_Dump_03 ( HandleRef  pThis,
uint  colWidth 
) [private]
static internal uint Kitware.VTK.vtkTable.vtkTable_GetActualMemorySize_04 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkTable.vtkTable_GetAttributesAsFieldData_05 ( HandleRef  pThis,
int  type,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkTable.vtkTable_GetColumn_06 ( HandleRef  pThis,
int  col,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkTable.vtkTable_GetColumnByName_07 ( HandleRef  pThis,
string  name,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkTable.vtkTable_GetColumnName_08 ( HandleRef  pThis,
int  col 
) [private]
static internal IntPtr Kitware.VTK.vtkTable.vtkTable_GetData_09 ( HandleRef  info,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkTable.vtkTable_GetData_10 ( HandleRef  v,
int  i,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkTable.vtkTable_GetDataObjectType_11 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTable.vtkTable_GetNumberOfColumns_12 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTable.vtkTable_GetNumberOfElements_13 ( HandleRef  pThis,
int  type 
) [private]
static internal int Kitware.VTK.vtkTable.vtkTable_GetNumberOfRows_14 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkTable.vtkTable_GetRow_15 ( HandleRef  pThis,
int  row,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkTable.vtkTable_GetRow_16 ( HandleRef  pThis,
int  row,
HandleRef  values 
) [private]
static internal IntPtr Kitware.VTK.vtkTable.vtkTable_GetRowData_17 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkTable.vtkTable_Initialize_18 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTable.vtkTable_InsertNextBlankRow_19 ( HandleRef  pThis,
double  default_num_val 
) [private]
static internal int Kitware.VTK.vtkTable.vtkTable_InsertNextRow_20 ( HandleRef  pThis,
HandleRef  arr 
) [private]
static internal int Kitware.VTK.vtkTable.vtkTable_IsA_21 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkTable.vtkTable_IsTypeOf_22 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkTable.vtkTable_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkTable.vtkTable_NewInstance_24 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkTable.vtkTable_RemoveColumn_25 ( HandleRef  pThis,
int  col 
) [private]
static internal void Kitware.VTK.vtkTable.vtkTable_RemoveColumnByName_26 ( HandleRef  pThis,
string  name 
) [private]
static internal void Kitware.VTK.vtkTable.vtkTable_RemoveRow_27 ( HandleRef  pThis,
int  row 
) [private]
static internal IntPtr Kitware.VTK.vtkTable.vtkTable_SafeDownCast_28 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkTable.vtkTable_SetNumberOfRows_29 ( HandleRef  pThis,
int  arg0 
) [private]
static internal void Kitware.VTK.vtkTable.vtkTable_SetRow_30 ( HandleRef  pThis,
int  row,
HandleRef  values 
) [private]
static internal void Kitware.VTK.vtkTable.vtkTable_SetRowData_31 ( HandleRef  pThis,
HandleRef  data 
) [private]
static internal void Kitware.VTK.vtkTable.vtkTable_ShallowCopy_32 ( HandleRef  pThis,
HandleRef  src 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkTable.MRClassNameKey = "8vtkTable" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkDataObject.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkDataObject.


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