VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkMultiBlockDataSet Class Reference

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

#include <vtkMultiBlockDataSet.h>

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

Public Types

typedef vtkCompositeDataSet Superclass
- Public Types inherited from vtkCompositeDataSet
typedef vtkDataObject Superclass
- Public Types inherited from vtkDataObject
typedef vtkObject Superclass
enum  FieldAssociations {
  FIELD_ASSOCIATION_POINTS, FIELD_ASSOCIATION_CELLS, FIELD_ASSOCIATION_NONE, FIELD_ASSOCIATION_POINTS_THEN_CELLS,
  FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, FIELD_ASSOCIATION_ROWS, NUMBER_OF_ASSOCIATIONS
}
enum  AttributeTypes {
  POINT, CELL, FIELD, POINT_THEN_CELL,
  VERTEX, EDGE, ROW, NUMBER_OF_ATTRIBUTE_TYPES
}
enum  FieldOperations { FIELD_OPERATION_PRESERVED, FIELD_OPERATION_REINTERPOLATED, FIELD_OPERATION_MODIFIED, FIELD_OPERATION_REMOVED }
- Public Types inherited from vtkObject
typedef vtkObjectBase 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)
- Public Member Functions inherited from vtkCompositeDataSet
virtual vtkCompositeDataIteratorNewIterator ()
virtual vtkAlgorithmOutputGetProducerPort ()
virtual void CopyStructure (vtkCompositeDataSet *input)
virtual void SetDataSet (vtkCompositeDataIterator *iter, vtkDataObject *dataObj)
virtual vtkDataObjectGetDataSet (vtkCompositeDataIterator *iter)
virtual unsigned long GetActualMemorySize ()
virtual void Initialize ()
virtual vtkIdType GetNumberOfPoints ()
virtual void ShallowCopy (vtkDataObject *src)
virtual void DeepCopy (vtkDataObject *src)
- Public Member Functions inherited from vtkDataObject
unsigned long int GetMTime ()
void ReleaseData ()
int ShouldIReleaseData ()
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void Update ()
virtual void UpdateInformation ()
virtual void PropagateUpdateExtent ()
virtual void TriggerAsynchronousUpdate ()
virtual void UpdateData ()
virtual unsigned long GetEstimatedMemorySize ()
unsigned long GetUpdateTime ()
void SetUpdateExtentToWholeExtent ()
unsigned long GetPipelineMTime ()
void CopyInformation (vtkDataObject *data)
virtual void CopyInformationFromPipeline (vtkInformation *request)
void DataHasBeenGenerated ()
virtual void PrepareForNewData ()
virtual int GetExtentType ()
virtual void Crop ()
virtual vtkDataSetAttributesGetAttributes (int type)
virtual vtkFieldDataGetAttributesAsFieldData (int type)
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
virtual vtkIdType GetNumberOfElements (int type)
virtual vtkSourceGetSource ()
void SetSource (vtkSource *s)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual vtkInformationGetPipelineInformation ()
virtual void SetPipelineInformation (vtkInformation *)
virtual int GetDataReleased ()
void SetReleaseDataFlag (int)
int GetReleaseDataFlag ()
virtual void ReleaseDataFlagOn ()
virtual void ReleaseDataFlagOff ()
virtual void SetFieldData (vtkFieldData *)
virtual vtkFieldDataGetFieldData ()
virtual void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
void SetUpdateExtent (int piece, int numPieces)
virtual void SetUpdateExtent (int x0, int x1, int y0, int y1, int z0, int z1)
virtual void SetUpdateExtent (int extent[6])
virtual int * GetUpdateExtent ()
virtual void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
virtual void GetUpdateExtent (int extent[6])
virtual void CopyTypeSpecificInformation (vtkDataObject *data)
void SetUpdatePiece (int piece)
void SetUpdateNumberOfPieces (int num)
virtual int GetUpdatePiece ()
virtual int GetUpdateNumberOfPieces ()
void SetUpdateGhostLevel (int level)
virtual int GetUpdateGhostLevel ()
virtual void SetRequestExactExtent (int flag)
virtual int GetRequestExactExtent ()
virtual void RequestExactExtentOn ()
virtual void RequestExactExtentOff ()
virtual void SetWholeExtent (int x0, int x1, int y0, int y1, int z0, int z1)
virtual void SetWholeExtent (int extent[6])
virtual int * GetWholeExtent ()
virtual void GetWholeExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
virtual void GetWholeExtent (int extent[6])
virtual void SetWholeBoundingBox (double x0, double x1, double y0, double y1, double z0, double z1)
virtual void SetWholeBoundingBox (double bb[6])
virtual double * GetWholeBoundingBox ()
virtual void GetWholeBoundingBox (double &x0, double &x1, double &y0, double &y1, double &z0, double &z1)
virtual void GetWholeBoundingBox (double extent[6])
virtual void SetMaximumNumberOfPieces (int)
virtual int GetMaximumNumberOfPieces ()
virtual void CopyInformationToPipeline (vtkInformation *request, vtkInformation *input, vtkInformation *output, int forceCopy)
void CopyInformationToPipeline (vtkInformation *request, vtkInformation *input)
void SetExtentTranslator (vtkExtentTranslator *translator)
vtkExtentTranslatorGetExtentTranslator ()
void GlobalReleaseDataFlagOn ()
void GlobalReleaseDataFlagOff ()
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

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)
- Static Public Member Functions inherited from vtkCompositeDataSet
static vtkInformationStringKeyNAME ()
- Static Public Member Functions inherited from vtkDataObject
static const char * GetAssociationTypeAsString (int associationType)
static vtkInformationStringKeyDATA_TYPE_NAME ()
static
vtkInformationDataObjectKey
DATA_OBJECT ()
static vtkInformationIntegerKeyDATA_EXTENT_TYPE ()
static
vtkInformationIntegerPointerKey
DATA_EXTENT ()
static vtkInformationIntegerKeyDATA_PIECE_NUMBER ()
static vtkInformationIntegerKeyDATA_NUMBER_OF_PIECES ()
static vtkInformationIntegerKeyDATA_NUMBER_OF_GHOST_LEVELS ()
static vtkInformationDoubleKeyDATA_RESOLUTION ()
static
vtkInformationDoubleVectorKey
DATA_TIME_STEPS ()
static
vtkInformationInformationVectorKey
POINT_DATA_VECTOR ()
static
vtkInformationInformationVectorKey
CELL_DATA_VECTOR ()
static
vtkInformationInformationVectorKey
VERTEX_DATA_VECTOR ()
static
vtkInformationInformationVectorKey
EDGE_DATA_VECTOR ()
static vtkInformationIntegerKeyFIELD_ARRAY_TYPE ()
static vtkInformationIntegerKeyFIELD_ASSOCIATION ()
static vtkInformationIntegerKeyFIELD_ATTRIBUTE_TYPE ()
static vtkInformationIntegerKeyFIELD_ACTIVE_ATTRIBUTE ()
static vtkInformationIntegerKeyFIELD_NUMBER_OF_COMPONENTS ()
static vtkInformationIntegerKeyFIELD_NUMBER_OF_TUPLES ()
static vtkInformationIntegerKeyFIELD_OPERATION ()
static
vtkInformationDoubleVectorKey
FIELD_RANGE ()
static
vtkInformationDoubleVectorKey
PIECE_FIELD_RANGE ()
static vtkInformationStringKeyFIELD_ARRAY_NAME ()
static
vtkInformationIntegerVectorKey
PIECE_EXTENT ()
static vtkInformationStringKeyFIELD_NAME ()
static
vtkInformationDoubleVectorKey
ORIGIN ()
static
vtkInformationDoubleVectorKey
SPACING ()
static vtkInformationIntegerKeyDATA_GEOMETRY_UNMODIFIED ()
static
vtkInformationDataObjectKey
SIL ()
static vtkInformationGetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
static vtkInformationGetNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
static vtkInformationSetActiveAttribute (vtkInformation *info, int fieldAssociation, const char *attributeName, int attributeType)
static void SetActiveAttributeInfo (vtkInformation *info, int fieldAssociation, int attributeType, const char *name, int arrayType, int numComponents, int numTuples)
static void SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
static void SetGlobalReleaseDataFlag (int val)
static int GetGlobalReleaseDataFlag ()
- Static Public Member Functions inherited from vtkObject
static void BreakOnError ()
static void SetGlobalWarningDisplay (int val)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static int GetGlobalWarningDisplay ()

