vtkCompositeDataSet Class Reference
#include <vtkCompositeDataSet.h>
Detailed Description
abstact superclass for composite (multi-block or AMR) datasetsvtkCompositeDataSet 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 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 buit.
- See also:
- vtkCompositeDataIterator
Definition at line 40 of file vtkCompositeDataSet.h.
Member Typedef Documentation
Reimplemented from vtkDataObject.
Reimplemented in vtkHierarchicalBoxDataSet, vtkMultiBlockDataSet, vtkMultiPieceDataSet, and vtkTemporalDataSet.
Definition at line 43 of file vtkCompositeDataSet.h.
Constructor & Destructor Documentation
| vtkCompositeDataSet::vtkCompositeDataSet | ( | ) | [protected] |
| vtkCompositeDataSet::~vtkCompositeDataSet | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkCompositeDataSet::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkDataObject.
Reimplemented in vtkHierarchicalBoxDataSet, vtkMultiBlockDataSet, vtkMultiPieceDataSet, and vtkTemporalDataSet.
| 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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkDataObject.
Reimplemented in vtkHierarchicalBoxDataSet, vtkMultiBlockDataSet, vtkMultiPieceDataSet, and vtkTemporalDataSet.
| 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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkDataObject.
Reimplemented in vtkHierarchicalBoxDataSet, vtkMultiBlockDataSet, vtkMultiPieceDataSet, and vtkTemporalDataSet.
| static vtkCompositeDataSet* vtkCompositeDataSet::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkDataObject.
Reimplemented in vtkHierarchicalBoxDataSet, vtkMultiBlockDataSet, vtkMultiPieceDataSet, and vtkTemporalDataSet.
| 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 vtkHierarchicalBoxDataSet, vtkMultiBlockDataSet, vtkMultiPieceDataSet, and vtkTemporalDataSet.
| virtual vtkCompositeDataIterator* vtkCompositeDataSet::NewIterator | ( | ) | [virtual] |
Return a new iterator (the iterator has to be deleted by user).
Reimplemented in vtkHierarchicalBoxDataSet.
| virtual int vtkCompositeDataSet::GetDataObjectType | ( | ) | [inline, virtual] |
Return class name of data type (see vtkType.h for definitions).
Reimplemented from vtkDataObject.
Reimplemented in vtkHierarchicalBoxDataSet, vtkMultiBlockDataSet, vtkMultiPieceDataSet, and vtkTemporalDataSet.
Definition at line 50 of file vtkCompositeDataSet.h.
| virtual vtkAlgorithmOutput* vtkCompositeDataSet::GetProducerPort | ( | ) | [virtual] |
Get the port currently producing this object.
Reimplemented from vtkDataObject.
| virtual void vtkCompositeDataSet::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.
| virtual void vtkCompositeDataSet::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).
Reimplemented in vtkHierarchicalBoxDataSet.
| virtual vtkDataObject* vtkCompositeDataSet::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).
Reimplemented in vtkHierarchicalBoxDataSet.
| virtual vtkInformation* vtkCompositeDataSet::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 vtkHierarchicalBoxDataSet, vtkMultiBlockDataSet, vtkMultiPieceDataSet, and vtkTemporalDataSet.
| virtual int vtkCompositeDataSet::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 vtkHierarchicalBoxDataSet, vtkMultiBlockDataSet, vtkMultiPieceDataSet, and vtkTemporalDataSet.
| static vtkCompositeDataSet* vtkCompositeDataSet::GetData | ( | vtkInformation * | info | ) | [static] |
Retrieve an instance of this class from an information object.
Reimplemented from vtkDataObject.
Reimplemented in vtkHierarchicalBoxDataSet, vtkMultiBlockDataSet, vtkMultiPieceDataSet, and vtkTemporalDataSet.
| 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 vtkHierarchicalBoxDataSet, vtkMultiBlockDataSet, vtkMultiPieceDataSet, and vtkTemporalDataSet.
| virtual void vtkCompositeDataSet::Initialize | ( | ) | [virtual] |
Restore data object to initial state,
Reimplemented from vtkDataObject.
| virtual void vtkCompositeDataSet::ShallowCopy | ( | vtkDataObject * | src | ) | [virtual] |
Shallow and Deep copy.
Reimplemented from vtkDataObject.
| virtual void vtkCompositeDataSet::DeepCopy | ( | vtkDataObject * | src | ) | [virtual] |
Shallow and Deep copy.
Reimplemented from vtkDataObject.
| 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.
| void vtkCompositeDataSet::SetNumberOfChildren | ( | unsigned int | num | ) | [protected] |
Set the number of children.
| unsigned int vtkCompositeDataSet::GetNumberOfChildren | ( | ) | [protected] |
Get the number of children.
| void vtkCompositeDataSet::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.
| vtkDataObject* vtkCompositeDataSet::GetChild | ( | unsigned int | num | ) | [protected] |
Returns a child dataset at a given index.
| vtkInformation* vtkCompositeDataSet::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 vtkCompositeDataSet::SetChildMetaData | ( | unsigned int | index, | |
| vtkInformation * | info | |||
| ) | [protected] |
Sets the meta-data at a given index.
| int vtkCompositeDataSet::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 vtkCompositeDataIterator [friend] |
Definition at line 141 of file vtkCompositeDataSet.h.
Member Data Documentation
Definition at line 139 of file vtkCompositeDataSet.h.
The documentation for this class was generated from the following file:
- dox/Filtering/vtkCompositeDataSet.h
