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

#include <vtkMultiPieceDataSet.h>

Inheritance diagram for vtkMultiPieceDataSet:

Collaboration diagram for vtkMultiPieceDataSet:

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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkMultiPieceDataSet *	NewInstance () 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)

vtkDataObject *	GetPieceAsDataObject (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
vtkDataObjectTree *	NewInstance () const

virtual vtkDataObjectTreeIterator *	NewTreeIterator ()

virtual vtkCompositeDataIterator *	NewIterator ()

virtual void	CopyStructure (vtkCompositeDataSet *input)

virtual void	SetDataSet (vtkCompositeDataIterator iter, vtkDataObject dataObj)

void	SetDataSetFrom (vtkDataObjectTreeIterator iter, vtkDataObject dataObj)

virtual vtkDataObject *	GetDataSet (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
vtkCompositeDataSet *	NewInstance () const

Public Member Functions inherited from vtkDataObject
vtkDataObject *	NewInstance () const

unsigned long int	GetMTime ()

void	ReleaseData ()

unsigned long	GetUpdateTime ()

virtual void	CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))

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

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool 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)

vtkCommand *	GetCommand (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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(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)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkMultiPieceDataSet *	New ()

static int	IsTypeOf (const char *type)

static vtkMultiPieceDataSet *	SafeDownCast (vtkObjectBase *o)


static vtkMultiPieceDataSet *	GetData (vtkInformation *info)

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

Static Public Member Functions inherited from vtkDataObjectTree
static int	IsTypeOf (const char *type)

static vtkDataObjectTree *	SafeDownCast (vtkObjectBase *o)

static vtkDataObjectTree *	GetData (vtkInformation *info)

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

Static Public Member Functions inherited from vtkCompositeDataSet
static int	IsTypeOf (const char *type)

static vtkCompositeDataSet *	SafeDownCast (vtkObjectBase *o)

static vtkInformationStringKey *	NAME ()

static vtkInformationIntegerKey *	CURRENT_PROCESS_CAN_LOAD_BLOCK ()

static vtkCompositeDataSet *	GetData (vtkInformation *info)

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

Static Public Member Functions inherited from vtkDataObject
static vtkDataObject *	New ()

static int	IsTypeOf (const char *type)

static vtkDataObject *	SafeDownCast (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 vtkInformationIntegerVectorKey *	ALL_PIECES_EXTENT ()

static vtkInformationIntegerKey *	DATA_PIECE_NUMBER ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_PIECES ()

static vtkInformationIntegerKey *	DATA_NUMBER_OF_GHOST_LEVELS ()

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 vtkInformationIntegerVectorKey *	PIECE_EXTENT ()

static vtkInformationStringKey *	FIELD_NAME ()

static vtkInformationDoubleVectorKey *	ORIGIN ()

static vtkInformationDoubleVectorKey *	SPACING ()

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 vtkDataObject *	GetData (vtkInformation *info)

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

static void	SetGlobalReleaseDataFlag (int val)

static int	GetGlobalReleaseDataFlag ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

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)

vtkDataObject *	GetChild (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 ()

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

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Attributes inherited from vtkDataObjectTree
vtkDataObjectTreeInternals *	Internals

Protected Attributes inherited from vtkDataObject
vtkFieldData *	FieldData

int	DataReleased

vtkTimeStamp	UpdateTime

vtkInformation *	Information

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

typedef vtkDataObjectTree vtkMultiPieceDataSet::Superclass

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

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

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 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:

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/DataModel/vtkMultiPieceDataSet.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation