VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkMultiPieceDataSet Class Reference

composite dataset to encapsulates pieces of dataset. More...

#include <vtkMultiPieceDataSet.h>

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

Public Types

typedef vtkDataObjectTree Superclass
 
- Public Types inherited from vtkDataObjectTree
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 Member Functions

virtual int IsA (const char *type)
 
vtkMultiPieceDataSetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int GetDataObjectType ()
 
void SetNumberOfPieces (unsigned int numpieces)
 
unsigned int GetNumberOfPieces ()
 
void SetPiece (unsigned int pieceno, vtkDataObject *piece)
 
vtkDataSet * GetPiece (unsigned int pieceno)
 
vtkDataObjectGetPieceAsDataObject (unsigned int pieceno)
 
int HasMetaData (unsigned int piece)
 
vtkInformation * GetMetaData (unsigned int pieceno)
 
virtual vtkInformation * GetMetaData (vtkCompositeDataIterator *iter)
 
virtual int HasMetaData (vtkCompositeDataIterator *iter)
 
- Public Member Functions inherited from vtkDataObjectTree
vtkDataObjectTreeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkDataObjectTreeIteratorNewTreeIterator ()
 
virtual vtkCompositeDataIteratorNewIterator ()
 
virtual void CopyStructure (vtkCompositeDataSet *input)
 
virtual void SetDataSet (vtkCompositeDataIterator *iter, vtkDataObject *dataObj)
 
