vtkHierarchicalDataSet Class Reference

#include <vtkHierarchicalDataSet.h>

Inheritance diagram for vtkHierarchicalDataSet:

[legend]Collaboration diagram for vtkHierarchicalDataSet:

[legend]List of all members.

Detailed Description

abstact superclass for hierarchical datasets

vtkHierarchicalDataSet is a vtkCompositeDataSet that stores a hieararchy of datasets. The dataset collection consists of multiple levels. Each dataset can have an arbitrary number of parents and children at levels above and below. Currently, the interface for connecting parents-children is incomplete.

Created by:

Bertel, Francois

CVS contributions (if > 5%):

Bertel, Francois (100%)

CVS logs (CVSweb):

.h (/Filtering/vtkHierarchicalDataSet.h)
.cxx (/Filtering/vtkHierarchicalDataSet.cxx)

Definition at line 46 of file vtkHierarchicalDataSet.h.

Public Types

typedef vtkCompositeDataSet Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

virtual void PrintSelf (ostream &os, vtkIndent indent)

virtual vtkCompositeDataIterator * NewIterator ()

virtual int GetDataObjectType ()

virtual void Initialize ()

void SetNumberOfLevels (unsigned int numLevels)

unsigned int GetNumberOfLevels ()

void SetNumberOfDataSets (unsigned int level, unsigned int numDataSets)

unsigned int GetNumberOfDataSets (unsigned int level)

void InitializeNode (unsigned int level, unsigned int id)

int IsNodePresent (unsigned int level, unsigned int id)

void SetDataSet (unsigned int level, unsigned int id, vtkDataObject *dataSet)

vtkDataObject * GetDataSet (unsigned int level, unsigned int id)

virtual void ShallowCopy (vtkDataObject *src)

virtual void DeepCopy (vtkDataObject *src)

Static Public Member Functions

int IsTypeOf (const char *type)

vtkHierarchicalDataSet * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkHierarchicalDataSet ()

~vtkHierarchicalDataSet ()

void InitializeDataSets ()

virtual vtkHDSNode * NewNode ()

Protected Attributes

vtkHierarchicalDataSetInternal * Internal

Member Typedef Documentation

typedef vtkCompositeDataSet vtkHierarchicalDataSet::Superclass

Reimplemented from vtkCompositeDataSet.
Reimplemented in vtkHierarchicalBoxDataSet.
Definition at line 49 of file vtkHierarchicalDataSet.h.

Constructor & Destructor Documentation

vtkHierarchicalDataSet::vtkHierarchicalDataSet ( ) [protected]

vtkHierarchicalDataSet::~vtkHierarchicalDataSet ( ) [protected]

Member Function Documentation

virtual const char* vtkHierarchicalDataSet::GetClassName ( ) [virtual]

Reimplemented from vtkCompositeDataSet.
Reimplemented in vtkHierarchicalBoxDataSet.

int vtkHierarchicalDataSet::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 vtkCompositeDataSet.
Reimplemented in vtkHierarchicalBoxDataSet.

virtual int vtkHierarchicalDataSet::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 vtkCompositeDataSet.
Reimplemented in vtkHierarchicalBoxDataSet.

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

Reimplemented from vtkCompositeDataSet.
Reimplemented in vtkHierarchicalBoxDataSet.

virtual void vtkHierarchicalDataSet::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 vtkHierarchicalBoxDataSet.

virtual vtkCompositeDataIterator* vtkHierarchicalDataSet::NewIterator ( ) [virtual]

Return a new (forward) iterator (the iterator has to be deleted by user)
Implements vtkCompositeDataSet.

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

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

virtual void vtkHierarchicalDataSet::Initialize ( ) [virtual]

Restore data object to initial state,
Reimplemented from vtkCompositeDataSet.

void vtkHierarchicalDataSet::SetNumberOfLevels ( unsigned int numLevels )

Set the number of refinement levels. This call might cause allocation if the new number of levels is larger than the current one.

unsigned int vtkHierarchicalDataSet::GetNumberOfLevels ( )

Returns the number of levels.

void vtkHierarchicalDataSet::SetNumberOfDataSets ( unsigned int level,

unsigned int numDataSets

)

Set the number of datasets in a given level. This call might cause allocation if the new number of datasets is larger than the current one.

unsigned int vtkHierarchicalDataSet::GetNumberOfDataSets ( unsigned int level )

Returns the number of datasets in a given level.

void vtkHierarchicalDataSet::InitializeNode ( unsigned int level,

unsigned int id

)

Initialize the entry for a dataset node. This removes all parent/child links between the given node and others.

int vtkHierarchicalDataSet::IsNodePresent ( unsigned int level,

unsigned int id

)

Returns 1 if the node [level, id] is initialized. Since GetDataSet() returns NULL when either an existing node has NULL dataset pointer or the node does not exit, this is the only way to check if a node really exists.

void vtkHierarchicalDataSet::SetDataSet ( unsigned int level,

unsigned int id,

vtkDataObject * dataSet

)

Set the dataset pointer for a given node. This method does not remove the existing parent/child links. It only replaces the dataset pointer.

vtkDataObject* vtkHierarchicalDataSet::GetDataSet ( unsigned int level,

unsigned int id

)

Get a dataset give a level and an id.
Reimplemented in vtkHierarchicalBoxDataSet.

virtual void vtkHierarchicalDataSet::ShallowCopy ( vtkDataObject * src ) [virtual]

Shallow and Deep copy.
Reimplemented from vtkDataObject.
Reimplemented in vtkHierarchicalBoxDataSet.

virtual void vtkHierarchicalDataSet::DeepCopy ( vtkDataObject * src ) [virtual]

Shallow and Deep copy.
Reimplemented from vtkDataObject.
Reimplemented in vtkHierarchicalBoxDataSet.

void vtkHierarchicalDataSet::InitializeDataSets ( ) [protected]

virtual vtkHDSNode* vtkHierarchicalDataSet::NewNode ( ) [protected, virtual]

Reimplemented in vtkHierarchicalBoxDataSet.

Member Data Documentation

vtkHierarchicalDataSetInternal* vtkHierarchicalDataSet::Internal [protected]

Definition at line 110 of file vtkHierarchicalDataSet.h.

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

dox/Filtering/vtkHierarchicalDataSet.h


Public Types
typedef vtkCompositeDataSet	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkCompositeDataIterator *	NewIterator ()
virtual int	GetDataObjectType ()
virtual void	Initialize ()
void	SetNumberOfLevels (unsigned int numLevels)
unsigned int	GetNumberOfLevels ()
void	SetNumberOfDataSets (unsigned int level, unsigned int numDataSets)
unsigned int	GetNumberOfDataSets (unsigned int level)
void	InitializeNode (unsigned int level, unsigned int id)
int	IsNodePresent (unsigned int level, unsigned int id)
void	SetDataSet (unsigned int level, unsigned int id, vtkDataObject *dataSet)
vtkDataObject *	GetDataSet (unsigned int level, unsigned int id)

virtual void	ShallowCopy (vtkDataObject *src)
virtual void	DeepCopy (vtkDataObject *src)
Static Public Member Functions
int	IsTypeOf (const char *type)
vtkHierarchicalDataSet *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkHierarchicalDataSet ()
	~vtkHierarchicalDataSet ()
void	InitializeDataSets ()
virtual vtkHDSNode *	NewNode ()
Protected Attributes
vtkHierarchicalDataSetInternal *	Internal