vtkCompositeDataSet Class Reference

#include <vtkCompositeDataSet.h>

Inheritance diagram for vtkCompositeDataSet:

[legend]Collaboration diagram for vtkCompositeDataSet:

[legend]List of all members.

---

Detailed Description

abstact superclass for composite (multi-block or AMR) datasets

vtkCompositeDataSet is an abstract class that represents a collection of datasets (including other composite datasets). This superclass does not implement an actual method for storing datasets. It only provides an interface to access the datasets through iterators.

See also:

vtkCompositeDataIterator

Examples:

vtkCompositeDataSet (Examples)

Tests:

vtkCompositeDataSet (Tests)

Definition at line 42 of file vtkCompositeDataSet.h.

Public Types
typedef vtkDataObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkCompositeDataIterator *	NewIterator ()=0
virtual int	GetDataObjectType ()
virtual void	Initialize ()
virtual void	AddDataSet (vtkInformation *index, vtkDataObject *dobj)=0
virtual vtkDataObject *	GetDataSet (vtkInformation *index)=0
virtual void	SetPipelineInformation (vtkInformation *)
virtual vtkAlgorithmOutput *	GetProducerPort ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkCompositeDataSet *	SafeDownCast (vtkObject *o)
static vtkInformationIntegerKey *	INDEX ()
static vtkInformationDataObjectKey *	COMPOSITE_DATA_SET ()
static vtkCompositeDataSet *	GetData (vtkInformation *info)
static vtkCompositeDataSet *	GetData (vtkInformationVector *v, int i=0)
Protected Member Functions
	vtkCompositeDataSet ()
	~vtkCompositeDataSet ()

---

Member Typedef Documentation

typedef vtkDataObject vtkCompositeDataSet::Superclass

Reimplemented from vtkDataObject. Reimplemented in vtkHierarchicalBoxDataSet, and vtkHierarchicalDataSet. Definition at line 45 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, and vtkHierarchicalDataSet.

static int vtkCompositeDataSet::IsTypeOf (  const char *  type  )  [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, and vtkHierarchicalDataSet.

virtual int vtkCompositeDataSet::IsA (  const char *  type  )  [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, and vtkHierarchicalDataSet.

static vtkCompositeDataSet* vtkCompositeDataSet::SafeDownCast (  vtkObject *  o  )  [static]

Reimplemented from vtkDataObject. Reimplemented in vtkHierarchicalBoxDataSet, and vtkHierarchicalDataSet.

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, and vtkHierarchicalDataSet.

virtual vtkCompositeDataIterator* vtkCompositeDataSet::NewIterator (   )  [pure virtual]

Return a new (forward) iterator (the iterator has to be deleted by user) Implemented in vtkHierarchicalDataSet.

virtual int vtkCompositeDataSet::GetDataObjectType (   )  [inline, virtual]

Return class name of data type (see vtkSystemIncludes.h for definitions). Reimplemented from vtkDataObject. Reimplemented in vtkHierarchicalBoxDataSet, and vtkHierarchicalDataSet. Definition at line 54 of file vtkCompositeDataSet.h. References VTK_COMPOSITE_DATA_SET.

virtual void vtkCompositeDataSet::Initialize (   )  [virtual]

Restore data object to initial state, Reimplemented from vtkDataObject. Reimplemented in vtkHierarchicalDataSet.

virtual void vtkCompositeDataSet::AddDataSet (  vtkInformation *  index, vtkDataObject *  dobj )  [pure virtual]

Adds dobj to the composite dataset. Where the dataset goes is determined by appropriate keys in the index information object. Which keys are used depends on the actual subclass. Implemented in vtkHierarchicalDataSet.

virtual vtkDataObject* vtkCompositeDataSet::GetDataSet (  vtkInformation *  index  )  [pure virtual]

Returns a dataset pointed by appropriate keys in the index information object. Which keys are used depends on the actual subclass. Implemented in vtkHierarchicalBoxDataSet, and vtkHierarchicalDataSet.

virtual void vtkCompositeDataSet::SetPipelineInformation (  vtkInformation *   )  [virtual]

Set the pipeline information object that owns this data object. Reimplemented from vtkDataObject.

virtual vtkAlgorithmOutput* vtkCompositeDataSet::GetProducerPort (   )  [virtual]

Get the port currently producing this object. Reimplemented from vtkDataObject.

static vtkInformationIntegerKey* vtkCompositeDataSet::INDEX (   )  [static]

static vtkInformationDataObjectKey* vtkCompositeDataSet::COMPOSITE_DATA_SET (   )  [static]

static vtkCompositeDataSet* vtkCompositeDataSet::GetData (  vtkInformation *  info  )  [static]

Retrieve an instance of this class from an information object. Reimplemented from vtkDataObject. Reimplemented in vtkHierarchicalDataSet.

static vtkCompositeDataSet* vtkCompositeDataSet::GetData (  vtkInformationVector *  v, int  i = 0 )  [static]

Reimplemented from vtkDataObject. Reimplemented in vtkHierarchicalDataSet.

---

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

• dox/Filtering/vtkCompositeDataSet.h

---