VTK
|
A table, which contains similar-typed columns of data. More...
#include <vtkTable.h>
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... | |
vtkTable * | NewInstance () 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 (const vtkIdType) |
Set the number of rows in the table. More... | |
vtkVariantArray * | GetRow (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... | |
vtkIdType | InsertNextBlankRow (double default_num_val=0.0) |
Insert a blank row at the end of the table. More... | |
vtkIdType | InsertNextRow (vtkVariantArray *arr) |
Insert a row specified by a vtkVariantArray. More... | |
void | RemoveRow (vtkIdType row) |
Delete a row from the table. More... | |
vtkIdType | GetNumberOfColumns () |
Get the number of columns in the table. More... | |
const char * | GetColumnName (vtkIdType col) |
vtkAbstractArray * | GetColumnByName (const char *name) |
Get a column of the table by its name. More... | |
vtkAbstractArray * | GetColumn (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 | 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... | |
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... | |
vtkFieldData * | GetAttributesAsFieldData (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 vtkDataSetAttributes * | GetRowData () |
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 | |
vtkDataObject * | NewInstance () 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 vtkDataSetAttributes * | GetAttributes (int type) |
Returns the attributes of the data object of the specified attribute type. More... | |
virtual int | GetAttributeTypeForArray (vtkAbstractArray *arr) |
Retrieves the attribute type that an array came from. More... | |
virtual vtkInformation * | GetInformation () |
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 int | 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 vtkFieldData * | GetFieldData () |
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) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
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... | |
vtkCommand * | GetCommand (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... | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. More... | |
int | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. More... | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. More... | |
virtual void | Delete () |
Delete a VTK object. More... | |
virtual void | FastDelete () |
Delete a reference to this object. More... | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. More... | |
virtual void | 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... | |
void | PrintRevisions (ostream &) |
Legacy. 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... | |
Static Public Member Functions | |
static vtkTable * | New () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkTable * | SafeDownCast (vtkObjectBase *o) |
static vtkTable * | GetData (vtkInformation *info) |
Retrieve the table from vtkInformation. More... | |
static vtkTable * | GetData (vtkInformationVector *v, int i=0) |
Retrieve the table from vtkInformation. More... | |
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) More... | |
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. More... | |
static void | RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name) |
Remove the info associated with an array. More... | |
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). 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 *associationType) |
Given an integer association type, this static method returns a string type for the attribute (i.e. More... | |
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 * | BOUNDING_BOX () |
static vtkInformationDataObjectKey * | SIL () |
static vtkDataObject * | GetData (vtkInformation *info) |
Retrieve an instance of this class from an information object. More... | |
static vtkDataObject * | GetData (vtkInformationVector *v, int i=0) |
Retrieve an instance of this class from an information object. More... | |
static void | SetGlobalReleaseDataFlag (int val) |
Turn on/off flag to control whether every object releases its data after being used by a filter. More... | |
static int | 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 vtkObject * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. More... | |
static void | SetGlobalWarningDisplay (int val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static void | GlobalWarningDisplayOn () |
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 int | 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 vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkTable () | |
~vtkTable () override | |
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 | CollectRevisions (ostream &) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
vtkDataSetAttributes * | RowData |
Holds the column data of the table. More... | |
vtkVariantArray * | RowArray |
Holds row information returned by GetRow(). More... | |
Protected Attributes inherited from vtkDataObject | |
vtkFieldData * | FieldData |
int | DataReleased |
vtkTimeStamp | UpdateTime |
vtkInformation * | Information |
Protected Attributes inherited from vtkObject | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
Protected Attributes inherited from vtkObjectBase | |
vtkAtomicInt32 | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
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).
The field data inherited from vtkDataObject may be used to store metadata related to the table.
Definition at line 68 of file vtkTable.h.
typedef vtkDataObject vtkTable::Superclass |
Definition at line 72 of file vtkTable.h.
|
protected |
|
overrideprotected |
|
static |
|
static |
|
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.
|
static |
|
protectedvirtual |
Reimplemented from vtkDataObject.
vtkTable* vtkTable::NewInstance | ( | ) | const |
|
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 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.
|
inlineoverridevirtual |
Return what type of dataset this is.
Reimplemented from vtkDataObject.
Definition at line 86 of file vtkTable.h.
|
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.
|
virtual |
Get/Set the main data (columns) of the table.
|
virtual |
Get/Set the main data (columns) of the table.
vtkIdType vtkTable::GetNumberOfRows | ( | ) |
Get the number of rows in the table.
void vtkTable::SetNumberOfRows | ( | const 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.
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.
void vtkTable::GetRow | ( | vtkIdType | row, |
vtkVariantArray * | values | ||
) |
Get a row of the table as a vtkVariantArray which has one entry for each column.
void vtkTable::SetRow | ( | vtkIdType | row, |
vtkVariantArray * | values | ||
) |
Set a row of the table with a vtkVariantArray which has one entry for each column.
Insert a blank row at the end of the table.
vtkIdType vtkTable::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.
void vtkTable::RemoveRow | ( | vtkIdType | row | ) |
Delete a row from the table.
Rows below the deleted row are shifted up.
vtkIdType vtkTable::GetNumberOfColumns | ( | ) |
Get the number of columns in the table.
const char* vtkTable::GetColumnName | ( | vtkIdType | col | ) |
vtkAbstractArray* vtkTable::GetColumnByName | ( | const char * | name | ) |
Get a column of the table by its name.
vtkAbstractArray* vtkTable::GetColumn | ( | vtkIdType | col | ) |
Get a column of the table by its column index.
void vtkTable::AddColumn | ( | vtkAbstractArray * | arr | ) |
Add a column to the table.
void vtkTable::RemoveColumnByName | ( | const char * | name | ) |
Remove a column from the table by its name.
void vtkTable::RemoveColumn | ( | vtkIdType | col | ) |
Remove a column from the table by its column index.
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).
vtkVariant vtkTable::GetValueByName | ( | vtkIdType | row, |
const char * | col | ||
) |
Retrieve a value in the table by row index and column name as a variant.
void vtkTable::SetValue | ( | vtkIdType | row, |
vtkIdType | col, | ||
vtkVariant | value | ||
) |
Set a value in the table by row and column index as a variant.
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.
|
overridevirtual |
Initialize to an empty table.
Reimplemented from vtkDataObject.
|
static |
Retrieve the table from vtkInformation.
|
static |
Retrieve the table from vtkInformation.
|
overridevirtual |
Shallow/deep copy the data from src into this object.
Reimplemented from vtkDataObject.
|
overridevirtual |
Shallow/deep copy the data from src into this object.
Reimplemented from vtkDataObject.
|
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.
Get the number of elements for a specific attribute type (ROW, etc.).
Reimplemented from vtkDataObject.
|
protected |
Holds the column data of the table.
Definition at line 257 of file vtkTable.h.
|
protected |
Holds row information returned by GetRow().
Definition at line 262 of file vtkTable.h.