Permalink
Find file
Fetching contributors…
Cannot retrieve contributors at this time
120 lines (96 sloc) 3.8 KB
/*=========================================================================
Program: Visualization Toolkit
Module: vtkMultiBlockDataSet.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkMultiBlockDataSet - Composite dataset that organizes datasets into
// blocks.
// .SECTION Description
// 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:
// @verbatim
// proc 0:
// Block 0:
// * ds 0
// * (null)
//
// proc 1:
// Block 0:
// * (null)
// * ds 1
// @endverbatim
#ifndef __vtkMultiBlockDataSet_h
#define __vtkMultiBlockDataSet_h
#include "vtkCompositeDataSet.h"
class VTK_FILTERING_EXPORT vtkMultiBlockDataSet : public vtkCompositeDataSet
{
public:
static vtkMultiBlockDataSet* New();
vtkTypeMacro(vtkMultiBlockDataSet, vtkCompositeDataSet);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Return class name of data type (see vtkType.h for
// definitions).
virtual int GetDataObjectType() {return VTK_MULTIBLOCK_DATA_SET;}
// Description:
// 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.
void SetNumberOfBlocks(unsigned int numBlocks);
// Description:
// Returns the number of blocks.
unsigned int GetNumberOfBlocks();
// Description:
// 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.
vtkDataObject* GetBlock(unsigned int blockno);
// Description:
// Sets the data object as the given block. The total number of blocks will
// be resized to fit the requested block no.
void SetBlock(unsigned int blockno, vtkDataObject* block);
// Description:
// Remove the given block from the dataset.
void RemoveBlock(unsigned int blockno);
// Description:
// Returns true if meta-data is available for a given block.
int HasMetaData(unsigned int blockno)
{ return this->Superclass::HasChildMetaData(blockno); }
// Description:
// 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.
vtkInformation* GetMetaData(unsigned int blockno)
{ return this->Superclass::GetChildMetaData(blockno); }
//BTX
// Description:
// Retrieve an instance of this class from an information object.
static vtkMultiBlockDataSet* GetData(vtkInformation* info);
static vtkMultiBlockDataSet* GetData(vtkInformationVector* v, int i=0);
//ETX
// Description:
// Unhiding superclass method.
virtual vtkInformation* GetMetaData(vtkCompositeDataIterator* iter)
{ return this->Superclass::GetMetaData(iter); }
// Description:
// Unhiding superclass method.
virtual int HasMetaData(vtkCompositeDataIterator* iter)
{ return this->Superclass::HasMetaData(iter); }
//BTX
protected:
vtkMultiBlockDataSet();
~vtkMultiBlockDataSet();
private:
vtkMultiBlockDataSet(const vtkMultiBlockDataSet&); // Not implemented.
void operator=(const vtkMultiBlockDataSet&); // Not implemented.
//ETX
};
#endif