provides implementation for most abstract methods in the superclass vtkCompositeDataSet More...
#include <vtkDataObjectTree.h>
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 45 of file vtkDataObjectTree.h.
Member Typedef Documentation
Reimplemented from vtkCompositeDataSet.
Reimplemented in vtkMultiBlockDataSet, and vtkMultiPieceDataSet.
Definition at line 48 of file vtkDataObjectTree.h.
Constructor & Destructor Documentation
| vtkDataObjectTree::vtkDataObjectTree | ( | ) | [protected] |
| vtkDataObjectTree::~vtkDataObjectTree | ( | ) | [protected] |
Member Function Documentation
| static int vtkDataObjectTree::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type 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 vtkMultiBlockDataSet, and vtkMultiPieceDataSet.
| virtual int 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 vtkMultiBlockDataSet, and vtkMultiPieceDataSet.
| static vtkDataObjectTree* vtkDataObjectTree::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkCompositeDataSet.
Reimplemented in vtkMultiBlockDataSet, and vtkMultiPieceDataSet.
| virtual vtkObjectBase* vtkDataObjectTree::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkCompositeDataSet.
Reimplemented in vtkMultiBlockDataSet, and vtkMultiPieceDataSet.
| vtkDataObjectTree* vtkDataObjectTree::NewInstance | ( | ) | const |
Reimplemented from vtkCompositeDataSet.
Reimplemented in vtkMultiBlockDataSet, and vtkMultiPieceDataSet.
| void vtkDataObjectTree::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
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 vtkMultiBlockDataSet, and vtkMultiPieceDataSet.
| virtual vtkDataObjectTreeIterator* vtkDataObjectTree::NewTreeIterator | ( | ) | [virtual] |
Return a new iterator (the iterator has to be deleted by user).
| virtual vtkCompositeDataIterator* vtkDataObjectTree::NewIterator | ( | ) | [virtual] |
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.
| virtual void vtkDataObjectTree::CopyStructure | ( | vtkCompositeDataSet * | input | ) | [virtual] |
Copies the tree structure from the input. All pointers to non-composite data objects are intialized to NULL. This also shallow copies the meta data associated with all the nodes.
Implements vtkCompositeDataSet.
| virtual void vtkDataObjectTree::SetDataSet | ( | vtkCompositeDataIterator * | iter, |
| vtkDataObject * | dataObj | ||
| ) | [virtual] |
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.
| void vtkDataObjectTree::SetDataSetFrom | ( | vtkDataObjectTreeIterator * | iter, |
| vtkDataObject * | dataObj | ||
| ) |
Sets the data at the location provided by a vtkDataObjectTreeIterator
| virtual vtkDataObject* vtkDataObjectTree::GetDataSet | ( | vtkCompositeDataIterator * | iter | ) | [virtual] |
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.
| 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, and vtkMultiPieceDataSet.
| 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, and vtkMultiPieceDataSet.
| virtual unsigned long vtkDataObjectTree::GetActualMemorySize | ( | ) | [virtual] |
Return the actual size of the data in kilobytes. This number is valid only after the pipeline has updated.
Reimplemented from vtkCompositeDataSet.
| virtual void vtkDataObjectTree::Initialize | ( | ) | [virtual] |
Restore data object to initial state,
Reimplemented from vtkCompositeDataSet.
| virtual void vtkDataObjectTree::ShallowCopy | ( | vtkDataObject * | src | ) | [virtual] |
Shallow and Deep copy.
Reimplemented from vtkCompositeDataSet.
| virtual void vtkDataObjectTree::DeepCopy | ( | vtkDataObject * | src | ) | [virtual] |
Shallow and Deep copy.
Reimplemented from vtkCompositeDataSet.
| virtual vtkIdType vtkDataObjectTree::GetNumberOfPoints | ( | ) | [virtual] |
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.
| static vtkDataObjectTree* vtkDataObjectTree::GetData | ( | vtkInformation * | info | ) | [static] |
Retrieve an instance of this class from an information object.
Reimplemented from vtkCompositeDataSet.
Reimplemented in vtkMultiBlockDataSet, and vtkMultiPieceDataSet.
| static vtkDataObjectTree* vtkDataObjectTree::GetData | ( | vtkInformationVector * | v, |
| int | i = 0 |
||
| ) | [static] |
Retrieve an instance of this class from an information object.
Reimplemented from vtkCompositeDataSet.
Reimplemented in vtkMultiBlockDataSet, and vtkMultiPieceDataSet.
| void vtkDataObjectTree::SetNumberOfChildren | ( | unsigned int | num | ) | [protected] |
Set the number of children.
| unsigned int vtkDataObjectTree::GetNumberOfChildren | ( | ) | [protected] |
Get the number of children.
| 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.
| void vtkDataObjectTree::RemoveChild | ( | unsigned int | index | ) | [protected] |
Remove the child at a given index.
| vtkDataObject* vtkDataObjectTree::GetChild | ( | unsigned int | num | ) | [protected] |
Returns a child dataset at a given index.
| 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().
| void vtkDataObjectTree::SetChildMetaData | ( | unsigned int | index, |
| vtkInformation * | info | ||
| ) | [protected] |
Sets the meta-data at a given index.
| 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
friend class vtkDataObjectTreeIterator [friend] |
Definition at line 156 of file vtkDataObjectTree.h.
Member Data Documentation
vtkDataObjectTreeInternals* vtkDataObjectTree::Internals [protected] |
Definition at line 154 of file vtkDataObjectTree.h.
The documentation for this class was generated from the following file:
- dox/Common/DataModel/vtkDataObjectTree.h
