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

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

#include <vtkTable.h>

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

Public Types

typedef vtkDataObject Superclass
 
- Public Types inherited from vtkDataObject
enum  FieldAssociations {
  FIELD_ASSOCIATION_POINTS , FIELD_ASSOCIATION_CELLS , FIELD_ASSOCIATION_NONE , FIELD_ASSOCIATION_POINTS_THEN_CELLS ,
  FIELD_ASSOCIATION_VERTICES , FIELD_ASSOCIATION_EDGES , FIELD_ASSOCIATION_ROWS , NUMBER_OF_ASSOCIATIONS
}
 Possible values for the FIELD_ASSOCIATION information entry. More...
 
enum  AttributeTypes {
  POINT , CELL , FIELD , POINT_THEN_CELL ,
  VERTEX , EDGE , ROW , NUMBER_OF_ATTRIBUTE_TYPES
}
 Possible attribute types. More...
 
enum  FieldOperations { FIELD_OPERATION_PRESERVED , FIELD_OPERATION_REINTERPOLATED , FIELD_OPERATION_MODIFIED , FIELD_OPERATION_REMOVED }
 Possible values for the FIELD_OPERATION information entry. 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...
 
vtkTableNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Dump (unsigned int colWidth=16, int rowLimit=-1)
 Dump table contents. More...
 
int GetDataObjectType () override
 Return what type of dataset this is. More...
 
unsigned long GetActualMemorySize () override
 Return the actual size of the data in kibibytes (1024 bytes). More...
 
vtkIdType GetNumberOfRows ()
 Get the number of rows in the table. More...
 
void SetNumberOfRows (vtkIdType)
 Set the number of rows in the table. More...
 
void SqueezeRows ()
 Release previously allocated and now unused memory after performing resizing operations. More...
 
vtkVariantArrayGetRow (vtkIdType row)
 Get a row of the table as a vtkVariantArray which has one entry for each column. More...
 
void GetRow (vtkIdType row, vtkVariantArray *values)
 Get a row of the table as a vtkVariantArray which has one entry for each column. More...
 
void SetRow (vtkIdType row, vtkVariantArray *values)
 Set a row of the table with a vtkVariantArray which has one entry for each column. More...
 
void InsertRow (vtkIdType row)
 Insert a single row at the index. More...
 
void InsertRows (vtkIdType row, vtkIdType n)
 Insert n rows before row. More...
 
vtkIdType InsertNextBlankRow (double default_num_val=0.0)
 Insert a blank row at the end of the table. More...
 
vtkIdType InsertNextRow (vtkVariantArray *values)
 Insert a row at the end of the tablespecified by a vtkVariantArray. More...
 
void RemoveRow (vtkIdType row)
 Delete a single row from the table. More...
 
void RemoveRows (vtkIdType row, vtkIdType n)
 Delete n rows from the table, starting at row. More...
 
void RemoveAllRows ()
 Delete all rows from the table. More...
 
vtkIdType GetNumberOfColumns ()
 Get the number of columns in the table. More...
 
const char * GetColumnName (vtkIdType col)
 
vtkAbstractArrayGetColumnByName (const char *name)
 Get a column of the table by its name. More...
 
vtkIdType GetColumnIndex (const char *name)
 Get the column index for a name. More...
 
vtkAbstractArrayGetColumn (vtkIdType col)
 Get a column of the table by its column index. More...
 
void AddColumn (vtkAbstractArray *arr)
 Add a column to the table. More...
 
void InsertColumn (vtkAbstractArray *arr, vtkIdType index)
 Insert a column into the table at given column index. More...
 
void RemoveColumnByName (const char *name)
 Remove a column from the table by its name. More...
 
void RemoveColumn (vtkIdType col)
 Remove a column from the table by its column index. More...
 
void RemoveAllColumns ()
 Remove all columns from the table. More...
 
vtkVariant GetValue (vtkIdType row, vtkIdType col)
 Retrieve a value in the table by row and column index as a variant. More...
 
vtkVariant GetValueByName (vtkIdType row, const char *col)
 Retrieve a value in the table by row index and column name as a variant. More...
 
void SetValue (vtkIdType row, vtkIdType col, vtkVariant value)
 Set a value in the table by row and column index as a variant. More...
 
void SetValueByName (vtkIdType row, const char *col, vtkVariant value)
 Set a value in the table by row index and column name as a variant. More...
 
void Initialize () override
 Initialize to an empty table. More...
 
vtkFieldDataGetAttributesAsFieldData (int type) override
 Returns the attributes of the data object as a vtkFieldData. More...
 
vtkIdType GetNumberOfElements (int type) override
 Get the number of elements for a specific attribute type (ROW, etc.). More...
 
virtual vtkDataSetAttributesGetRowData ()
 Get/Set the main data (columns) of the table. More...
 
