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

#include <vtkTable.h>

Inheritance diagram for vtkTable:

Collaboration diagram for vtkTable:

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.

vtkTable *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	Dump (unsigned int colWidth=16, int rowLimit=-1)
	Dump table contents.

int	GetDataObjectType () override
	Return what type of dataset this is.

unsigned long	GetActualMemorySize () override
	Return the actual size of the data in kibibytes (1024 bytes).

vtkIdType	GetNumberOfRows ()
	Get the number of rows in the table.

void	SetNumberOfRows (vtkIdType)
	Set the number of rows in the table.

void	SqueezeRows ()
	Release previously allocated and now unused memory after performing resizing operations.

vtkVariantArray *	GetRow (vtkIdType row)
	Get a row of the table as a vtkVariantArray which has one entry for each column.

void	GetRow (vtkIdType row, vtkVariantArray *values)
	Get a row of the table as a vtkVariantArray which has one entry for each column.

void	SetRow (vtkIdType row, vtkVariantArray *values)
	Set a row of the table with a vtkVariantArray which has one entry for each column.

void	InsertRow (vtkIdType row)
	Insert a single row at the index.

void	InsertRows (vtkIdType row, vtkIdType n)
	Insert n rows before row.

vtkIdType	InsertNextBlankRow (double default_num_val=0.0)
	Insert a blank row at the end of the table.

vtkIdType	InsertNextRow (vtkVariantArray *values)
	Insert a row at the end of the tablespecified by a vtkVariantArray.

void	RemoveRow (vtkIdType row)
	Delete a single row from the table.

void	RemoveRows (vtkIdType row, vtkIdType n)
	Delete n rows from the table, starting at row.

void	RemoveAllRows ()
	Delete all rows from the table.

vtkIdType	GetNumberOfColumns ()
	Get the number of columns in the table.

const char *	GetColumnName (vtkIdType col)

vtkAbstractArray *	GetColumnByName (const char *name)
	Get a column of the table by its name.

vtkIdType	GetColumnIndex (const char *name)
	Get the column index for a name.

vtkAbstractArray *	GetColumn (vtkIdType col)
	Get a column of the table by its column index.

void	AddColumn (vtkAbstractArray *arr)
	Add a column to the table.

void	InsertColumn (vtkAbstractArray *arr, vtkIdType index)
	Insert a column into the table at given column index.

void	RemoveColumnByName (const char *name)
	Remove a column from the table by its name.

void	RemoveColumn (vtkIdType col)
	Remove a column from the table by its column index.

void	RemoveAllColumns ()
	Remove all columns from the table.

vtkVariant	GetValue (vtkIdType row, vtkIdType col)
	Retrieve a value in the table by row and column index as a variant.

vtkVariant	GetValueByName (vtkIdType row, const char *col)
	Retrieve a value in the table by row index and column name as a variant.

void	SetValue (vtkIdType row, vtkIdType col, vtkVariant value)
	Set a value in the table by row and column index as a variant.

void	SetValueByName (vtkIdType row, const char *col, vtkVariant value)
	Set a value in the table by row index and column name as a variant.

void	Initialize () override
	Initialize to an empty table.

vtkFieldData *	GetAttributesAsFieldData (int type) override
	Returns the attributes of the data object as a vtkFieldData.

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


virtual vtkDataSetAttributes *	GetRowData ()
	Get/Set the main data (columns) of the table.

virtual void	SetRowData (vtkDataSetAttributes *data)
	Get/Set the main data (columns) of the table.


void	ShallowCopy (vtkDataObject *src) override
	Shallow/deep copy the data from src into this object.

void	DeepCopy (vtkDataObject *src) override
	Shallow/deep copy the data from src into this object.

Public Member Functions inherited from vtkDataObject
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkDataObject *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

vtkMTimeType	GetMTime () override
	Data objects are composite objects and need to check each part for MTime.

virtual void	Initialize ()
	Restore data object to initial state,.

void	ReleaseData ()
	Release data back to system to conserve memory resource.

virtual int	GetDataObjectType ()
	Return class name of data type.

