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 vtkCompositeDataVisitor

Created by:

Bertel, Francois

CVS contributions (if > 5%):

Bertel, Francois (80%)
Martin, Ken (19%)

CVS logs (CVSweb):

.h (/Filtering/vtkCompositeDataSet.h)
.cxx (/Filtering/vtkCompositeDataSet.cxx)

Definition at line 46 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 vtkCompositeDataVisitor * NewVisitor ()=0

virtual int GetDataObjectType ()

virtual void Initialize ()

void SetUpdateExtent (int piece, int numPieces, int ghostLevel)

void SetUpdateExtent (int piece, int numPieces)

void GetUpdateExtent (int &piece, int &numPieces, int &ghostLevel)

virtual int * GetUpdateExtent ()

virtual void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

virtual void GetUpdateExtent (int extent[6])

void SetUpdateExtent (int x1, int x2, int y1, int y2, int z1, int z2)

void SetUpdateExtent (int ext[6])

Static Public Member Functions

int IsTypeOf (const char *type)

vtkCompositeDataSet * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkCompositeDataSet ()

~vtkCompositeDataSet ()

Member Typedef Documentation

typedef vtkDataObject vtkCompositeDataSet::Superclass

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

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

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

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

Reimplemented from vtkDataObject.
Reimplemented in vtkHierarchicalBoxDataSet, vtkHierarchicalDataSet, and vtkMultiBlockDataSet.

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

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

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

virtual vtkCompositeDataVisitor* vtkCompositeDataSet::NewVisitor ( ) [pure virtual]

Return a new visitor. Sub-classes should overload this method to return the appropriate visitor.
Implemented in vtkHierarchicalBoxDataSet, and vtkMultiBlockDataSet.

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

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

virtual void vtkCompositeDataSet::Initialize ( ) [virtual]

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

void vtkCompositeDataSet::SetUpdateExtent ( int piece,

int numPieces,

int ghostLevel

)

For streaming. User/next filter specifies which piece the want updated. The source of this data has to return exactly this piece.

void vtkCompositeDataSet::SetUpdateExtent ( int piece,

int numPieces

) [inline]

For streaming. User/next filter specifies which piece the want updated. The source of this data has to return exactly this piece.
Reimplemented from vtkDataObject.
Definition at line 71 of file vtkCompositeDataSet.h.
References vtkDataObject::SetUpdateExtent().

void vtkCompositeDataSet::GetUpdateExtent ( int & piece,

int & numPieces,

int & ghostLevel

)

For streaming. User/next filter specifies which piece the want updated. The source of this data has to return exactly this piece.

virtual int* vtkCompositeDataSet::GetUpdateExtent ( ) [virtual]

We need this here to avoid hiding superclass method
Reimplemented from vtkDataObject.

virtual void vtkCompositeDataSet::GetUpdateExtent ( int & x0,

int & x1,

int & y0,

int & y1,

int & z0,

int & z1

) [virtual]

We need this here to avoid hiding superclass method
Reimplemented from vtkDataObject.

virtual void vtkCompositeDataSet::GetUpdateExtent ( int extent[6] ) [virtual]

We need this here to avoid hiding superclass method
Reimplemented from vtkDataObject.

void vtkCompositeDataSet::SetUpdateExtent ( int x1,

int x2,

int y1,

int y2,

int z1,

int z2

) [inline, virtual]

Call superclass method to avoid hiding Since this data type does not use 3D extents, this set method is useless but necessary since vtkDataSetToDataSetFilter does not know what type of data it is working on.
Reimplemented from vtkDataObject.
Definition at line 89 of file vtkCompositeDataSet.h.

void vtkCompositeDataSet::SetUpdateExtent ( int ext[6] ) [inline, virtual]

Call superclass method to avoid hiding Since this data type does not use 3D extents, this set method is useless but necessary since vtkDataSetToDataSetFilter does not know what type of data it is working on.
Reimplemented from vtkDataObject.
Definition at line 91 of file vtkCompositeDataSet.h.

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

dox/Filtering/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 vtkCompositeDataVisitor *	NewVisitor ()=0
virtual int	GetDataObjectType ()
virtual void	Initialize ()

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int piece, int numPieces)
void	GetUpdateExtent (int &piece, int &numPieces, int &ghostLevel)

virtual int *	GetUpdateExtent ()
virtual void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
virtual void	GetUpdateExtent (int extent[6])

void	SetUpdateExtent (int x1, int x2, int y1, int y2, int z1, int z2)
void	SetUpdateExtent (int ext[6])
Static Public Member Functions
int	IsTypeOf (const char *type)
vtkCompositeDataSet *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkCompositeDataSet ()
	~vtkCompositeDataSet ()