vtkMultiBlockDataSet Class Reference

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

#include <vtkMultiBlockDataSet.h>

Inherits vtkCompositeDataSet.

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 ()
vtkDataObject *	GetBlock (unsigned int blockno)
void	SetBlock (unsigned int blockno, vtkDataObject *block)
void	RemoveBlock (unsigned int blockno)
int	HasMetaData (unsigned int blockno)
vtkInformation *	GetMetaData (unsigned int blockno)
virtual vtkInformation *	GetMetaData (vtkCompositeDataIterator *iter)
virtual int	HasMetaData (vtkCompositeDataIterator *iter)

Static Public Member Functions
static vtkMultiBlockDataSet *	New ()
static int	IsTypeOf (const char *type)
static vtkMultiBlockDataSet *	SafeDownCast (vtkObject *o)
static vtkMultiBlockDataSet *	GetData (vtkInformation *info)
static vtkMultiBlockDataSet *	GetData (vtkInformationVector *v, int i=0)

Protected Member Functions
	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 49 of file vtkMultiBlockDataSet.h.

Member Typedef Documentation

typedef vtkCompositeDataSet vtkMultiBlockDataSet::Superclass

Definition at line 53 of file vtkMultiBlockDataSet.h.

Constructor & Destructor Documentation

vtkMultiBlockDataSet::vtkMultiBlockDataSet ( )

protected

vtkMultiBlockDataSet::~vtkMultiBlockDataSet ( )

protected

Member Function Documentation

static vtkMultiBlockDataSet* vtkMultiBlockDataSet::New ( )

static

virtual const char* vtkMultiBlockDataSet::GetClassName ( )

virtual

static int vtkMultiBlockDataSet::IsTypeOf ( const char *  type )

static

virtual int vtkMultiBlockDataSet::IsA ( const char *  type )

virtual

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

static

void vtkMultiBlockDataSet::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual int vtkMultiBlockDataSet::GetDataObjectType ( )

inlinevirtual

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

Definition at line 57 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 81 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 89 of file vtkMultiBlockDataSet.h.

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

static

Retrieve an instance of this class from an information object.

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

static

Retrieve an instance of this class from an information object.

virtual vtkInformation* vtkMultiBlockDataSet::GetMetaData ( vtkCompositeDataIterator *  iter )

inlinevirtual

Unhiding superclass method.

Definition at line 103 of file vtkMultiBlockDataSet.h.

virtual int vtkMultiBlockDataSet::HasMetaData ( vtkCompositeDataIterator *  iter )

inlinevirtual

Unhiding superclass method.

Definition at line 109 of file vtkMultiBlockDataSet.h.

---

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

• dox/Filtering/vtkMultiBlockDataSet.h