VTK  9.4.20250507
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#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
143
144VTK_ABI_NAMESPACE_BEGIN
145class vtkAbstractArray;
147class vtkFieldData;
148class vtkInformation;
159
160#define VTK_PIECES_EXTENT 0
161#define VTK_3D_EXTENT 1
162#define VTK_TIME_EXTENT 2
163
164class VTKCOMMONDATAMODEL_EXPORT VTK_MARSHALAUTO vtkDataObject : public vtkObject
165{
166public:
168
169 vtkTypeMacro(vtkDataObject, vtkObject);
170 void PrintSelf(ostream& os, vtkIndent indent) override;
171
173
176 vtkGetObjectMacro(Information, vtkInformation);
179
185
189 virtual void Initialize();
190
197
199
202 vtkGetMacro(DataReleased, vtkTypeBool);
204
206
215
217
221 vtkGetObjectMacro(FieldData, vtkFieldData);
223
230 virtual int GetDataObjectType() VTK_FUTURE_CONST { return VTK_DATA_OBJECT; }
231
237
245 virtual unsigned long GetActualMemorySize();
246
251 virtual void CopyInformationFromPipeline(vtkInformation* vtkNotUsed(info)) {}
252
258 virtual void CopyInformationToPipeline(vtkInformation* vtkNotUsed(info)) {}
259
267 vtkInformation* info, int fieldAssociation, int attributeType);
268
275 vtkInformation* info, int fieldAssociation, const char* name);
276
281 vtkInformation* info, int fieldAssociation, const char* name);
282
290 vtkInformation* info, int fieldAssociation, const char* attributeName, int attributeType);
291
301 static void SetActiveAttributeInfo(vtkInformation* info, int fieldAssociation, int attributeType,
302 const char* name, int arrayType, int numComponents, int numTuples);
303
308 static void SetPointDataActiveScalarInfo(vtkInformation* info, int arrayType, int numComponents);
309
316
322 virtual void PrepareForNewData() { this->Initialize(); }
323
331 virtual void ShallowCopy(vtkDataObject* src);
332
340 virtual void DeepCopy(vtkDataObject* src);
341
350 virtual int GetExtentType() VTK_FUTURE_CONST { return VTK_PIECES_EXTENT; }
351
356 virtual void Crop(const int* updateExtent);
357
362 {
370 NUMBER_OF_ASSOCIATIONS
371 };
372
378 {
386 NUMBER_OF_ATTRIBUTE_TYPES
387 };
388
409
422
435 virtual bool SupportsGhostArray(int type);
436
444
451
456
461 {
465 FIELD_OPERATION_REMOVED
466 };
467
472 static const char* GetAssociationTypeAsString(int associationType);
473
478 static int GetAssociationTypeFromString(const char* associationName);
479
588
589 // Key used to put SIL information in the output information by readers.
594
596
602
603protected:
605 ~vtkDataObject() override;
606
607 // General field data associated with data object
609
610 // Keep track of data release during network execution
612
613 // When was this data last generated?
615
616 // Arbitrary extra information associated with this data object.
618
619private:
620 // Helper method for the ShallowCopy and DeepCopy methods.
621 void InternalDataObjectCopy(vtkDataObject* src);
622
623 vtkDataObject(const vtkDataObject&) = delete;
624 void operator=(const vtkDataObject&) = delete;
625};
626
627VTK_ABI_NAMESPACE_END
628#endif
Abstract superclass for all arrays.
general representation of visualization data
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 void ShallowCopy(vtkDataObject *src)
The goal of the method is to copy the data up to the array pointers only.
virtual vtkFieldData * GetAttributesAsFieldData(int type)
Returns the attributes of the data object as a vtkFieldData.
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 const char * GetAssociationTypeAsString(int associationType)
Given an integer association type, this static method returns a string type for the attribute (i....
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.
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.
virtual int GetDataObjectType() VTK_FUTURE_CONST
Return class name of data type.
FieldOperations
Possible values for the FIELD_OPERATION information entry.
@ FIELD_OPERATION_REINTERPOLATED
~vtkDataObject() override
vtkTimeStamp UpdateTime
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
static vtkDataObject * GetData(vtkInformationVector *v, int i=0)
Retrieve an instance of this class from an information object.
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.
vtkTypeBool DataReleased
AttributeTypes
Possible attribute types.
static void RemoveNamedFieldInformation(vtkInformation *info, int fieldAssociation, const char *name)
Remove the info associated with an array.
virtual void CopyInformationFromPipeline(vtkInformation *vtkNotUsed(info))
Copy from the pipeline information to the data object's own information.
virtual vtkDataSetAttributes * GetAttributes(int type)
Returns the attributes of the data object of the specified attribute type.
static vtkDataObject * GetData(vtkInformation *info)
Retrieve an instance of this class from an information 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() VTK_FUTURE_CONST
The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstruct...
void DataHasBeenGenerated()
This method is called by the source when it executes to generate data.
virtual vtkUnsignedCharArray * GetGhostArray(int type)
Returns the ghost arrays of the data object of the specified attribute type.
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.
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...
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 void SetGlobalReleaseDataFlag(vtkTypeBool val)
Turn on/off flag to control whether every object releases its data after being used by a filter.
static vtkDataObject * New()
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.
virtual vtkIdType GetNumberOfElements(int type)
Get the number of elements for a specific attribute type (POINT, CELL, etc.).
vtkInformation * Information
represent and manipulate attribute data in a dataset
represent and manipulate fields of data
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:162
record modification and/or execution time
dynamic, self-adjusting array of unsigned char
static vtkInformationIntegerKey * FIELD_ACTIVE_ATTRIBUTE()
static vtkInformationDoubleVectorKey * DIRECTION()
static vtkInformationDoubleVectorKey * SPACING()
static vtkInformationDoubleKey * DATA_TIME_STEP()
static vtkInformationInformationVectorKey * CELL_DATA_VECTOR()
static vtkInformationIntegerKey * FIELD_OPERATION()
static vtkInformationIntegerVectorKey * PIECE_EXTENT()
static vtkInformationIntegerKey * FIELD_ARRAY_TYPE()
static vtkInformationIntegerKey * FIELD_NUMBER_OF_COMPONENTS()
static vtkInformationIntegerKey * FIELD_ATTRIBUTE_TYPE()
static vtkInformationIntegerKey * DATA_EXTENT_TYPE()
static vtkInformationIntegerKey * FIELD_NUMBER_OF_TUPLES()
static vtkInformationDoubleVectorKey * FIELD_RANGE()
static vtkInformationIntegerKey * FIELD_ASSOCIATION()
static vtkInformationIntegerKey * DATA_NUMBER_OF_PIECES()
static vtkInformationInformationVectorKey * VERTEX_DATA_VECTOR()
static vtkInformationInformationVectorKey * EDGE_DATA_VECTOR()
static vtkInformationIntegerPointerKey * DATA_EXTENT()
static vtkInformationIntegerKey * DATA_NUMBER_OF_GHOST_LEVELS()
static vtkInformationStringKey * FIELD_NAME()
static vtkInformationDataObjectKey * SIL()
static vtkInformationDoubleVectorKey * ORIGIN()
static vtkInformationDoubleVectorKey * BOUNDING_BOX()
static vtkInformationStringKey * DATA_TYPE_NAME()
static vtkInformationInformationVectorKey * POINT_DATA_VECTOR()
static vtkInformationIntegerVectorKey * ALL_PIECES_EXTENT()
static vtkInformationDataObjectKey * DATA_OBJECT()
static vtkInformationIntegerKey * DATA_PIECE_NUMBER()
int vtkTypeBool
Definition vtkABI.h:64
#define VTK_PIECES_EXTENT
int vtkIdType
Definition vtkType.h:332
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:287
@ VTK_DATA_OBJECT
Definition vtkType.h:83
#define VTK_MARSHALAUTO