Protected Member Functions

 vtkMultiBlockDataSet ()
 ~vtkMultiBlockDataSet ()
- Protected Member Functions inherited from vtkCompositeDataSet
 vtkCompositeDataSet ()
 ~vtkCompositeDataSet ()
void SetNumberOfChildren (unsigned int num)
unsigned int GetNumberOfChildren ()
void SetChild (unsigned int index, vtkDataObject *)
void RemoveChild (unsigned int index)
vtkDataObjectGetChild (unsigned int num)
vtkInformationGetChildMetaData (unsigned int index)
void SetChildMetaData (unsigned int index, vtkInformation *info)
int HasChildMetaData (unsigned int index)
- Protected Member Functions inherited from vtkDataObject
 vtkDataObject ()
 ~vtkDataObject ()
vtkExecutiveGetExecutive ()
int GetPortNumber ()
virtual void ReportReferences (vtkGarbageCollector *)
vtkStreamingDemandDrivenPipelineTrySDDP (const char *method)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Additional Inherited Members

- Protected Types inherited from vtkDataObject
typedef
vtkStreamingDemandDrivenPipeline 
SDDP
- Protected Attributes inherited from vtkCompositeDataSet
vtkCompositeDataSetInternalsInternals
- Static Protected Attributes inherited from vtkDataObject
static const char AssociationNames [NUMBER_OF_ASSOCIATIONS][55]
- Friends inherited from vtkObject

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

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

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 vtkTypeMacro 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 vtkTypeMacro 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 ( )
inlinevirtual

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

Reimplemented from vtkCompositeDataSet.

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.

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)
inlinevirtual

Unhiding superclass method.

Reimplemented from vtkCompositeDataSet.

Definition at line 103 of file vtkMultiBlockDataSet.h.

virtual int vtkMultiBlockDataSet::HasMetaData ( vtkCompositeDataIterator iter)
inlinevirtual

Unhiding superclass method.

Reimplemented from vtkCompositeDataSet.

Definition at line 109 of file vtkMultiBlockDataSet.h.


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