VTK  9.0.20200806
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkDataObjectTree Class Reference

provides implementation for most abstract methods in the superclass vtkCompositeDataSet More...

#include <vtkDataObjectTree.h>

Inheritance diagram for vtkDataObjectTree:
[legend]
Collaboration diagram for vtkDataObjectTree:
[legend]

Public Types

typedef vtkCompositeDataSet Superclass
 
- Public Types inherited from vtkCompositeDataSet
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...
 
vtkDataObjectTreeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual vtkDataObjectTreeIteratorNewTreeIterator ()
 Return a new iterator (the iterator has to be deleted by user). More...
 
vtkCompositeDataIteratorNewIterator () override
 Return a new iterator (the iterator has to be deleted by user). More...
 
void CopyStructure (vtkCompositeDataSet *input) override
 Copies the tree structure from the input. More...
 
void SetDataSet (vtkCompositeDataIterator *iter, vtkDataObject *dataObj) override
 Sets the data set at the location pointed by the iterator. More...
 
void SetDataSetFrom (vtkDataObjectTreeIterator *iter, vtkDataObject *dataObj)
 Sets the data at the location provided by a vtkDataObjectTreeIterator. More...
 
vtkDataObjectGetDataSet (vtkCompositeDataIterator *iter) override
 Returns the dataset located at the positiong pointed by the iterator. More...
 
virtual vtkInformationGetMetaData (vtkCompositeDataIterator *iter)
 Returns the meta-data associated with the position pointed by the iterator. More...
 
virtual int HasMetaData (vtkCompositeDataIterator *iter)
 Returns if any meta-data associated with the position pointed by the iterator. More...
 
unsigned long GetActualMemorySize () override
 Return the actual size of the data in kibibytes (1024 bytes). More...
 
void Initialize () override
 Restore data object to initial state,. More...
 
void ShallowCopy (vtkDataObject *src) override
 Shallow and Deep copy. More...
 
void DeepCopy (vtkDataObject *src) override
 
vtkIdType GetNumberOfPoints () override
 Returns the total number of points of all blocks. More...
 
vtkIdType GetNumberOfCells () override
 Returns the total number of cells of all blocks. More...
 
- Public Member Functions inherited from vtkCompositeDataSet
vtkCompositeDataSetNewInstance () const
 
int GetDataObjectType () override
 Return class name of data type (see vtkType.h for definitions). More...
 
vtkIdType GetNumberOfElements (int type) override
 Get the number of elements for a specific attribute type (POINT, CELL, etc.). More...
 
void GetBounds (double bounds[6])
 Return the geometric bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax). More...
 
- Public Member Functions inherited from vtkDataObject
vtkDataObjectNewInstance () const
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this data object. More...
 
virtual void SetInformation (vtkInformation *)
 
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...
 
virtual int GetDataReleased ()
 Get the flag indicating the data has been released. More...
 
void GlobalReleaseDataFlagOn ()
 
void GlobalReleaseDataFlagOff ()
 
virtual void SetFieldData (vtkFieldData *)
 Assign or retrieve a general field data to this data object. More...
 
virtual vtkFieldDataGetFieldData ()
 
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 vtkDataSetAttributesGetAttributes (int type)
 Returns the attributes of the data object of the specified attribute type. More...
 
virtual vtkDataArrayGetGhostArray (int type)
 Returns the ghost arrays of the data object of the specified atribute type. More...
 
virtual vtkFieldDataGetAttributesAsFieldData (int type)
 Returns the attributes of the data object as a vtkFieldData. More...
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 Retrieves the attribute type that an array came from. 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataObjectTreeSafeDownCast (vtkObjectBase *o)
 
static vtkDataObjectTreeGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkDataObjectTreeGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkCompositeDataSet
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCompositeDataSetSafeDownCast (vtkObjectBase *o)
 
static vtkCompositeDataSetGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkCompositeDataSetGetData (vtkInformationVector *v, int i=0)
 