virtual void SetRowData (vtkDataSetAttributes *data)
 Get/Set the main data (columns) of the table. More...
 
void ShallowCopy (vtkDataObject *src) override
 Shallow/deep copy the data from src into this object. More...
 
void DeepCopy (vtkDataObject *src) override
 Shallow/deep copy the data from src into this object. More...
 
- Public Member Functions inherited from vtkDataObject
vtkDataObjectNewInstance () const
 
vtkMTimeType GetMTime () override
 Data objects are composite objects and need to check each part for MTime. More...
 
void ReleaseData ()
 Release data back to system to conserve memory resource. More...
 
vtkMTimeType GetUpdateTime ()
 Used by Threaded ports to determine if they should initiate an asynchronous update (still in development). More...
 
virtual void CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
 Copy from the pipeline information to the data object's own information. More...
 
virtual void CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
 Copy information from this data object to the pipeline information. More...
 
void DataHasBeenGenerated ()
 This method is called by the source when it executes to generate data. More...
 
virtual void PrepareForNewData ()
 make the output data ready for new data to be inserted. More...
 
virtual int GetExtentType ()
 The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstructuredGrid. More...
 
virtual void Crop (const int *updateExtent)
 This method crops the data object (if necessary) so that the extent matches the update extent. More...
 
virtual vtkDataSetAttributesGetAttributes (int type)
 Returns the attributes of the data object of the specified attribute type. More...
 
virtual vtkUnsignedCharArrayGetGhostArray (int type)
 Returns the ghost arrays of the data object of the specified attribute type. More...
 
virtual bool SupportsGhostArray (int type)
 Returns if this type of data object support ghost array for specified type. More...
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 Retrieves the attribute type that an array came from. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this data object. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this data object. More...
 
virtual vtkTypeBool GetDataReleased ()
 Get the flag indicating the data has been released. More...
 
virtual void SetFieldData (vtkFieldData *)
 Assign or retrieve a general field data to this data object. More...
 
virtual vtkFieldDataGetFieldData ()
 Assign or retrieve a general field data to this data object. More...
 
void GlobalReleaseDataFlagOn ()
 Turn on/off flag to control whether every object releases its data after being used by a filter. More...
 
void GlobalReleaseDataFlagOff ()
 Turn on/off flag to control whether every object releases its data after being used by a filter. 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...
 
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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. 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)
 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...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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...
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. 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...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkTableNew ()
 
static vtkTableExtendedNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkTableSafeDownCast (vtkObjectBase *o)
 
static vtkTableGetData (vtkInformation *info)
 Retrieve the table from vtkInformation. More...
 
static vtkTableGetData (vtkInformationVector *v, int i=0)
 Retrieve the table from vtkInformation. More...
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObjectNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataObjectSafeDownCast (vtkObjectBase *o)
 
static vtkInformationGetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
 Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and attribute (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) More...
 
static vtkInformationGetNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and name. More...
 
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 Remove the info associated with an array. More...
 
static vtkInformationSetActiveAttribute (vtkInformation *info, int fieldAssociation, const char *attributeName, int attributeType)
 Set the named array to be the active field for the specified type (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) and association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS). More...
 
static void SetActiveAttributeInfo (vtkInformation *info, int fieldAssociation, int attributeType, const char *name, int arrayType, int numComponents, int numTuples)
 Set the name, array type, number of components, and number of tuples within the passed information object for the active attribute of type attributeType (in specified association, FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS). More...
 
static void SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
 Convenience version of previous method for use (primarily) by the Imaging filters. More...
 
