vtkMultiBlockDataSet Class Reference

#include <vtkMultiBlockDataSet.h>

Inheritance diagram for vtkMultiBlockDataSet:

Inheritance graph
[legend]
Collaboration diagram for vtkMultiBlockDataSet:

Collaboration graph
[legend]

List of all members.


Detailed Description

Composite dataset that organizes datasets into blocks.

vtkMultiBlockDataSet is a vtkCompositeDataSet that stores a hierarchy of datasets. The dataset collection consists of multiple blocks. Each block can itself be a vtkMultiBlockDataSet, thus providing for a full tree structure. Sub-blocks are usually used to distribute blocks across processors. For example, a 1 block dataset can be distributed as following:

 proc 0:
 Block 0:
   * ds 0
   * (null)

 proc 1:
 Block 0:
   * (null)
   * ds 1
 

Tests:
vtkMultiBlockDataSet (Tests)

Definition at line 46 of file vtkMultiBlockDataSet.h.


Public Types

typedef vtkCompositeDataSet Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual int GetDataObjectType ()
void SetNumberOfBlocks (unsigned int numBlocks)
unsigned int GetNumberOfBlocks ()
vtkDataObjectGetBlock (unsigned int blockno)
void SetBlock (unsigned int blockno, vtkDataObject *block)
void RemoveBlock (unsigned int blockno)
int HasMetaData (unsigned int blockno)
vtkInformationGetMetaData (unsigned int blockno)
virtual vtkInformationGetMetaData (vtkCompositeDataIterator *iter)
virtual int HasMetaData (vtkCompositeDataIterator *iter)

Static Public Member Functions

static vtkMultiBlockDataSetNew ()
static int IsTypeOf (const char *type)
static vtkMultiBlockDataSetSafeDownCast (vtkObject *o)
static vtkMultiBlockDataSetGetData (vtkInformation *info)
static vtkMultiBlockDataSetGetData (vtkInformationVector *v, int i=0)

Protected Member Functions

 vtkMultiBlockDataSet ()
 ~vtkMultiBlockDataSet ()

Member Typedef Documentation

Reimplemented from vtkCompositeDataSet.

Definition at line 50 of file vtkMultiBlockDataSet.h.


Constructor & Destructor Documentation

vtkMultiBlockDataSet::vtkMultiBlockDataSet (  )  [protected]

vtkMultiBlockDataSet::~vtkMultiBlockDataSet (  )  [protected]


Member Function Documentation

static vtkMultiBlockDataSet* vtkMultiBlockDataSet::New (  )  [static]

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

Reimplemented from vtkDataObject.

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

Reimplemented from vtkCompositeDataSet.

static int vtkMultiBlockDataSet::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 vtkCompositeDataSet.

virtual int vtkMultiBlockDataSet::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 vtkCompositeDataSet.

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

Reimplemented from vtkCompositeDataSet.

void vtkMultiBlockDataSet::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.

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

Return class name of data type (see vtkType.h for definitions).

Reimplemented from vtkCompositeDataSet.

Definition at line 54 of file vtkMultiBlockDataSet.h.

void vtkMultiBlockDataSet::SetNumberOfBlocks ( unsigned int  numBlocks  ) 

Set the number of blocks. This will cause allocation if the new number of blocks is greater than the current size. All new blocks are initialized to null.

unsigned int vtkMultiBlockDataSet::GetNumberOfBlocks (  ) 

Returns the number of blocks.

vtkDataObject* vtkMultiBlockDataSet::GetBlock ( unsigned int  blockno  ) 

Returns the block at the given index. It is recommended that one uses the iterators to iterate over composite datasets rather than using this API.

void vtkMultiBlockDataSet::SetBlock ( unsigned int  blockno,
vtkDataObject block 
)

Sets the data object as the given block. The total number of blocks will be resized to fit the requested block no.

void vtkMultiBlockDataSet::RemoveBlock ( unsigned int  blockno  ) 

Remove the given block from the dataset.

int vtkMultiBlockDataSet::HasMetaData ( unsigned int  blockno  )  [inline]

Returns true if meta-data is available for a given block.

Definition at line 78 of file vtkMultiBlockDataSet.h.

vtkInformation* vtkMultiBlockDataSet::GetMetaData ( unsigned int  blockno  )  [inline]

Returns the meta-data for the block. If none is already present, a new vtkInformation object will be allocated. Use HasMetaData to avoid allocating vtkInformation objects.

Definition at line 86 of file vtkMultiBlockDataSet.h.

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

Retrieve an instance of this class from an information object.

Reimplemented from vtkCompositeDataSet.

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

Retrieve an instance of this class from an information object.

Reimplemented from vtkCompositeDataSet.

virtual vtkInformation* vtkMultiBlockDataSet::GetMetaData ( vtkCompositeDataIterator iter  )  [inline, virtual]

Unhiding superclass method.

Reimplemented from vtkCompositeDataSet.

Definition at line 100 of file vtkMultiBlockDataSet.h.

virtual int vtkMultiBlockDataSet::HasMetaData ( vtkCompositeDataIterator iter  )  [inline, virtual]

Unhiding superclass method.

Reimplemented from vtkCompositeDataSet.

Definition at line 106 of file vtkMultiBlockDataSet.h.


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

Generated on Wed Jun 3 19:18:48 2009 for VTK by  doxygen 1.5.6