void SetDataSetFrom (vtkDataObjectTreeIterator *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 vtkCompositeDataSet
vtkCompositeDataSetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
- Public Member Functions inherited from vtkDataObject
vtkDataObjectNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
unsigned long int GetMTime ()
 
void ReleaseData ()
 
unsigned long GetUpdateTime ()
 
void DataHasBeenGenerated ()
 
virtual void PrepareForNewData ()
 
virtual int GetExtentType ()
 
virtual void Crop (const int *updateExtent)
 
virtual vtkDataSetAttributes * GetAttributes (int type)
 
virtual vtkFieldData * GetAttributesAsFieldData (int type)
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 
virtual vtkIdType GetNumberOfElements (int type)
 
virtual vtkInformation * GetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual int GetDataReleased ()
 
virtual void SetFieldData (vtkFieldData *)
 
virtual vtkFieldData * GetFieldData ()
 
virtual void CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
 
void GlobalReleaseDataFlagOn ()
 
void GlobalReleaseDataFlagOff ()
 

Static Public Member Functions

static vtkMultiPieceDataSetNew ()
 
static int IsTypeOf (const char *type)
 
static vtkMultiPieceDataSetSafeDownCast (vtkObjectBase *o)
 
static vtkMultiPieceDataSetGetData (vtkInformation *info)
 
static vtkMultiPieceDataSetGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkDataObjectTree
static int IsTypeOf (const char *type)
 
static vtkDataObjectTreeSafeDownCast (vtkObjectBase *o)
 
static vtkDataObjectTreeGetData (vtkInformation *info)
 
static vtkDataObjectTreeGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkCompositeDataSet
static int IsTypeOf (const char *type)
 
static vtkCompositeDataSetSafeDownCast (vtkObjectBase *o)
 
static vtkInformationStringKey * NAME ()
 
static vtkCompositeDataSetGetData (vtkInformation *info)
 
static vtkCompositeDataSetGetData (vtkInformationVector *v, int i=0)
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDataObjectSafeDownCast (vtkObjectBase *o)
 
static const char * GetAssociationTypeAsString (int associationType)
 
static int GetAssociationTypeFromString (const char *associationType)
 
static vtkInformationStringKey * DATA_TYPE_NAME ()
 
static
vtkInformationDataObjectKey * 
DATA_OBJECT ()
 
static vtkInformationIntegerKey * DATA_EXTENT_TYPE ()
 
static
vtkInformationIntegerPointerKey * 
DATA_EXTENT ()
 
static vtkInformationIntegerKey * DATA_PIECE_NUMBER ()
 
static vtkInformationIntegerKey * DATA_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKey * DATA_NUMBER_OF_GHOST_LEVELS ()
 
static vtkInformationDoubleKey * DATA_RESOLUTION ()
 
static vtkInformationDoubleKey * DATA_TIME_STEP ()
 
static
vtkInformationInformationVectorKey * 
POINT_DATA_VECTOR ()
 
static
vtkInformationInformationVectorKey * 
CELL_DATA_VECTOR ()
 
static
vtkInformationInformationVectorKey * 
VERTEX_DATA_VECTOR ()
 
static
vtkInformationInformationVectorKey * 
EDGE_DATA_VECTOR ()
 
static vtkInformationIntegerKey * FIELD_ARRAY_TYPE ()
 
static vtkInformationIntegerKey * FIELD_ASSOCIATION ()
 
static vtkInformationIntegerKey * FIELD_ATTRIBUTE_TYPE ()
 
static vtkInformationIntegerKey * FIELD_ACTIVE_ATTRIBUTE ()
 
static vtkInformationIntegerKey * FIELD_NUMBER_OF_COMPONENTS ()
 
static vtkInformationIntegerKey * FIELD_NUMBER_OF_TUPLES ()
 
static vtkInformationIntegerKey * FIELD_OPERATION ()
 
static
vtkInformationDoubleVectorKey * 
FIELD_RANGE ()
 
static
vtkInformationDoubleVectorKey * 
PIECE_FIELD_RANGE ()
 
static vtkInformationStringKey * FIELD_ARRAY_NAME ()
 
static
vtkInformationIntegerVectorKey * 
PIECE_EXTENT ()
 
static vtkInformationStringKey * FIELD_NAME ()
 
static
vtkInformationDoubleVectorKey * 
ORIGIN ()
 
static
vtkInformationDoubleVectorKey * 
SPACING ()
 
static vtkInformationIntegerKey * DATA_GEOMETRY_UNMODIFIED ()
 
static
vtkInformationDoubleVectorKey * 
BOUNDING_BOX ()
 
static
vtkInformationDataObjectKey * 
SIL ()
 
static vtkInformation * GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
 
static vtkInformation * GetNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
 
static vtkInformation * SetActiveAttribute (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 vtkDataObjectGetData (vtkInformation *info)
 
static vtkDataObjectGetData (vtkInformationVector *v, int i=0)
 
static void SetGlobalReleaseDataFlag (int val)
 
static int GetGlobalReleaseDataFlag ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkMultiPieceDataSet ()
 
 ~vtkMultiPieceDataSet ()
 
- Protected Member Functions inherited from vtkDataObjectTree
 vtkDataObjectTree ()
 
 ~vtkDataObjectTree ()
 
void SetNumberOfChildren (unsigned int num)
 
unsigned int GetNumberOfChildren ()
 
void SetChild (unsigned int index, vtkDataObject *)
 
void RemoveChild (unsigned int index)
 
vtkDataObjectGetChild (unsigned int num)
 
vtkInformation * GetChildMetaData (unsigned int index)
 
void SetChildMetaData (unsigned int index, vtkInformation *info)
 
int HasChildMetaData (unsigned int index)
 
- Protected Member Functions inherited from vtkCompositeDataSet
 vtkCompositeDataSet ()
 
virtual ~vtkCompositeDataSet ()
 
- Protected Member Functions inherited from vtkDataObject
 vtkDataObject ()
 
 ~vtkDataObject ()
 

Additional Inherited Members

- Protected Attributes inherited from vtkDataObjectTree
vtkDataObjectTreeInternalsInternals
 
- Protected Attributes inherited from vtkDataObject
vtkFieldData * FieldData
 
int DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformation * Information
 

Detailed Description

composite dataset to encapsulates pieces of dataset.

A vtkMultiPieceDataSet dataset groups multiple data pieces together. For example, say that a simulation broke a volume into 16 piece so that each piece can be processed with 1 process in parallel. We want to load this volume in a visualization cluster of 4 nodes. Each node will get 4 pieces, not necessarily forming a whole rectangular piece. In this case, it is not possible to append the 4 pieces together into a vtkImageData. In this case, these 4 pieces can be collected together using a vtkMultiPieceDataSet. Note that vtkMultiPieceDataSet is intended to be included in other composite datasets eg. vtkMultiBlockDataSet, vtkHierarchicalBoxDataSet. Hence the lack of algorithms producting vtkMultiPieceDataSet.

Tests:
vtkMultiPieceDataSet (Tests)

Definition at line 42 of file vtkMultiPieceDataSet.h.

Member Typedef Documentation

Definition at line 46 of file vtkMultiPieceDataSet.h.

Constructor & Destructor Documentation

vtkMultiPieceDataSet::vtkMultiPieceDataSet ( )
protected
vtkMultiPieceDataSet::~vtkMultiPieceDataSet ( )
protected

Member Function Documentation

static vtkMultiPieceDataSet* vtkMultiPieceDataSet::New ( )
static
static int vtkMultiPieceDataSet::IsTypeOf ( const char *  type)
static
virtual int vtkMultiPieceDataSet::IsA ( const char *  type)
virtual

Reimplemented from vtkDataObjectTree.

static vtkMultiPieceDataSet* vtkMultiPieceDataSet::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkMultiPieceDataSet::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDataObjectTree.

vtkMultiPieceDataSet* vtkMultiPieceDataSet::NewInstance ( ) const
void vtkMultiPieceDataSet::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual int vtkMultiPieceDataSet::GetDataObjectType ( )
inlinevirtual

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

Reimplemented from vtkCompositeDataSet.

Definition at line 50 of file vtkMultiPieceDataSet.h.

void vtkMultiPieceDataSet::SetNumberOfPieces ( unsigned int  numpieces)

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

unsigned int vtkMultiPieceDataSet::GetNumberOfPieces ( )

Returns the number of pieces.

vtkDataSet* vtkMultiPieceDataSet::GetPiece ( unsigned int  pieceno)

Returns the piece at the given index.

vtkDataObject* vtkMultiPieceDataSet::GetPieceAsDataObject ( unsigned int  pieceno)

Returns the piece at the given index.

void vtkMultiPieceDataSet::SetPiece ( unsigned int  pieceno,
vtkDataObject piece 
)

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

int vtkMultiPieceDataSet::HasMetaData ( unsigned int  piece)
inline

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

Definition at line 73 of file vtkMultiPieceDataSet.h.

vtkInformation* vtkMultiPieceDataSet::GetMetaData ( unsigned int  pieceno)
inline

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

Definition at line 81 of file vtkMultiPieceDataSet.h.

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

Retrieve an instance of this class from an information object.

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

Retrieve an instance of this class from an information object.

virtual vtkInformation* vtkMultiPieceDataSet::GetMetaData ( vtkCompositeDataIterator iter)
inlinevirtual

Unhiding superclass method.

Reimplemented from vtkDataObjectTree.

Definition at line 95 of file vtkMultiPieceDataSet.h.

virtual int vtkMultiPieceDataSet::HasMetaData ( vtkCompositeDataIterator iter)
inlinevirtual

Unhiding superclass method.

Reimplemented from vtkDataObjectTree.

Definition at line 101 of file vtkMultiPieceDataSet.h.


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