VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkMultiBlockDataSet Class Reference

Composite dataset that organizes datasets into blocks. More...

#include <vtkMultiBlockDataSet.h>

Inheritance diagram for vtkMultiBlockDataSet:
Inheritance graph
[legend]
Collaboration diagram for vtkMultiBlockDataSet:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkDataObjectTree Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkMultiBlockDataSetNewInstance () const
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 (vtkObjectBase *o)
static vtkMultiBlockDataSetGetData (vtkInformation *info)
static vtkMultiBlockDataSetGetData (vtkInformationVector *v, int i=0)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkMultiBlockDataSet ()
 ~vtkMultiBlockDataSet ()

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
Examples:
vtkMultiBlockDataSet (Examples)
Tests:
vtkMultiBlockDataSet (Tests)

Definition at line 50 of file vtkMultiBlockDataSet.h.


Member Typedef Documentation

Reimplemented from vtkDataObjectTree.

Definition at line 54 of file vtkMultiBlockDataSet.h.


Constructor & Destructor Documentation


Member Function Documentation

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

Reimplemented from vtkDataObject.

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataObjectTree.

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataObjectTree.

Reimplemented from vtkDataObjectTree.

virtual vtkObjectBase* vtkMultiBlockDataSet::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkDataObjectTree.

Reimplemented from vtkDataObjectTree.

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

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

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

Reimplemented from vtkCompositeDataSet.

Definition at line 58 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.

Returns the number of blocks.

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 82 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 90 of file vtkMultiBlockDataSet.h.

Retrieve an instance of this class from an information object.

Reimplemented from vtkDataObjectTree.

Retrieve an instance of this class from an information object.

Reimplemented from vtkDataObjectTree.

Unhiding superclass method.

Reimplemented from vtkDataObjectTree.

Definition at line 104 of file vtkMultiBlockDataSet.h.

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

Unhiding superclass method.

Reimplemented from vtkDataObjectTree.

Definition at line 110 of file vtkMultiBlockDataSet.h.


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