Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

vtkHierarchicalDataSet Class Reference

#include <vtkHierarchicalDataSet.h>

Inheritance diagram for vtkHierarchicalDataSet:

Inheritance graph
[legend]
Collaboration diagram for vtkHierarchicalDataSet:

Collaboration graph
[legend]
List of all members.

Detailed Description

abstract superclass for hierarchical datasets

vtkHierarchicalDataSet is a vtkCompositeDataSet that stores a hierarchy 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.

Examples:
vtkHierarchicalDataSet (Examples)

Definition at line 40 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 vtkCompositeDataIteratorNewIterator ()
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)
void SetDataSet (unsigned int level, unsigned int id, vtkDataObject *dataSet)
virtual void AddDataSet (vtkInformation *index, vtkDataObject *dobj)
vtkDataObjectGetDataSet (unsigned int level, unsigned int id)
void SetHierarchicalDataInformation (vtkHierarchicalDataInformation *info)
virtual vtkIdType GetNumberOfPoints ()
virtual vtkDataObjectGetDataSet (vtkInformation *index)
virtual void ShallowCopy (vtkDataObject *src)
virtual void DeepCopy (vtkDataObject *src)
virtual vtkHierarchicalDataInformationGetHierarchicalDataInformation ()

Static Public Member Functions

static vtkHierarchicalDataSetNew ()
static int IsTypeOf (const char *type)
static vtkHierarchicalDataSetSafeDownCast (vtkObject *o)
static vtkInformationIntegerKeyLEVEL ()
static vtkHierarchicalDataSetGetData (vtkInformation *info)
static vtkHierarchicalDataSetGetData (vtkInformationVector *v, int i=0)

Protected Member Functions

 vtkHierarchicalDataSet ()
 ~vtkHierarchicalDataSet ()
void InitializeDataSets ()
virtual vtkHDSNodeNewNode ()

Protected Attributes

vtkHierarchicalDataSetInternalInternal
vtkHierarchicalDataInformationHierarchicalDataInformation

Friends

class vtkHierarchicalDataIterator


Member Typedef Documentation

typedef vtkCompositeDataSet vtkHierarchicalDataSet::Superclass
 

Reimplemented from vtkCompositeDataSet.

Reimplemented in vtkHierarchicalBoxDataSet.

Definition at line 45 of file vtkHierarchicalDataSet.h.


Constructor & Destructor Documentation

vtkHierarchicalDataSet::vtkHierarchicalDataSet  )  [protected]
 

vtkHierarchicalDataSet::~vtkHierarchicalDataSet  )  [protected]
 


Member Function Documentation

static vtkHierarchicalDataSet* vtkHierarchicalDataSet::New  )  [static]
 

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkDataObject.

Reimplemented in vtkHierarchicalBoxDataSet.

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

Reimplemented from vtkCompositeDataSet.

Reimplemented in vtkHierarchicalBoxDataSet.

static 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.

static 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 54 of file vtkHierarchicalDataSet.h.

References VTK_HIERARCHICAL_DATA_SET.

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.

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.

Reimplemented in vtkHierarchicalBoxDataSet.

virtual void vtkHierarchicalDataSet::AddDataSet vtkInformation index,
vtkDataObject dobj
[virtual]
 

Uses keys LEVEL() and INDEX() to call SetDataSet(LEVEL, INDEX, dobj)

Implements vtkCompositeDataSet.

vtkDataObject* vtkHierarchicalDataSet::GetDataSet unsigned int  level,
unsigned int  id
 

Get a dataset give a level and an id.

Reimplemented in vtkHierarchicalBoxDataSet.

virtual vtkDataObject* vtkHierarchicalDataSet::GetDataSet vtkInformation index  )  [virtual]
 

Uses keys LEVEL() and INDEX() to call GetDataSet(LEVEL, INDEX)

Implements vtkCompositeDataSet.

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]
 

Uses keys LEVEL() and INDEX() to call GetDataSet(LEVEL, INDEX)

Reimplemented from vtkDataObject.

Reimplemented in vtkHierarchicalBoxDataSet.

virtual vtkHierarchicalDataInformation* vtkHierarchicalDataSet::GetHierarchicalDataInformation  )  [virtual]
 

Returns the data structure containing information about the datasets.

void vtkHierarchicalDataSet::SetHierarchicalDataInformation vtkHierarchicalDataInformation info  ) 
 

Set the information about the datasets.

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

static vtkInformationIntegerKey* vtkHierarchicalDataSet::LEVEL  )  [static]
 

static vtkHierarchicalDataSet* vtkHierarchicalDataSet::GetData vtkInformation info  )  [static]
 

Retrieve an instance of this class from an information object.

Reimplemented from vtkCompositeDataSet.

static vtkHierarchicalDataSet* vtkHierarchicalDataSet::GetData vtkInformationVector v,
int  i = 0
[static]
 

Reimplemented from vtkCompositeDataSet.

void vtkHierarchicalDataSet::InitializeDataSets  )  [protected]
 

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


Friends And Related Function Documentation

friend class vtkHierarchicalDataIterator [friend]
 

Definition at line 112 of file vtkHierarchicalDataSet.h.


Member Data Documentation

vtkHierarchicalDataSetInternal* vtkHierarchicalDataSet::Internal [protected]
 

Definition at line 129 of file vtkHierarchicalDataSet.h.

vtkHierarchicalDataInformation* vtkHierarchicalDataSet::HierarchicalDataInformation [protected]
 

Definition at line 135 of file vtkHierarchicalDataSet.h.


The documentation for this class was generated from the following file:
Generated on Mon Jan 21 23:47:30 2008 for VTK by  doxygen 1.4.3-20050530