static vtkInformationStringKeyNAME ()
 Key used to put node name in the meta-data associated with a node. More...
 
static vtkInformationIntegerKeyCURRENT_PROCESS_CAN_LOAD_BLOCK ()
 Key used to indicate that the current process can load the data in the node. More...
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObjectNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataObjectSafeDownCast (vtkObjectBase *o)
 
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 ()
 
static vtkInformationGetActiveFieldInformation (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 vtkInformationGetNamedFieldInformation (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 vtkInformationSetActiveAttribute (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 *associationName)
 Given a string association name, this static method returns an integer association type for the attribute (i.e. More...
 
static vtkInformationStringKeyDATA_TYPE_NAME ()
 
static vtkInformationDataObjectKeyDATA_OBJECT ()
 
static vtkInformationIntegerKeyDATA_EXTENT_TYPE ()
 
static vtkInformationIntegerPointerKeyDATA_EXTENT ()
 
static vtkInformationIntegerVectorKeyALL_PIECES_EXTENT ()
 
static vtkInformationIntegerKeyDATA_PIECE_NUMBER ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_GHOST_LEVELS ()
 
static vtkInformationDoubleKeyDATA_TIME_STEP ()
 
static vtkInformationInformationVectorKeyPOINT_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyCELL_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyVERTEX_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyEDGE_DATA_VECTOR ()
 
static vtkInformationIntegerKeyFIELD_ARRAY_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ASSOCIATION ()
 
static vtkInformationIntegerKeyFIELD_ATTRIBUTE_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ACTIVE_ATTRIBUTE ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_COMPONENTS ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_TUPLES ()
 
static vtkInformationIntegerKeyFIELD_OPERATION ()
 
static vtkInformationDoubleVectorKeyFIELD_RANGE ()
 
static vtkInformationIntegerVectorKeyPIECE_EXTENT ()
 
static vtkInformationStringKeyFIELD_NAME ()
 
static vtkInformationDoubleVectorKeyORIGIN ()
 
static vtkInformationDoubleVectorKeySPACING ()
 
static vtkInformationDoubleVectorKeyDIRECTION ()
 
static vtkInformationDoubleVectorKeyBOUNDING_BOX ()
 
static vtkInformationDataObjectKeySIL ()
 
static vtkDataObjectGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object. More...
 
static vtkDataObjectGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDataObjectTree ()
 
 ~vtkDataObjectTree () override
 
void SetNumberOfChildren (unsigned int num)
 Set the number of children. More...
 
unsigned int GetNumberOfChildren ()
 Get the number of children. More...
 
void SetChild (unsigned int index, vtkDataObject *)
 Set child dataset at a given index. More...
 
void RemoveChild (unsigned int index)
 Remove the child at a given index. More...
 
vtkDataObjectGetChild (unsigned int index)
 Returns a child dataset at a given index. More...
 
vtkInformationGetChildMetaData (unsigned int index)
 Returns the meta-data at a given index. More...
 
void SetChildMetaData (unsigned int index, vtkInformation *info)
 Sets the meta-data at a given index. More...
 
int HasChildMetaData (unsigned int index)
 Returns if meta-data information is available for the given child index. More...
 
- Protected Member Functions inherited from vtkCompositeDataSet
 vtkCompositeDataSet ()
 
 ~vtkCompositeDataSet () 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkDataObjectTreeInternalsInternals
 
- Protected Attributes inherited from vtkDataObject
vtkFieldDataFieldData
 
int DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformationInformation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkDataObjectTreeIterator
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

provides implementation for most abstract methods in the superclass vtkCompositeDataSet

vtkDataObjectTree is represents a collection of datasets (including other composite datasets). It provides an interface to access the datasets through iterators. vtkDataObjectTree provides methods that are used by subclasses to store the datasets. vtkDataObjectTree provides the datastructure for a full tree representation. Subclasses provide the semantics for it and control how this tree is built.

See also
vtkDataObjectTreeIterator

Definition at line 46 of file vtkDataObjectTree.h.

Member Typedef Documentation

◆ Superclass

Definition at line 49 of file vtkDataObjectTree.h.

Constructor & Destructor Documentation

◆ vtkDataObjectTree()

vtkDataObjectTree::vtkDataObjectTree ( )
protected

◆ ~vtkDataObjectTree()

vtkDataObjectTree::~vtkDataObjectTree ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkDataObjectTree::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkDataObjectTree::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 vtkCompositeDataSet.

Reimplemented in vtkPartitionedDataSet, vtkMultiBlockDataSet, vtkMultiPieceDataSet, and vtkPartitionedDataSetCollection.

◆ SafeDownCast()

static vtkDataObjectTree* vtkDataObjectTree::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkDataObjectTree::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkDataObjectTree* vtkDataObjectTree::NewInstance ( ) const

◆ PrintSelf()

void vtkDataObjectTree::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 vtkCompositeDataSet.

Reimplemented in vtkPartitionedDataSet, vtkMultiBlockDataSet, vtkMultiPieceDataSet, and vtkPartitionedDataSetCollection.

◆ NewTreeIterator()

virtual vtkDataObjectTreeIterator* vtkDataObjectTree::NewTreeIterator ( )
virtual

Return a new iterator (the iterator has to be deleted by user).

◆ NewIterator()

vtkCompositeDataIterator* vtkDataObjectTree::NewIterator ( )
overridevirtual

Return a new iterator (the iterator has to be deleted by user).

Use NewTreeIterator when you have a pointer to a vtkDataObjectTree and NewIterator when you have a pointer to a vtkCompositeDataSet; NewIterator is inherited and calls NewTreeIterator internally.

Implements vtkCompositeDataSet.

◆ CopyStructure()

void vtkDataObjectTree::CopyStructure ( vtkCompositeDataSet input)
overridevirtual

Copies the tree structure from the input.

All pointers to non-composite data objects are initialized to nullptr. This also shallow copies the meta data associated with all the nodes.

Implements vtkCompositeDataSet.

Reimplemented in vtkPartitionedDataSetCollection.

◆ SetDataSet()

void vtkDataObjectTree::SetDataSet ( vtkCompositeDataIterator iter,
vtkDataObject dataObj 
)
overridevirtual

Sets the data set at the location pointed by the iterator.

The iterator does not need to be iterating over this dataset itself. It can be any composite datasite with similar structure (achieved by using CopyStructure).

Implements vtkCompositeDataSet.

◆ SetDataSetFrom()

void vtkDataObjectTree::SetDataSetFrom ( vtkDataObjectTreeIterator iter,
vtkDataObject dataObj 
)

Sets the data at the location provided by a vtkDataObjectTreeIterator.

◆ GetDataSet()

vtkDataObject* vtkDataObjectTree::GetDataSet ( vtkCompositeDataIterator iter)
overridevirtual

Returns the dataset located at the positiong pointed by the iterator.

The iterator does not need to be iterating over this dataset itself. It can be an iterator for composite dataset with similar structure (achieved by using CopyStructure).

Implements vtkCompositeDataSet.

◆ GetMetaData()

virtual vtkInformation* vtkDataObjectTree::GetMetaData ( vtkCompositeDataIterator iter)
virtual

Returns the meta-data associated with the position pointed by the iterator.

This will create a new vtkInformation object if none already exists. Use HasMetaData to avoid creating the vtkInformation object unnecessarily. The iterator does not need to be iterating over this dataset itself. It can be an iterator for composite dataset with similar structure (achieved by using CopyStructure).

Reimplemented in vtkMultiBlockDataSet, vtkPartitionedDataSetCollection, and vtkPartitionedDataSet.

◆ HasMetaData()

virtual int vtkDataObjectTree::HasMetaData ( vtkCompositeDataIterator iter)
virtual

Returns if any meta-data associated with the position pointed by the iterator.

The iterator does not need to be iterating over this dataset itself. It can be an iterator for composite dataset with similar structure (achieved by using CopyStructure).

Reimplemented in vtkMultiBlockDataSet, vtkPartitionedDataSetCollection, and vtkPartitionedDataSet.

◆ GetActualMemorySize()

unsigned long vtkDataObjectTree::GetActualMemorySize ( )
overridevirtual

Return the actual size of the data in kibibytes (1024 bytes).

This number is valid only after the pipeline has updated.

Reimplemented from vtkCompositeDataSet.

◆ Initialize()

void vtkDataObjectTree::Initialize ( )
overridevirtual

Restore data object to initial state,.

Reimplemented from vtkCompositeDataSet.

Reimplemented in vtkPartitionedDataSetCollection.

◆ ShallowCopy()

void vtkDataObjectTree::ShallowCopy ( vtkDataObject src)
overridevirtual

Shallow and Deep copy.

Reimplemented from vtkCompositeDataSet.

Reimplemented in vtkPartitionedDataSetCollection.

◆ DeepCopy()

void vtkDataObjectTree::DeepCopy ( vtkDataObject src)
overridevirtual

Reimplemented from vtkCompositeDataSet.

Reimplemented in vtkPartitionedDataSetCollection.

◆ GetNumberOfPoints()

vtkIdType vtkDataObjectTree::GetNumberOfPoints ( )
overridevirtual

Returns the total number of points of all blocks.

This will iterate over all blocks and call GetNumberOfPoints() so it might be expansive.

Reimplemented from vtkCompositeDataSet.

◆ GetNumberOfCells()

vtkIdType vtkDataObjectTree::GetNumberOfCells ( )
overridevirtual

Returns the total number of cells of all blocks.

This will iterate over all blocks and call GetNumberOfPoints() so it might be expensive.

Reimplemented from vtkCompositeDataSet.

◆ GetData() [1/2]

static vtkDataObjectTree* vtkDataObjectTree::GetData ( vtkInformation info)
static

Retrieve an instance of this class from an information object.

◆ GetData() [2/2]

static vtkDataObjectTree* vtkDataObjectTree::GetData ( vtkInformationVector v,
int  i = 0 
)
static

◆ SetNumberOfChildren()

void vtkDataObjectTree::SetNumberOfChildren ( unsigned int  num)
protected

Set the number of children.

◆ GetNumberOfChildren()

unsigned int vtkDataObjectTree::GetNumberOfChildren ( )
protected

Get the number of children.

◆ SetChild()

void vtkDataObjectTree::SetChild ( unsigned int  index,
vtkDataObject  
)
protected

Set child dataset at a given index.

The number of children is adjusted to to be greater than the index specified.

◆ RemoveChild()

void vtkDataObjectTree::RemoveChild ( unsigned int  index)
protected

Remove the child at a given index.

◆ GetChild()

vtkDataObject* vtkDataObjectTree::GetChild ( unsigned int  index)
protected

Returns a child dataset at a given index.

◆ GetChildMetaData()

vtkInformation* vtkDataObjectTree::GetChildMetaData ( unsigned int  index)
protected

Returns the meta-data at a given index.

If the index is valid, however, no information object is set, then a new one will created and returned. To avoid unnecessary creation, use HasMetaData().

◆ SetChildMetaData()

void vtkDataObjectTree::SetChildMetaData ( unsigned int  index,
vtkInformation info 
)
protected

Sets the meta-data at a given index.

◆ HasChildMetaData()

int vtkDataObjectTree::HasChildMetaData ( unsigned int  index)
protected

Returns if meta-data information is available for the given child index.

Returns 1 is present, 0 otherwise.

Friends And Related Function Documentation

◆ vtkDataObjectTreeIterator

friend class vtkDataObjectTreeIterator
friend

Definition at line 204 of file vtkDataObjectTree.h.

Member Data Documentation

◆ Internals

vtkDataObjectTreeInternals* vtkDataObjectTree::Internals
protected

Definition at line 202 of file vtkDataObjectTree.h.


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