VTK  9.3.20240319
vtkDataObject.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
137 #ifndef vtkDataObject_h
138 #define vtkDataObject_h
139 
140 #include "vtkCommonDataModelModule.h" // For export macro
141 #include "vtkObject.h"
142 
143 VTK_ABI_NAMESPACE_BEGIN
144 class vtkAbstractArray;
146 class vtkFieldData;
147 class vtkInformation;
158 
159 #define VTK_PIECES_EXTENT 0
160 #define VTK_3D_EXTENT 1
161 #define VTK_TIME_EXTENT 2
162 
163 class VTKCOMMONDATAMODEL_EXPORT vtkDataObject : public vtkObject
164 {
165 public:
166  static vtkDataObject* New();
167 
168  vtkTypeMacro(vtkDataObject, vtkObject);
169  void PrintSelf(ostream& os, vtkIndent indent) override;
170 
172 
175  vtkGetObjectMacro(Information, vtkInformation);
178 
183  vtkMTimeType GetMTime() override;
184 
188  virtual void Initialize();
189 
195  void ReleaseData();
196 
198 
201  vtkGetMacro(DataReleased, vtkTypeBool);
203 
205 
214 
216 
219  virtual void SetFieldData(vtkFieldData*);
220  vtkGetObjectMacro(FieldData, vtkFieldData);
222 
229  virtual int GetDataObjectType() { return VTK_DATA_OBJECT; }
230 
236 
244  virtual unsigned long GetActualMemorySize();
245 
250  virtual void CopyInformationFromPipeline(vtkInformation* vtkNotUsed(info)) {}
251 
257  virtual void CopyInformationToPipeline(vtkInformation* vtkNotUsed(info)) {}
258 
266  vtkInformation* info, int fieldAssociation, int attributeType);
267 
274  vtkInformation* info, int fieldAssociation, const char* name);
275 
280  vtkInformation* info, int fieldAssociation, const char* name);
281 
289  vtkInformation* info, int fieldAssociation, const char* attributeName, int attributeType);
290 
300  static void SetActiveAttributeInfo(vtkInformation* info, int fieldAssociation, int attributeType,
301  const char* name, int arrayType, int numComponents, int numTuples);
302 
307  static void SetPointDataActiveScalarInfo(vtkInformation* info, int arrayType, int numComponents);
308 
315 
321  virtual void PrepareForNewData() { this->Initialize(); }
322 
330  virtual void ShallowCopy(vtkDataObject* src);
331 
339  virtual void DeepCopy(vtkDataObject* src);
340 
349  virtual int GetExtentType() { return VTK_PIECES_EXTENT; }
350 
355  virtual void Crop(const int* updateExtent);
356 
361  {
369  NUMBER_OF_ASSOCIATIONS
370  };
371 
377  {
385  NUMBER_OF_ATTRIBUTE_TYPES
386  };
387 
408 
421 
434  virtual bool SupportsGhostArray(int type);
435 
443 
450 
455 
460  {
464  FIELD_OPERATION_REMOVED
465  };
466 
471  static const char* GetAssociationTypeAsString(int associationType);
472 
477  static int GetAssociationTypeFromString(const char* associationName);
478 
479  // \ingroup InformationKeys
481  // \ingroup InformationKeys
483  // \ingroup InformationKeys
485  // \ingroup InformationKeys
487  // \ingroup InformationKeys
489  // \ingroup InformationKeys
491  // \ingroup InformationKeys
493  // \ingroup InformationKeys
495  // \ingroup InformationKeys
497  // \ingroup InformationKeys
499  // \ingroup InformationKeys
501  // \ingroup InformationKeys
503  // \ingroup InformationKeys
505  // \ingroup InformationKeys
507  // \ingroup InformationKeys
509  // \ingroup InformationKeys
511  // \ingroup InformationKeys
513  // \ingroup InformationKeys
515  // \ingroup InformationKeys
517  // \ingroup InformationKeys
519  // \ingroup InformationKeys
521  // \ingroup InformationKeys
523  // \ingroup InformationKeys
525  // \ingroup InformationKeys
527  // \ingroup InformationKeys
529  // \ingroup InformationKeys
531  // \ingroup InformationKeys
533 
534  // Key used to put SIL information in the output information by readers.
535  // \ingroup InformationKeys
537 
539 
545 
546 protected:
548  ~vtkDataObject() override;
549 
550  // General field data associated with data object
552 
553  // Keep track of data release during network execution
555 
556  // When was this data last generated?
558 
559  // Arbitrary extra information associated with this data object.
561 
562 private:
563  // Helper method for the ShallowCopy and DeepCopy methods.
564  void InternalDataObjectCopy(vtkDataObject* src);
565 
566  vtkDataObject(const vtkDataObject&) = delete;
567  void operator=(const vtkDataObject&) = delete;
568 };
569 
570 VTK_ABI_NAMESPACE_END
571 #endif
Abstract superclass for all arrays.
general representation of visualization data
virtual vtkFieldData * GetAttributesAsFieldData(int type)
Returns the attributes of the data object as a vtkFieldData.
virtual void ShallowCopy(vtkDataObject *src)
The goal of the method is to copy the data up to the array pointers only.
vtkMTimeType GetUpdateTime()
Used by Threaded ports to determine if they should initiate an asynchronous update (still in developm...
virtual void Initialize()
Restore data object to initial state,.
static vtkDataObject * New()
static vtkTypeBool GetGlobalReleaseDataFlag()
Turn on/off flag to control whether every object releases its data after being used by a filter.
virtual int GetAttributeTypeForArray(vtkAbstractArray *arr)
Retrieves the attribute type that an array came from.
static vtkInformationIntegerKey * DATA_NUMBER_OF_PIECES()
static vtkInformationDoubleVectorKey * BOUNDING_BOX()
static vtkInformationDoubleVectorKey * FIELD_RANGE()
virtual unsigned long GetActualMemorySize()
Return the actual size of the data in kibibytes (1024 bytes).
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...
virtual void Crop(const int *updateExtent)
This method crops the data object (if necessary) so that the extent matches the update extent.
static vtkInformationIntegerKey * FIELD_OPERATION()
static vtkInformationDoubleVectorKey * SPACING()
static const char * GetAssociationTypeAsString(int associationType)
Given an integer association type, this static method returns a string type for the attribute (i....
FieldOperations
Possible values for the FIELD_OPERATION information entry.
@ FIELD_OPERATION_REINTERPOLATED
static vtkInformationIntegerKey * FIELD_ASSOCIATION()
~vtkDataObject() override
vtkTimeStamp UpdateTime
static vtkInformationIntegerKey * FIELD_ACTIVE_ATTRIBUTE()
virtual void DeepCopy(vtkDataObject *src)
The goal of the method is to copy the complete data from src into this object.
static int GetAssociationTypeFromString(const char *associationName)
Given a string association name, this static method returns an integer association type for the attri...
vtkFieldData * FieldData
virtual bool SupportsGhostArray(int type)
Returns if this type of data object support ghost array for specified type.
void ReleaseData()
Release data back to system to conserve memory resource.
FieldAssociations
Possible values for the FIELD_ASSOCIATION information entry.
@ FIELD_ASSOCIATION_POINTS_THEN_CELLS
@ FIELD_ASSOCIATION_VERTICES
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.
static vtkInformationDoubleVectorKey * DIRECTION()
static vtkDataObject * GetData(vtkInformationVector *v, int i=0)
Retrieve an instance of this class from an information object.
static vtkInformationIntegerKey * FIELD_ARRAY_TYPE()
virtual void SetInformation(vtkInformation *)
Set/Get the information object associated with this data object.
virtual void PrepareForNewData()
make the output data ready for new data to be inserted.
void GlobalReleaseDataFlagOff()
Turn on/off flag to control whether every object releases its data after being used by a filter.
static vtkInformationIntegerKey * FIELD_ATTRIBUTE_TYPE()
vtkTypeBool DataReleased
static vtkInformationIntegerKey * DATA_PIECE_NUMBER()
AttributeTypes
Possible attribute types.
static void RemoveNamedFieldInformation(vtkInformation *info, int fieldAssociation, const char *name)
Remove the info associated with an array.
static vtkInformationIntegerKey * DATA_EXTENT_TYPE()
virtual void CopyInformationFromPipeline(vtkInformation *vtkNotUsed(info))
Copy from the pipeline information to the data object's own information.
static vtkInformationInformationVectorKey * POINT_DATA_VECTOR()
static vtkInformationIntegerKey * DATA_NUMBER_OF_GHOST_LEVELS()
void DataHasBeenGenerated()
This method is called by the source when it executes to generate data.
static vtkInformationInformationVectorKey * CELL_DATA_VECTOR()
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual int GetDataObjectType()
Return class name of data type.
vtkMTimeType GetMTime() override
Data objects are composite objects and need to check each part for MTime.
static vtkInformationInformationVectorKey * VERTEX_DATA_VECTOR()
static vtkInformationIntegerKey * FIELD_NUMBER_OF_TUPLES()
static vtkInformationStringKey * FIELD_NAME()
static vtkInformationDataObjectKey * DATA_OBJECT()
static vtkInformationIntegerVectorKey * ALL_PIECES_EXTENT()
static vtkInformationStringKey * DATA_TYPE_NAME()
static vtkInformationDataObjectKey * SIL()
void GlobalReleaseDataFlagOn()
Turn on/off flag to control whether every object releases its data after being used by a filter.
static void SetPointDataActiveScalarInfo(vtkInformation *info, int arrayType, int numComponents)
Convenience version of previous method for use (primarily) by the Imaging filters.
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...
static vtkInformationInformationVectorKey * EDGE_DATA_VECTOR()
static void SetGlobalReleaseDataFlag(vtkTypeBool val)
Turn on/off flag to control whether every object releases its data after being used by a filter.
static vtkDataObject * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
static vtkInformationIntegerVectorKey * PIECE_EXTENT()
static vtkInformationDoubleVectorKey * ORIGIN()
virtual void CopyInformationToPipeline(vtkInformation *vtkNotUsed(info))
Copy information from this data object to the pipeline information.
virtual void SetFieldData(vtkFieldData *)
Assign or retrieve a general field data to this data object.
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,...
virtual int GetExtentType()
The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstruct...
static vtkInformationIntegerKey * FIELD_NUMBER_OF_COMPONENTS()
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...
virtual vtkIdType GetNumberOfElements(int type)
Get the number of elements for a specific attribute type (POINT, CELL, etc.).
vtkInformation * Information
static vtkInformationDoubleKey * DATA_TIME_STEP()
static vtkInformationIntegerPointerKey * DATA_EXTENT()
represent and manipulate attribute data in a dataset
represent and manipulate fields of data
Definition: vtkFieldData.h:161
a simple class to control print indentation
Definition: vtkIndent.h:108
Key for vtkDataObject values.
Key for double values in vtkInformation.
Key for integer values in vtkInformation.
Key for string values in vtkInformation.
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
abstract base class for most VTK objects
Definition: vtkObject.h:161
record modification and/or execution time
Definition: vtkTimeStamp.h:44
dynamic, self-adjusting array of unsigned char
@ info
Definition: vtkX3D.h:376
@ type
Definition: vtkX3D.h:516
@ name
Definition: vtkX3D.h:219
int vtkTypeBool
Definition: vtkABI.h:64
#define VTK_PIECES_EXTENT
int vtkIdType
Definition: vtkType.h:315
#define VTK_DATA_OBJECT
Definition: vtkType.h:72
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:270