static const char * GetAssociationTypeAsString (int associationType)
 Given an integer association type, this static method returns a string type for the attribute (i.e. More...
 
static int GetAssociationTypeFromString (const char *associationName)
 Given a string association name, this static method returns an integer association type for the attribute (i.e. More...
 
static vtkInformationStringKeyDATA_TYPE_NAME ()
 
static vtkInformationDataObjectKeyDATA_OBJECT ()
 
static vtkInformationIntegerKeyDATA_EXTENT_TYPE ()
 
static vtkInformationIntegerPointerKeyDATA_EXTENT ()
 
static vtkInformationIntegerVectorKeyALL_PIECES_EXTENT ()
 
static vtkInformationIntegerKeyDATA_PIECE_NUMBER ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_GHOST_LEVELS ()
 
static vtkInformationDoubleKeyDATA_TIME_STEP ()
 
static vtkInformationInformationVectorKeyPOINT_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyCELL_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyVERTEX_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyEDGE_DATA_VECTOR ()
 
static vtkInformationIntegerKeyFIELD_ARRAY_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ASSOCIATION ()
 
static vtkInformationIntegerKeyFIELD_ATTRIBUTE_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ACTIVE_ATTRIBUTE ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_COMPONENTS ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_TUPLES ()
 
static vtkInformationIntegerKeyFIELD_OPERATION ()
 
static vtkInformationDoubleVectorKeyFIELD_RANGE ()
 
static vtkInformationIntegerVectorKeyPIECE_EXTENT ()
 
static vtkInformationStringKeyFIELD_NAME ()
 
static vtkInformationDoubleVectorKeyORIGIN ()
 
static vtkInformationDoubleVectorKeySPACING ()
 
static vtkInformationDoubleVectorKeyDIRECTION ()
 
static vtkInformationDoubleVectorKeyBOUNDING_BOX ()
 
static vtkInformationDataObjectKeySIL ()
 
static vtkDataObjectGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkDataObjectGetData (vtkInformationVector *v, int i=0)
 Retrieve an instance of this class from an information object. More...
 
static void SetGlobalReleaseDataFlag (vtkTypeBool val)
 Turn on/off flag to control whether every object releases its data after being used by a filter. More...
 
static vtkTypeBool GetGlobalReleaseDataFlag ()
 Turn on/off flag to control whether every object releases its data after being used by a filter. 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 (vtkTypeBool 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 vtkTypeBool 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 vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkTable ()
 
 ~vtkTable () override
 
void MoveRowData (vtkIdType first, vtkIdType last, vtkIdType delta)
 Move the content of the rows, starting first row and including last row. More...
 
- Protected Member Functions inherited from vtkDataObject
 vtkDataObject ()
 
 ~vtkDataObject () override
 
- 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 ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkDataSetAttributesRowData
 Holds the column data of the table. More...
 
vtkVariantArrayRowArray
 Holds row information returned by GetRow(). More...
 
- Protected Attributes inherited from vtkDataObject
vtkFieldDataFieldData
 
vtkTypeBool DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformationInformation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

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

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

Inserting or removing rows via the class API preserves existing table data where possible.

The "RemoveRow*" and SetNumberOfRows() operations will not release memory. Call on SqueezeRows() to achieve this after performing the operations.

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

Warning
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 must 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.
Examples:
vtkTable (Examples)
Online Examples:

Tests:
vtkTable (Tests)

Definition at line 167 of file vtkTable.h.

Member Typedef Documentation

◆ Superclass

Definition at line 172 of file vtkTable.h.

Constructor & Destructor Documentation

◆ vtkTable()

vtkTable::vtkTable ( )
protected

◆ ~vtkTable()

vtkTable::~vtkTable ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkTable* vtkTable::New ( )
static

◆ ExtendedNew()

static vtkTable* vtkTable::ExtendedNew ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkTable::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 vtkDataObject.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkTable::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDataObject.

◆ NewInstance()

vtkTable* vtkTable::NewInstance ( ) const

◆ PrintSelf()

void vtkTable::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 vtkDataObject.

◆ Dump()

void vtkTable::Dump ( unsigned int  colWidth = 16,
int  rowLimit = -1 
)

Dump table contents.

If rowLimit is -1 then the full table is printed out (Default). If rowLimit is 0 then only the header row will be displayed. Otherwise, if rowLimit > 0 then Dump will print the first rowLimit rows of data.

◆ GetDataObjectType()

int vtkTable::GetDataObjectType ( )
inlineoverridevirtual

Return what type of dataset this is.

Reimplemented from vtkDataObject.

Definition at line 186 of file vtkTable.h.

◆ GetActualMemorySize()

unsigned long vtkTable::GetActualMemorySize ( )
overridevirtual

Return the actual size of the data in kibibytes (1024 bytes).

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

◆ GetRowData()

virtual vtkDataSetAttributes* vtkTable::GetRowData ( )
virtual

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

◆ SetRowData()

virtual void vtkTable::SetRowData ( vtkDataSetAttributes data)
virtual

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

◆ GetNumberOfRows()

vtkIdType vtkTable::GetNumberOfRows ( )

Get the number of rows in the table.

◆ SetNumberOfRows()

void vtkTable::SetNumberOfRows ( vtkIdType  )

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. Existing data is preserved if the table is expanding.

◆ SqueezeRows()

void vtkTable::SqueezeRows ( )

Release previously allocated and now unused memory after performing resizing operations.

◆ GetRow() [1/2]

vtkVariantArray* vtkTable::GetRow ( vtkIdType  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.

◆ GetRow() [2/2]

void vtkTable::GetRow ( vtkIdType  row,
vtkVariantArray values 
)

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

◆ SetRow()

void vtkTable::SetRow ( vtkIdType  row,
vtkVariantArray values 
)

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

◆ InsertRow()

void vtkTable::InsertRow ( vtkIdType  row)

Insert a single row at the index.

◆ InsertRows()

void vtkTable::InsertRows ( vtkIdType  row,
vtkIdType  n 
)

Insert n rows before row.

If row < 0 then the rows will be prepended to the table.

◆ InsertNextBlankRow()

vtkIdType vtkTable::InsertNextBlankRow ( double  default_num_val = 0.0)

Insert a blank row at the end of the table.

◆ InsertNextRow()

vtkIdType vtkTable::InsertNextRow ( vtkVariantArray values)

Insert a row at the end of the tablespecified by a vtkVariantArray.

The number of entries in the array should match the number of columns in the table.

◆ RemoveRow()

void vtkTable::RemoveRow ( vtkIdType  row)

Delete a single row from the table.

Rows below the deleted row are shifted up.

◆ RemoveRows()

void vtkTable::RemoveRows ( vtkIdType  row,
vtkIdType  n 
)

Delete n rows from the table, starting at row.

Rows below the deleted rows are shifted up.

◆ RemoveAllRows()

void vtkTable::RemoveAllRows ( )

Delete all rows from the table.

The column arrays are not delete, they are just empty after this operation.

◆ GetNumberOfColumns()

vtkIdType vtkTable::GetNumberOfColumns ( )

Get the number of columns in the table.

◆ GetColumnName()

const char* vtkTable::GetColumnName ( vtkIdType  col)

◆ GetColumnByName()

vtkAbstractArray* vtkTable::GetColumnByName ( const char *  name)

Get a column of the table by its name.

◆ GetColumnIndex()

vtkIdType vtkTable::GetColumnIndex ( const char *  name)

Get the column index for a name.

If name is not found returns -1.

◆ GetColumn()

vtkAbstractArray* vtkTable::GetColumn ( vtkIdType  col)

Get a column of the table by its column index.

◆ AddColumn()

void vtkTable::AddColumn ( vtkAbstractArray arr)

Add a column to the table.

◆ InsertColumn()

void vtkTable::InsertColumn ( vtkAbstractArray arr,
vtkIdType  index 
)

Insert a column into the table at given column index.

◆ RemoveColumnByName()

void vtkTable::RemoveColumnByName ( const char *  name)

Remove a column from the table by its name.

◆ RemoveColumn()

void vtkTable::RemoveColumn ( vtkIdType  col)

Remove a column from the table by its column index.

◆ RemoveAllColumns()

void vtkTable::RemoveAllColumns ( )

Remove all columns from the table.

◆ GetValue()

vtkVariant vtkTable::GetValue ( vtkIdType  row,
vtkIdType  col 
)

Retrieve a value in the table by row and column index as a variant.

Note that this calls GetValueByName internally so that each column array must have its name set (and that name should be unique within the table).

◆ GetValueByName()

vtkVariant vtkTable::GetValueByName ( vtkIdType  row,
const char *  col 
)

Retrieve a value in the table by row index and column name as a variant.

◆ SetValue()

void vtkTable::SetValue ( vtkIdType  row,
vtkIdType  col,
vtkVariant  value 
)

Set a value in the table by row and column index as a variant.

◆ SetValueByName()

void vtkTable::SetValueByName ( vtkIdType  row,
const char *  col,
vtkVariant  value 
)

Set a value in the table by row index and column name as a variant.

◆ Initialize()

void vtkTable::Initialize ( )
overridevirtual

Initialize to an empty table.

Reimplemented from vtkDataObject.

◆ GetData() [1/2]

static vtkTable* vtkTable::GetData ( vtkInformation info)
static

Retrieve the table from vtkInformation.

◆ GetData() [2/2]

static vtkTable* vtkTable::GetData ( vtkInformationVector v,
int  i = 0 
)
static

Retrieve the table from vtkInformation.

◆ ShallowCopy()

void vtkTable::ShallowCopy ( vtkDataObject src)
overridevirtual

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

Reimplemented from vtkDataObject.

◆ DeepCopy()

void vtkTable::DeepCopy ( vtkDataObject src)
overridevirtual

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

Reimplemented from vtkDataObject.

◆ GetAttributesAsFieldData()

vtkFieldData* vtkTable::GetAttributesAsFieldData ( int  type)
overridevirtual

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

◆ GetNumberOfElements()

vtkIdType vtkTable::GetNumberOfElements ( int  type)
overridevirtual

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

Reimplemented from vtkDataObject.

◆ MoveRowData()

void vtkTable::MoveRowData ( vtkIdType  first,
vtkIdType  last,
vtkIdType  delta 
)
protected

Move the content of the rows, starting first row and including last row.

The rows will be moved by delta, which can be positive or negative. No checks will be performed that the arrays are correctly sized.

Member Data Documentation

◆ RowData

vtkDataSetAttributes* vtkTable::RowData
protected

Holds the column data of the table.

Definition at line 400 of file vtkTable.h.

◆ RowArray

vtkVariantArray* vtkTable::RowArray
protected

Holds row information returned by GetRow().

Definition at line 405 of file vtkTable.h.


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