abstract superclass for composite (multi-block or AMR) datasets More...
#include <vtkCompositeDataSet.h>
Detailed Description
abstract superclass for composite (multi-block or AMR) datasets
vtkCompositeDataSet is an abstract class that represents a collection of datasets (including other composite datasets). It provides an interface to access the datasets through iterators. vtkCompositeDataSet provides methods that are used by subclasses to store the datasets. vtkCompositeDataSet provides the datastructure for a full tree representation. Subclasses provide the semantics for it and control how this tree is built.
- See also:
- vtkCompositeDataIterator
- Examples:
- vtkCompositeDataSet (Examples)
Definition at line 49 of file vtkCompositeDataSet.h.
Member Typedef Documentation
Reimplemented from vtkDataObject.
Reimplemented in vtkMultiBlockDataSet, vtkOverlappingAMR, vtkDataObjectTree, vtkMultiPieceDataSet, vtkHierarchicalBoxDataSet, vtkNonOverlappingAMR, and vtkUniformGridAMR.
Definition at line 52 of file vtkCompositeDataSet.h.
Constructor & Destructor Documentation
| vtkCompositeDataSet::vtkCompositeDataSet | ( | ) | [protected] |
| virtual vtkCompositeDataSet::~vtkCompositeDataSet | ( | ) | [protected, virtual] |
Member Function Documentation
| static int vtkCompositeDataSet::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 vtkDataObject.
Reimplemented in vtkMultiBlockDataSet, vtkOverlappingAMR, vtkDataObjectTree, vtkMultiPieceDataSet, vtkHierarchicalBoxDataSet, vtkNonOverlappingAMR, and vtkUniformGridAMR.
| virtual int vtkCompositeDataSet::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 vtkDataObject.
Reimplemented in vtkMultiBlockDataSet, vtkOverlappingAMR, vtkDataObjectTree, vtkMultiPieceDataSet, vtkHierarchicalBoxDataSet, vtkNonOverlappingAMR, and vtkUniformGridAMR.
| static vtkCompositeDataSet* vtkCompositeDataSet::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkDataObject.
Reimplemented in vtkMultiBlockDataSet, vtkOverlappingAMR, vtkDataObjectTree, vtkMultiPieceDataSet, vtkHierarchicalBoxDataSet, vtkNonOverlappingAMR, and vtkUniformGridAMR.
| virtual vtkObjectBase* vtkCompositeDataSet::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkDataObject.
Reimplemented in vtkMultiBlockDataSet, vtkOverlappingAMR, vtkDataObjectTree, vtkMultiPieceDataSet, vtkHierarchicalBoxDataSet, vtkNonOverlappingAMR, and vtkUniformGridAMR.
Reimplemented from vtkDataObject.
Reimplemented in vtkMultiBlockDataSet, vtkOverlappingAMR, vtkDataObjectTree, vtkMultiPieceDataSet, vtkHierarchicalBoxDataSet, vtkNonOverlappingAMR, and vtkUniformGridAMR.
| void vtkCompositeDataSet::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 vtkDataObject.
Reimplemented in vtkMultiBlockDataSet, vtkOverlappingAMR, vtkDataObjectTree, vtkUniformGridAMR, vtkMultiPieceDataSet, vtkHierarchicalBoxDataSet, and vtkNonOverlappingAMR.
| virtual vtkCompositeDataIterator* vtkCompositeDataSet::NewIterator | ( | ) | [pure virtual] |
Return a new iterator (the iterator has to be deleted by user).
Implemented in vtkDataObjectTree, vtkOverlappingAMR, vtkHierarchicalBoxDataSet, and vtkUniformGridAMR.
| virtual int vtkCompositeDataSet::GetDataObjectType | ( | ) | [inline, virtual] |
Return class name of data type (see vtkType.h for definitions).
Reimplemented from vtkDataObject.
Reimplemented in vtkMultiBlockDataSet, vtkOverlappingAMR, vtkMultiPieceDataSet, vtkHierarchicalBoxDataSet, vtkUniformGridAMR, and vtkNonOverlappingAMR.
Definition at line 59 of file vtkCompositeDataSet.h.
| virtual void vtkCompositeDataSet::CopyStructure | ( | vtkCompositeDataSet * | input | ) | [pure 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.
Implemented in vtkUniformGridAMR, and vtkDataObjectTree.
| virtual void vtkCompositeDataSet::SetDataSet | ( | vtkCompositeDataIterator * | iter, |
| vtkDataObject * | dataObj | ||
| ) | [pure 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).
Implemented in vtkUniformGridAMR, and vtkDataObjectTree.
| virtual vtkDataObject* vtkCompositeDataSet::GetDataSet | ( | vtkCompositeDataIterator * | iter | ) | [pure 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).
Implemented in vtkUniformGridAMR, and vtkDataObjectTree.
| virtual unsigned long vtkCompositeDataSet::GetActualMemorySize | ( | ) | [virtual] |
Return the actual size of the data in kilobytes. This number is valid only after the pipeline has updated.
Reimplemented from vtkDataObject.
Reimplemented in vtkDataObjectTree.
| static vtkCompositeDataSet* vtkCompositeDataSet::GetData | ( | vtkInformation * | info | ) | [static] |
Retrieve an instance of this class from an information object.
Reimplemented from vtkDataObject.
Reimplemented in vtkUniformGridAMR, vtkDataObjectTree, vtkMultiBlockDataSet, vtkOverlappingAMR, vtkMultiPieceDataSet, vtkHierarchicalBoxDataSet, and vtkNonOverlappingAMR.
| static vtkCompositeDataSet* vtkCompositeDataSet::GetData | ( | vtkInformationVector * | v, |
| int | i = 0 |
||
| ) | [static] |
Retrieve an instance of this class from an information object.
Reimplemented from vtkDataObject.
Reimplemented in vtkUniformGridAMR, vtkDataObjectTree, vtkMultiBlockDataSet, vtkOverlappingAMR, vtkMultiPieceDataSet, vtkHierarchicalBoxDataSet, and vtkNonOverlappingAMR.
| virtual void vtkCompositeDataSet::Initialize | ( | ) | [virtual] |
Restore data object to initial state,
Reimplemented from vtkDataObject.
Reimplemented in vtkDataObjectTree, and vtkUniformGridAMR.
| virtual void vtkCompositeDataSet::ShallowCopy | ( | vtkDataObject * | src | ) | [virtual] |
Shallow and Deep copy.
Reimplemented from vtkDataObject.
Reimplemented in vtkUniformGridAMR, and vtkDataObjectTree.
| virtual void vtkCompositeDataSet::DeepCopy | ( | vtkDataObject * | src | ) | [virtual] |
Shallow and Deep copy.
Reimplemented from vtkDataObject.
Reimplemented in vtkUniformGridAMR, and vtkDataObjectTree.
| virtual vtkIdType vtkCompositeDataSet::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 in vtkDataObjectTree.
| static vtkInformationStringKey* vtkCompositeDataSet::NAME | ( | ) | [static] |
Key used to put node name in the meta-data associated with a node.
The documentation for this class was generated from the following file:
- dox/Common/DataModel/vtkCompositeDataSet.h