vtkMTimeType	GetUpdateTime ()
	Used by Threaded ports to determine if they should initiate an asynchronous update (still in development).

virtual unsigned long	GetActualMemorySize ()
	Return the actual size of the data in kibibytes (1024 bytes).

virtual void	CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
	Copy from the pipeline information to the data object's own information.

virtual void	CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
	Copy information from this data object to the pipeline information.

void	DataHasBeenGenerated ()
	This method is called by the source when it executes to generate data.

virtual void	PrepareForNewData ()
	make the output data ready for new data to be inserted.

virtual void	ShallowCopy (vtkDataObject *src)
	The goal of the method is to copy the data up to the array pointers only.

virtual void	DeepCopy (vtkDataObject *src)
	The goal of the method is to copy the complete data from src into this object.

virtual int	GetExtentType ()
	The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstructuredGrid.

virtual void	Crop (const int *updateExtent)
	This method crops the data object (if necessary) so that the extent matches the update extent.

virtual vtkDataSetAttributes *	GetAttributes (int type)
	Returns the attributes of the data object of the specified attribute type.

virtual vtkUnsignedCharArray *	GetGhostArray (int type)
	Returns the ghost arrays of the data object of the specified attribute type.

virtual bool	SupportsGhostArray (int type)
	Returns if this type of data object support ghost array for specified type.

virtual vtkFieldData *	GetAttributesAsFieldData (int type)
	Returns the attributes of the data object as a vtkFieldData.

virtual int	GetAttributeTypeForArray (vtkAbstractArray *arr)
	Retrieves the attribute type that an array came from.

virtual vtkIdType	GetNumberOfElements (int type)
	Get the number of elements for a specific attribute type (POINT, CELL, etc.).

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this data object.

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this data object.

virtual vtkTypeBool	GetDataReleased ()
	Get the flag indicating the data has been released.

virtual void	SetFieldData (vtkFieldData *)
	Assign or retrieve a general field data to this data object.

virtual vtkFieldData *	GetFieldData ()
	Assign or retrieve a general field data to this data object.

void	GlobalReleaseDataFlagOn ()
	Turn on/off flag to control whether every object releases its data after being used by a filter.

void	GlobalReleaseDataFlagOff ()
	Turn on/off flag to control whether every object releases its data after being used by a filter.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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.

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.

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.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

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

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkTable *	New ()

static vtkTable *	ExtendedNew ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkTable *	SafeDownCast (vtkObjectBase *o)


static vtkTable *	GetData (vtkInformation *info)
	Retrieve the table from vtkInformation.

static vtkTable *	GetData (vtkInformationVector *v, int i=0)
	Retrieve the table from vtkInformation.

Static Public Member Functions inherited from vtkDataObject
static vtkDataObject *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDataObject *	SafeDownCast (vtkObjectBase *o)

static vtkInformation *	GetActiveFieldInformation (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)

