VTK  9.0.20210621
vtkDataObject.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkDataObject.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
34 #ifndef vtkDataObject_h
35 #define vtkDataObject_h
36 
37 #include "vtkCommonDataModelModule.h" // For export macro
38 #include "vtkObject.h"
39 
40 class vtkAbstractArray;
41 class vtkDataArray;
43 class vtkFieldData;
44 class vtkInformation;
54 
55 #define VTK_PIECES_EXTENT 0
56 #define VTK_3D_EXTENT 1
57 #define VTK_TIME_EXTENT 2
58 
59 class VTKCOMMONDATAMODEL_EXPORT vtkDataObject : public vtkObject
60 {
61 public:
62  static vtkDataObject* New();
63 
64  vtkTypeMacro(vtkDataObject, vtkObject);
65  void PrintSelf(ostream& os, vtkIndent indent) override;
66 
68 
71  vtkGetObjectMacro(Information, vtkInformation);
74 
79  vtkMTimeType GetMTime() override;
80 
84  virtual void Initialize();
85 
91  void ReleaseData();
92 
94 
97  vtkGetMacro(DataReleased, int);
99 
101 
105  static void SetGlobalReleaseDataFlag(int val);
106  void GlobalReleaseDataFlagOn() { this->SetGlobalReleaseDataFlag(1); }
107  void GlobalReleaseDataFlagOff() { this->SetGlobalReleaseDataFlag(0); }
110 
112 
115  virtual void SetFieldData(vtkFieldData*);
116  vtkGetObjectMacro(FieldData, vtkFieldData);
118 
125  virtual int GetDataObjectType() { return VTK_DATA_OBJECT; }
126 
132 
140  virtual unsigned long GetActualMemorySize();
141 
146  virtual void CopyInformationFromPipeline(vtkInformation* vtkNotUsed(info)) {}
147 
153  virtual void CopyInformationToPipeline(vtkInformation* vtkNotUsed(info)) {}
154 
162  vtkInformation* info, int fieldAssociation, int attributeType);
163 
170  vtkInformation* info, int fieldAssociation, const char* name);
171 
176  vtkInformation* info, int fieldAssociation, const char* name);
177 
185  vtkInformation* info, int fieldAssociation, const char* attributeName, int attributeType);
186 
196  static void SetActiveAttributeInfo(vtkInformation* info, int fieldAssociation, int attributeType,
197  const char* name, int arrayType, int numComponents, int numTuples);
198 
203  static void SetPointDataActiveScalarInfo(vtkInformation* info, int arrayType, int numComponents);
204 
211 
217  virtual void PrepareForNewData() { this->Initialize(); }
218 
220 
224  virtual void ShallowCopy(vtkDataObject* src);
225  virtual void DeepCopy(vtkDataObject* src);
227 
236  virtual int GetExtentType() { return VTK_PIECES_EXTENT; }
237 
242  virtual void Crop(const int* updateExtent);
243 
248  {
256  NUMBER_OF_ASSOCIATIONS
257  };
258 
264  {
272  NUMBER_OF_ATTRIBUTE_TYPES
273  };
274 
295 
308 
316 
323 
328 
333  {
337  FIELD_OPERATION_REMOVED
338  };
339 
344  static const char* GetAssociationTypeAsString(int associationType);
345 
350  static int GetAssociationTypeFromString(const char* associationName);
351 
352  // \ingroup InformationKeys
354  // \ingroup InformationKeys
356  // \ingroup InformationKeys
358  // \ingroup InformationKeys
360  // \ingroup InformationKeys
362  // \ingroup InformationKeys
364  // \ingroup InformationKeys
366  // \ingroup InformationKeys
368  // \ingroup InformationKeys
370  // \ingroup InformationKeys
372  // \ingroup InformationKeys
374  // \ingroup InformationKeys
376  // \ingroup InformationKeys
378  // \ingroup InformationKeys
380  // \ingroup InformationKeys
382  // \ingroup InformationKeys
384  // \ingroup InformationKeys
386  // \ingroup InformationKeys
388  // \ingroup InformationKeys
390  // \ingroup InformationKeys
392  // \ingroup InformationKeys
394  // \ingroup InformationKeys
396  // \ingroup InformationKeys
398  // \ingroup InformationKeys
400  // \ingroup InformationKeys
402  // \ingroup InformationKeys
404  // \ingroup InformationKeys
406 
407  // Key used to put SIL information in the output information by readers.
408  // \ingroup InformationKeys
410 
412 
418 
419 protected:
421  ~vtkDataObject() override;
422 
423  // General field data associated with data object
425 
426  // Keep track of data release during network execution
428 
429  // When was this data last generated?
431 
432  // Arbitrary extra information associated with this data object.
434 
435 private:
436  // Helper method for the ShallowCopy and DeepCopy methods.
437  void InternalDataObjectCopy(vtkDataObject* src);
438 
439 private:
440  vtkDataObject(const vtkDataObject&) = delete;
441  void operator=(const vtkDataObject&) = delete;
442 };
443 
444 #endif
vtkDataObject::FIELD_ASSOCIATION_EDGES
@ FIELD_ASSOCIATION_EDGES
Definition: vtkDataObject.h:254
vtkDataObject::DATA_TYPE_NAME
static vtkInformationStringKey * DATA_TYPE_NAME()
vtkDataObject::GetAttributes
virtual vtkDataSetAttributes * GetAttributes(int type)
Returns the attributes of the data object of the specified attribute type.
vtkInformationStringKey
Key for string values in vtkInformation.
Definition: vtkInformationStringKey.h:34
vtkDataObject::POINT
@ POINT
Definition: vtkDataObject.h:265
vtkDataObject::POINT_DATA_VECTOR
static vtkInformationInformationVectorKey * POINT_DATA_VECTOR()
vtkDataObject::Initialize
virtual void Initialize()
Restore data object to initial state,.
vtkDataObject::GetAssociationTypeFromString
static int GetAssociationTypeFromString(const char *associationName)
Given a string association name, this static method returns an integer association type for the attri...
vtkDataObject::FIELD_ACTIVE_ATTRIBUTE
static vtkInformationIntegerKey * FIELD_ACTIVE_ATTRIBUTE()
vtkDataObject::CELL
@ CELL
Definition: vtkDataObject.h:266
vtkDataObject::GetAssociationTypeAsString
static const char * GetAssociationTypeAsString(int associationType)
Given an integer association type, this static method returns a string type for the attribute (i....
VTK_DATA_OBJECT
#define VTK_DATA_OBJECT
Definition: vtkType.h:84
vtkDataObject::EDGE_DATA_VECTOR
static vtkInformationInformationVectorKey * EDGE_DATA_VECTOR()
vtkDataObject::SPACING
static vtkInformationDoubleVectorKey * SPACING()
vtkDataObject::FieldData
vtkFieldData * FieldData
Definition: vtkDataObject.h:424
vtkDataObject::GetAttributesAsFieldData
virtual vtkFieldData * GetAttributesAsFieldData(int type)
Returns the attributes of the data object as a vtkFieldData.
vtkX3D::type
@ type
Definition: vtkX3D.h:522
vtkIdType
int vtkIdType
Definition: vtkType.h:332
vtkDataObject::VERTEX_DATA_VECTOR
static vtkInformationInformationVectorKey * VERTEX_DATA_VECTOR()
vtkDataObject::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkDataSetAttributes
represent and manipulate attribute data in a dataset
Definition: vtkDataSetAttributes.h:61
vtkDataObject::SetPointDataActiveScalarInfo
static void SetPointDataActiveScalarInfo(vtkInformation *info, int arrayType, int numComponents)
Convenience version of previous method for use (primarily) by the Imaging filters.
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:36
vtkDataObject::DATA_OBJECT
static vtkInformationDataObjectKey * DATA_OBJECT()
vtkTimeStamp
record modification and/or execution time
Definition: vtkTimeStamp.h:33
vtkDataObject::FIELD_ASSOCIATION
static vtkInformationIntegerKey * FIELD_ASSOCIATION()
vtkInformationDataObjectKey
Key for vtkDataObject values.
Definition: vtkInformationDataObjectKey.h:34
vtkDataObject::SetInformation
virtual void SetInformation(vtkInformation *)
Set/Get the information object associated with this data object.
vtkDataObject::GetNamedFieldInformation
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 s...
vtkDataObject::PIECE_EXTENT
static vtkInformationIntegerVectorKey * PIECE_EXTENT()
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:63
vtkDataObject::CopyInformationFromPipeline
virtual void CopyInformationFromPipeline(vtkInformation *vtkNotUsed(info))
Copy from the pipeline information to the data object's own information.
Definition: vtkDataObject.h:146
vtkDataObject::DATA_NUMBER_OF_GHOST_LEVELS
static vtkInformationIntegerKey * DATA_NUMBER_OF_GHOST_LEVELS()
vtkDataObject::Information
vtkInformation * Information
Definition: vtkDataObject.h:433
vtkDataObject::GetUpdateTime
vtkMTimeType GetUpdateTime()
Used by Threaded ports to determine if they should initiate an asynchronous update (still in developm...
vtkDataObject::GetDataObjectType
virtual int GetDataObjectType()
Return class name of data type.
Definition: vtkDataObject.h:125
vtkDataObject::FIELD_ASSOCIATION_POINTS
@ FIELD_ASSOCIATION_POINTS
Definition: vtkDataObject.h:249
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:50
vtkDataObject::GlobalReleaseDataFlagOn
void GlobalReleaseDataFlagOn()
Turn on/off flag to control whether every object releases its data after being used by a filter.
Definition: vtkDataObject.h:106
vtkInformationIntegerPointerKey
Key for pointer to integer.
Definition: vtkInformationIntegerPointerKey.h:32
vtkInformationDoubleKey
Key for double values in vtkInformation.
Definition: vtkInformationDoubleKey.h:32
vtkDataObject::SIL
static vtkInformationDataObjectKey * SIL()
vtkDataObject::RemoveNamedFieldInformation
static void RemoveNamedFieldInformation(vtkInformation *info, int fieldAssociation, const char *name)
Remove the info associated with an array.
vtkDataObject::POINT_THEN_CELL
@ POINT_THEN_CELL
Definition: vtkDataObject.h:268
vtkDataObject::FIELD_ASSOCIATION_NONE
@ FIELD_ASSOCIATION_NONE
Definition: vtkDataObject.h:251
vtkDataObject::DeepCopy
virtual void DeepCopy(vtkDataObject *src)
Shallow and Deep copy.
vtkDataObject::vtkDataObject
vtkDataObject()
vtkDataObject::SetGlobalReleaseDataFlag
static void SetGlobalReleaseDataFlag(int val)
Turn on/off flag to control whether every object releases its data after being used by a filter.
vtkDataObject::GetMTime
vtkMTimeType GetMTime() override
Data objects are composite objects and need to check each part for MTime.
vtkDataObject::ALL_PIECES_EXTENT
static vtkInformationIntegerVectorKey * ALL_PIECES_EXTENT()
vtkDataObject::FIELD_ASSOCIATION_VERTICES
@ FIELD_ASSOCIATION_VERTICES
Definition: vtkDataObject.h:253
vtkFieldData
represent and manipulate fields of data
Definition: vtkFieldData.h:55
vtkDataObject::DataHasBeenGenerated
void DataHasBeenGenerated()
This method is called by the source when it executes to generate data.
vtkDataObject::GetNumberOfElements
virtual vtkIdType GetNumberOfElements(int type)
Get the number of elements for a specific attribute type (POINT, CELL, etc.).
vtkDataObject::GlobalReleaseDataFlagOff
void GlobalReleaseDataFlagOff()
Turn on/off flag to control whether every object releases its data after being used by a filter.
Definition: vtkDataObject.h:107
vtkDataObject::FieldOperations
FieldOperations
Possible values for the FIELD_OPERATION information entry.
Definition: vtkDataObject.h:333
vtkDataObject::FIELD_OPERATION_MODIFIED
@ FIELD_OPERATION_MODIFIED
Definition: vtkDataObject.h:336
vtkDataObject::~vtkDataObject
~vtkDataObject() override
vtkDataObject::SetActiveAttribute
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,...
vtkDataObject::GetGhostArray
virtual vtkDataArray * GetGhostArray(int type)
Returns the ghost arrays of the data object of the specified atribute type.
vtkDataObject::FIELD_ASSOCIATION_CELLS
@ FIELD_ASSOCIATION_CELLS
Definition: vtkDataObject.h:250
vtkDataObject::FIELD_OPERATION
static vtkInformationIntegerKey * FIELD_OPERATION()
vtkDataObject::DATA_PIECE_NUMBER
static vtkInformationIntegerKey * DATA_PIECE_NUMBER()
vtkDataObject::VERTEX
@ VERTEX
Definition: vtkDataObject.h:269
vtkInformationIntegerKey
Key for integer values in vtkInformation.
Definition: vtkInformationIntegerKey.h:32
vtkDataObject::FIELD_NUMBER_OF_COMPONENTS
static vtkInformationIntegerKey * FIELD_NUMBER_OF_COMPONENTS()
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:34
vtkDataObject::GetExtentType
virtual int GetExtentType()
The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstruct...
Definition: vtkDataObject.h:236
vtkDataObject::BOUNDING_BOX
static vtkInformationDoubleVectorKey * BOUNDING_BOX()
vtkDataObject::PrepareForNewData
virtual void PrepareForNewData()
make the output data ready for new data to be inserted.
Definition: vtkDataObject.h:217
vtkDataObject::GetActiveFieldInformation
static vtkInformation * GetActiveFieldInformation(vtkInformation *info, int fieldAssociation, int attributeType)
Return the information object within the input information object's field data corresponding to the s...
vtkDataObject::SetActiveAttributeInfo
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 ob...
vtkDataObject::DATA_NUMBER_OF_PIECES
static vtkInformationIntegerKey * DATA_NUMBER_OF_PIECES()
vtkDataObject::FIELD_RANGE
static vtkInformationDoubleVectorKey * FIELD_RANGE()
vtkDataObject::Crop
virtual void Crop(const int *updateExtent)
This method crops the data object (if necessary) so that the extent matches the update extent.
vtkDataObject::UpdateTime
vtkTimeStamp UpdateTime
Definition: vtkDataObject.h:430
VTK_PIECES_EXTENT
#define VTK_PIECES_EXTENT
Definition: vtkDataObject.h:55
vtkDataObject::ROW
@ ROW
Definition: vtkDataObject.h:271
vtkX3D::name
@ name
Definition: vtkX3D.h:225
vtkObject.h
vtkDataObject::FIELD
@ FIELD
Definition: vtkDataObject.h:267
vtkDataObject::DATA_TIME_STEP
static vtkInformationDoubleKey * DATA_TIME_STEP()
vtkDataObject::CopyInformationToPipeline
virtual void CopyInformationToPipeline(vtkInformation *vtkNotUsed(info))
Copy information from this data object to the pipeline information.
Definition: vtkDataObject.h:153
vtkDataObject::ReleaseData
void ReleaseData()
Release data back to system to conserve memory resource.
vtkDataObject::DIRECTION
static vtkInformationDoubleVectorKey * DIRECTION()
vtkDataObject::GetActualMemorySize
virtual unsigned long GetActualMemorySize()
Return the actual size of the data in kibibytes (1024 bytes).
vtkAbstractArray
Abstract superclass for all arrays.
Definition: vtkAbstractArray.h:76
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:74
vtkX3D::info
@ info
Definition: vtkX3D.h:382
vtkDataObject::GetAttributeTypeForArray
virtual int GetAttributeTypeForArray(vtkAbstractArray *arr)
Retrieves the attribute type that an array came from.
vtkDataObject::EDGE
@ EDGE
Definition: vtkDataObject.h:270
vtkDataObject::DataReleased
int DataReleased
Definition: vtkDataObject.h:427
vtkInformationDoubleVectorKey
Key for double vector values.
Definition: vtkInformationDoubleVectorKey.h:32
vtkDataObject::SetFieldData
virtual void SetFieldData(vtkFieldData *)
Assign or retrieve a general field data to this data object.
vtkInformationInformationVectorKey
Key for vtkInformation vectors.
Definition: vtkInformationInformationVectorKey.h:34
vtkDataObject::GetData
static vtkDataObject * GetData(vtkInformationVector *v, int i=0)
Retrieve an instance of this class from an information object.
vtkDataObject::FIELD_OPERATION_REINTERPOLATED
@ FIELD_OPERATION_REINTERPOLATED
Definition: vtkDataObject.h:335
vtkDataObject::FIELD_NAME
static vtkInformationStringKey * FIELD_NAME()
vtkDataObject::FIELD_ASSOCIATION_POINTS_THEN_CELLS
@ FIELD_ASSOCIATION_POINTS_THEN_CELLS
Definition: vtkDataObject.h:252
vtkDataObject::FieldAssociations
FieldAssociations
Possible values for the FIELD_ASSOCIATION information entry.
Definition: vtkDataObject.h:248
vtkDataObject::FIELD_NUMBER_OF_TUPLES
static vtkInformationIntegerKey * FIELD_NUMBER_OF_TUPLES()
vtkDataObject::FIELD_ATTRIBUTE_TYPE
static vtkInformationIntegerKey * FIELD_ATTRIBUTE_TYPE()
vtkInformationIntegerVectorKey
Key for integer vector values.
Definition: vtkInformationIntegerVectorKey.h:32
vtkDataObject::FIELD_ASSOCIATION_ROWS
@ FIELD_ASSOCIATION_ROWS
Definition: vtkDataObject.h:255
vtkDataObject::ORIGIN
static vtkInformationDoubleVectorKey * ORIGIN()
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:60
vtkDataObject::GetGlobalReleaseDataFlag
static int GetGlobalReleaseDataFlag()
Turn on/off flag to control whether every object releases its data after being used by a filter.
vtkDataObject::FIELD_ARRAY_TYPE
static vtkInformationIntegerKey * FIELD_ARRAY_TYPE()
vtkDataObject::CELL_DATA_VECTOR
static vtkInformationInformationVectorKey * CELL_DATA_VECTOR()
vtkDataObject::ShallowCopy
virtual void ShallowCopy(vtkDataObject *src)
Shallow and Deep copy.
vtkDataObject::DATA_EXTENT_TYPE
static vtkInformationIntegerKey * DATA_EXTENT_TYPE()
vtkDataObject::DATA_EXTENT
static vtkInformationIntegerPointerKey * DATA_EXTENT()
vtkDataObject::AttributeTypes
AttributeTypes
Possible attribute types.
Definition: vtkDataObject.h:264
vtkDataObject::GetData
static vtkDataObject * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
vtkDataObject::FIELD_OPERATION_PRESERVED
@ FIELD_OPERATION_PRESERVED
Definition: vtkDataObject.h:334
vtkDataObject::New
static vtkDataObject * New()
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287