static vtkInformation *	GetNamedFieldInformation (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.

static void	RemoveNamedFieldInformation (vtkInformation info, int fieldAssociation, const char name)
	Remove the info associated with an array.

static vtkInformation *	SetActiveAttribute (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).

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

static void	SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
	Convenience version of previous method for use (primarily) by the Imaging filters.

static const char *	GetAssociationTypeAsString (int associationType)
	Given an integer association type, this static method returns a string type for the attribute (i.e.

static int	GetAssociationTypeFromString (const char *associationName)
	Given a string association name, this static method returns an integer association type for the attribute (i.e.

static vtkInformationStringKey *	DATA_TYPE_NAME ()

static vtkInformationDataObjectKey *	DATA_OBJECT ()

static vtkInformationIntegerKey *	DATA_EXTENT_TYPE ()

static vtkInformationIntegerPointerKey *	DATA_EXTENT ()

static vtkInformationIntegerVectorKey *	ALL_PIECES_EXTENT ()

static vtkInformationIntegerKey *	DATA_PIECE_NUMBER ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_PIECES ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_GHOST_LEVELS ()

static vtkInformationDoubleKey *	DATA_TIME_STEP ()

static vtkInformationInformationVectorKey *	POINT_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	CELL_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	VERTEX_DATA_VECTOR ()

static vtkInformationInformationVectorKey *	EDGE_DATA_VECTOR ()

static vtkInformationIntegerKey *	FIELD_ARRAY_TYPE ()

static vtkInformationIntegerKey *	FIELD_ASSOCIATION ()

static vtkInformationIntegerKey *	FIELD_ATTRIBUTE_TYPE ()

static vtkInformationIntegerKey *	FIELD_ACTIVE_ATTRIBUTE ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_COMPONENTS ()

static vtkInformationIntegerKey *	FIELD_NUMBER_OF_TUPLES ()

static vtkInformationIntegerKey *	FIELD_OPERATION ()

static vtkInformationDoubleVectorKey *	FIELD_RANGE ()

static vtkInformationIntegerVectorKey *	PIECE_EXTENT ()

static vtkInformationStringKey *	FIELD_NAME ()

static vtkInformationDoubleVectorKey *	ORIGIN ()

static vtkInformationDoubleVectorKey *	SPACING ()

static vtkInformationDoubleVectorKey *	DIRECTION ()

static vtkInformationDoubleVectorKey *	BOUNDING_BOX ()

static vtkInformationDataObjectKey *	SIL ()

static vtkDataObject *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object.

static vtkDataObject *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object.

static void	SetGlobalReleaseDataFlag (vtkTypeBool val)
	Turn on/off flag to control whether every object releases its data after being used by a filter.

static vtkTypeBool	GetGlobalReleaseDataFlag ()
	Turn on/off flag to control whether every object releases its data after being used by a filter.

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

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

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

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.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () 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.

Protected Member Functions inherited from vtkDataObject
virtual vtkObjectBase *	NewInstanceInternal () const

	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.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkDataSetAttributes *	RowData
	Holds the column data of the table.

vtkVariantArray *	RowArray
	Holds row information returned by GetRow().

Protected Attributes inherited from vtkDataObject
vtkFieldData *	FieldData

vtkTypeBool	DataReleased

vtkTimeStamp	UpdateTime

vtkInformation *	Information

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:

OBBTreeTimingDemo

OctreeTimingDemo

AdjacencyMatrixToEdgeTable

Tests:: vtkTable (Tests)

Definition at line 168 of file vtkTable.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataObject vtkTable::Superclass

Definition at line 173 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 187 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 401 of file vtkTable.h.

◆ RowArray

vtkVariantArray* vtkTable::RowArray

protected

Holds row information returned by GetRow().

Definition at line 406 of file vtkTable.h.

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

Common/DataModel/vtkTable.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkTable()

◆ ~vtkTable()

Member Function Documentation

◆ New()

◆ ExtendedNew()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ Dump()

◆ GetDataObjectType()

◆ GetActualMemorySize()

◆ GetRowData()

◆ SetRowData()

◆ GetNumberOfRows()

◆ SetNumberOfRows()

◆ SqueezeRows()

◆ GetRow() [1/2]

◆ GetRow() [2/2]

◆ SetRow()

◆ InsertRow()

◆ InsertRows()

◆ InsertNextBlankRow()

◆ InsertNextRow()

◆ RemoveRow()

◆ RemoveRows()

◆ RemoveAllRows()

◆ GetNumberOfColumns()

◆ GetColumnName()

◆ GetColumnByName()

◆ GetColumnIndex()

◆ GetColumn()

◆ AddColumn()

◆ InsertColumn()

◆ RemoveColumnByName()

◆ RemoveColumn()

◆ RemoveAllColumns()

◆ GetValue()

◆ GetValueByName()

◆ SetValue()

◆ SetValueByName()

◆ Initialize()

◆ GetData() [1/2]

◆ GetData() [2/2]

◆ ShallowCopy()

◆ DeepCopy()

◆ GetAttributesAsFieldData()

◆ GetNumberOfElements()

◆ MoveRowData()

Member Data Documentation

◆ RowData

◆ RowArray