vtkPartitionedDataSet Class Reference

composite dataset to encapsulates a dataset consisting of partitions. More...

#include <vtkPartitionedDataSet.h>

Inheritance diagram for vtkPartitionedDataSet:

Collaboration diagram for vtkPartitionedDataSet:

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
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 }
	Possible values for the FIELD_ASSOCIATION information entry. More...
enum	AttributeTypes {   POINT , CELL , FIELD , POINT_THEN_CELL ,   VERTEX , EDGE , ROW , NUMBER_OF_ATTRIBUTE_TYPES }
	Possible attribute types. More...
enum	FieldOperations { FIELD_OPERATION_PRESERVED , FIELD_OPERATION_REINTERPOLATED , FIELD_OPERATION_MODIFIED , FIELD_OPERATION_REMOVED }
	Possible values for the FIELD_OPERATION information entry. More...
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkPartitionedDataSet *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
int	GetDataObjectType () override
	Return class name of data type (see vtkType.h for definitions).
void	SetNumberOfPartitions (unsigned int numPartitions)
	Set the number of partitions.
unsigned int	GetNumberOfPartitions ()
	Returns the number of partitions.
void	SetPartition (unsigned int idx, vtkDataObject *partition)
	Sets the data object as the given partition.
vtkTypeBool	HasMetaData (unsigned int idx)
	Returns true if meta-data is available for a given partition.
vtkInformation *	GetMetaData (unsigned int idx)
	Returns the meta-data for the partition.
vtkInformation *	GetMetaData (vtkCompositeDataIterator *iter) override
	Unhiding superclass method.
vtkTypeBool	HasMetaData (vtkCompositeDataIterator *iter) override
	Unhiding superclass method.
void	RemoveNullPartitions ()
	Removes all partitions that have null datasets and resizes the dataset.
vtkDataSet *	GetPartition (unsigned int idx)
	Returns the partition at the given index.
vtkDataObject *	GetPartitionAsDataObject (unsigned int idx)
	Returns the partition at the given index.
Public Member Functions inherited from vtkDataObjectTree
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkDataObjectTree *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual vtkDataObjectTreeIterator *	NewTreeIterator ()
	Return a new iterator (the iterator has to be deleted by user).
vtkCompositeDataIterator *	NewIterator () override
	Return a new iterator (the iterator has to be deleted by user).
void	CopyStructure (vtkCompositeDataSet *input) override
	Copies the tree structure from the input.
void	SetDataSet (vtkCompositeDataIterator *iter, vtkDataObject *dataObj) override
	Sets the data set at the location pointed by the iterator.
void	SetDataSetFrom (vtkDataObjectTreeIterator *iter, vtkDataObject *dataObj)
	Sets the data at the location provided by a vtkDataObjectTreeIterator.
vtkDataObject *	GetDataSet (vtkCompositeDataIterator *iter) override
	Returns the dataset located at the position pointed by the iterator.
virtual vtkInformation *	GetMetaData (vtkCompositeDataIterator *iter)
	Returns the meta-data associated with the position pointed by the iterator.
virtual vtkTypeBool	HasMetaData (vtkCompositeDataIterator *iter)
	Returns if any meta-data associated with the position pointed by the iterator.
unsigned long	GetActualMemorySize () override
	Return the actual size of the data in kibibytes (1024 bytes).
void	Initialize () override
	Restore data object to initial state,.
vtkIdType	GetNumberOfPoints () override
	Returns the total number of points of all blocks.
vtkIdType	GetNumberOfCells () override
	Returns the total number of cells of all blocks.
unsigned int	GetNumberOfChildren ()
	Get the number of children.
vtkDataObject *	GetChild (unsigned int index)
	Returns a child dataset at a given index.
vtkInformation *	GetChildMetaData (unsigned int index)
	Returns the meta-data at a given index.
vtkTypeBool	HasChildMetaData (unsigned int index)
	Returns if meta-data information is available for the given child index.
int	GetDataObjectType () override
	Overridden to return VTK_DATA_OBJECT_TREE.
virtual vtkDataObject *	GetDataSet (vtkCompositeDataIterator *iter)=0
	Returns the dataset located at the position pointed by the iterator.
virtual vtkDataObject *	GetDataSet (unsigned int flatIndex)
	Returns the dataset located at the position pointed by the flatIndex.
void	CompositeShallowCopy (vtkCompositeDataSet *src) override
	CompositeShallow, Shallow and Deep copy.
void	ShallowCopy (vtkDataObject *src) override
	CompositeShallow, Shallow and Deep copy.
void	DeepCopy (vtkDataObject *src) override
	CompositeShallow, Shallow and Deep copy.
Public Member Functions inherited from vtkCompositeDataSet
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkCompositeDataSet *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual vtkCompositeDataIterator *	NewIterator ()=0
	Return a new iterator (the iterator has to be deleted by user).
int	GetDataObjectType () override
	Return class name of data type (see vtkType.h for definitions).
virtual void	CopyStructure (vtkCompositeDataSet *input)
	Copies the tree structure from the input.
virtual void	SetDataSet (vtkCompositeDataIterator *iter, vtkDataObject *dataObj)=0
	Sets the data set at the location pointed by the iterator.
virtual vtkDataObject *	GetDataSet (vtkCompositeDataIterator *iter)=0
	Returns the dataset located at the position pointed by the iterator.
virtual vtkDataObject *	GetDataSet (unsigned int flatIndex)
	Returns the dataset located at the position pointed by the flatIndex.
unsigned long	GetActualMemorySize () override
	Return the actual size of the data in kibibytes (1024 bytes).
void	Initialize () override
	Restore data object to initial state,.
virtual void	CompositeShallowCopy (vtkCompositeDataSet *src)
	The goal of the method is to copy the data up to the dataset pointers only.
virtual vtkIdType	GetNumberOfPoints ()
	Returns the total number of points of all blocks.
virtual vtkIdType	GetNumberOfCells ()
	Returns the total number of cells of all blocks.
vtkIdType	GetNumberOfElements (int type) override
	Get the number of elements for a specific attribute type (POINT, CELL, etc.).
void	GetBounds (double bounds[6])
	Return the geometric bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).
bool	SupportsGhostArray (int type) override
	Returns true for POINT or CELL, false otherwise.
Public Member Functions inherited from vtkDataObject
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkDataObject *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkMTimeType	GetMTime () override
	Data objects are composite objects and need to check each part for MTime.
virtual void	Initialize ()
	Restore data object to initial state,.
void	ReleaseData ()
	Release data back to system to conserve memory resource.
virtual int	GetDataObjectType ()
	Return class name of data type.
vtkMTimeType	GetUpdateTime ()
	Used by Threaded ports to determine if they should initiate an asynchronous update (still in development).
virtual unsigned long	GetActualMemorySize ()
	Return the actual size of the data in kibibytes (1024 bytes).
virtual void	CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
	Copy from the pipeline information to the data object's own information.
virtual void	CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
	Copy information from this data object to the pipeline information.
void	DataHasBeenGenerated ()
	This method is called by the source when it executes to generate data.
virtual void	PrepareForNewData ()
	make the output data ready for new data to be inserted.
virtual void	ShallowCopy (vtkDataObject *src)
	The goal of the method is to copy the data up to the array pointers only.
virtual void	DeepCopy (vtkDataObject *src)
	The goal of the method is to copy the complete data from src into this object.
virtual int	GetExtentType ()
	The ExtentType will be left as VTK_PIECES_EXTENT for data objects such as vtkPolyData and vtkUnstructuredGrid.
virtual void	Crop (const int *updateExtent)
	This method crops the data object (if necessary) so that the extent matches the update extent.
virtual vtkDataSetAttributes *	GetAttributes (int type)
	Returns the attributes of the data object of the specified attribute type.
virtual vtkUnsignedCharArray *	GetGhostArray (int type)
	Returns the ghost arrays of the data object of the specified attribute type.
virtual bool	SupportsGhostArray (int type)
	Returns if this type of data object support ghost array for specified type.
virtual vtkFieldData *	GetAttributesAsFieldData (int type)
	Returns the attributes of the data object as a vtkFieldData.
virtual int	GetAttributeTypeForArray (vtkAbstractArray *arr)
	Retrieves the attribute type that an array came from.
virtual vtkIdType	GetNumberOfElements (int type)
	Get the number of elements for a specific attribute type (POINT, CELL, etc.).
virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this data object.
virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this data object.
virtual vtkTypeBool	GetDataReleased ()
	Get the flag indicating the data has been released.
virtual void	SetFieldData (vtkFieldData *)
	Assign or retrieve a general field data to this data object.
virtual vtkFieldData *	GetFieldData ()
	Assign or retrieve a general field data to this data object.
void	GlobalReleaseDataFlagOn ()
	Turn on/off flag to control whether every object releases its data after being used by a filter.
void	GlobalReleaseDataFlagOff ()
	Turn on/off flag to control whether every object releases its data after being used by a filter.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkPartitionedDataSet *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkPartitionedDataSet *	SafeDownCast (vtkObjectBase *o)
static vtkPartitionedDataSet *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object.
static vtkPartitionedDataSet *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object.
Static Public Member Functions inherited from vtkDataObjectTree
static vtkTypeBool	IsTypeOf (const char *type)
static vtkDataObjectTree *	SafeDownCast (vtkObjectBase *o)
static vtkDataObjectTree *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object.
static vtkDataObjectTree *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object.
Static Public Member Functions inherited from vtkCompositeDataSet
static vtkTypeBool	IsTypeOf (const char *type)
static vtkCompositeDataSet *	SafeDownCast (vtkObjectBase *o)
static vtkInformationStringKey *	NAME ()
	Key used to put node name in the meta-data associated with a node.
static vtkInformationIntegerKey *	CURRENT_PROCESS_CAN_LOAD_BLOCK ()
	Key used to indicate that the current process can load the data in the node.
template<class DataSetT = vtkDataSet>
static std::vector< DataSetT * >	GetDataSets (vtkDataObject *dobj, bool preserveNull=false)
	Extract datasets from the given data object.
static vtkCompositeDataSet *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object.
static vtkCompositeDataSet *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object.
Static Public Member Functions inherited from vtkDataObject
static vtkDataObject *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkDataObject *	SafeDownCast (vtkObjectBase *o)
static vtkInformation *	GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
	Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and attribute (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS)
static vtkInformation *	GetNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
	Return the information object within the input information object's field data corresponding to the specified association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS) and name.
static void	RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
	Remove the info associated with an array.
static vtkInformation *	SetActiveAttribute (vtkInformation *info, int fieldAssociation, const char *attributeName, int attributeType)
	Set the named array to be the active field for the specified type (SCALARS, VECTORS, NORMALS, TCOORDS, or TENSORS) and association (FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS).
static void	SetActiveAttributeInfo (vtkInformation *info, int fieldAssociation, int attributeType, const char *name, int arrayType, int numComponents, int numTuples)
	Set the name, array type, number of components, and number of tuples within the passed information object for the active attribute of type attributeType (in specified association, FIELD_ASSOCIATION_POINTS or FIELD_ASSOCIATION_CELLS).
static void	SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
	Convenience version of previous method for use (primarily) by the Imaging filters.
static const char *	GetAssociationTypeAsString (int associationType)
	Given an integer association type, this static method returns a string type for the attribute (i.e.
static int	GetAssociationTypeFromString (const char *associationName)
	Given a string association name, this static method returns an integer association type for the attribute (i.e.
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 *	DIRECTION ()
static vtkInformationDoubleVectorKey *	BOUNDING_BOX ()
static vtkInformationDataObjectKey *	SIL ()
static vtkDataObject *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object.
static vtkDataObject *	GetData (vtkInformationVector *v, int i=0)
	Retrieve an instance of this class from an information object.
static void	SetGlobalReleaseDataFlag (vtkTypeBool val)
	Turn on/off flag to control whether every object releases its data after being used by a filter.
static vtkTypeBool	GetGlobalReleaseDataFlag ()
	Turn on/off flag to control whether every object releases its data after being used by a filter.
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkPartitionedDataSet ()
	~vtkPartitionedDataSet () override
vtkDataObjectTree *	CreateForCopyStructure (vtkDataObjectTree *) override
	vtkPartitionedDataSet cannot contain non-leaf children.
Protected Member Functions inherited from vtkDataObjectTree
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkDataObjectTree ()
	~vtkDataObjectTree () override
void	SetNumberOfChildren (unsigned int num)
	Set the number of children.
void	SetChild (unsigned int index, vtkDataObject *)
	Set child dataset at a given index.
void	RemoveChild (unsigned int index)
	Remove the child at a given index.
void	SetChildMetaData (unsigned int index, vtkInformation *info)
	Sets the meta-data at a given index.
virtual vtkDataObjectTree *	CreateForCopyStructure (vtkDataObjectTree *other)
	When copying structure from another vtkDataObjectTree, this method gets called for create a new non-leaf for the other node.
Protected Member Functions inherited from vtkCompositeDataSet
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkCompositeDataSet ()
	~vtkCompositeDataSet () override
Protected Member Functions inherited from vtkDataObject
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkDataObject ()
	~vtkDataObject () override
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Protected Attributes inherited from vtkDataObjectTree
vtkDataObjectTreeInternals *	Internals
Protected Attributes inherited from vtkDataObject
vtkFieldData *	FieldData
vtkTypeBool	DataReleased
vtkTimeStamp	UpdateTime
vtkInformation *	Information
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

composite dataset to encapsulates a dataset consisting of partitions.

A vtkPartitionedDataSet dataset groups multiple datasets together. For example, say a simulation running in parallel on 16 processes generated 16 datasets that when considering together form a whole dataset. These are referred to as the partitions of the whole dataset. Now imagine that we want to load a volume of 16 partitions in a visualization cluster of 4 nodes. Each node could get 4 partitions, not necessarily forming a whole rectangular region. In this case, it is not possible to append the 4 partitions together into a vtkImageData. We can then collect these 4 partitions together using a vtkPartitionedDataSet.

It is required that all non-empty partitions have the same arrays and that they can be processed together as a whole by the same kind of filter. However, it is not required that they are of the same type. For example, it is possible to have structured datasets together with unstructured datasets as long as they are compatible meshes (i.e. can be processed together for the same kind of filter).

Tests:

vtkPartitionedDataSet (Tests)

Definition at line 39 of file vtkPartitionedDataSet.h.

Member Typedef Documentation

Superclass

typedef vtkDataObjectTree vtkPartitionedDataSet::Superclass

Definition at line 43 of file vtkPartitionedDataSet.h.

Constructor & Destructor Documentation

vtkPartitionedDataSet()

vtkPartitionedDataSet::vtkPartitionedDataSet ( )

protected

~vtkPartitionedDataSet()

vtkPartitionedDataSet::~vtkPartitionedDataSet ( )

overrideprotected

Member Function Documentation

New()

static vtkPartitionedDataSet * vtkPartitionedDataSet::New ( )

static

IsTypeOf()

static vtkTypeBool vtkPartitionedDataSet::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool vtkPartitionedDataSet::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.

Reimplemented in vtkMultiPieceDataSet.

SafeDownCast()

static vtkPartitionedDataSet * vtkPartitionedDataSet::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkPartitionedDataSet::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDataObjectTree.

Reimplemented in vtkMultiPieceDataSet.

NewInstance()

vtkPartitionedDataSet * vtkPartitionedDataSet::NewInstance

(

)

const

PrintSelf()

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

overridevirtual

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.

GetDataObjectType()

int vtkPartitionedDataSet::GetDataObjectType ( )

inlineoverridevirtual

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

Reimplemented from vtkDataObjectTree.

Definition at line 50 of file vtkPartitionedDataSet.h.

SetNumberOfPartitions()

void vtkPartitionedDataSet::SetNumberOfPartitions

(

unsigned int

numPartitions

)

Set the number of partitions.

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

GetNumberOfPartitions()

unsigned int vtkPartitionedDataSet::GetNumberOfPartitions

(

)

Returns the number of partitions.

GetPartition()

vtkDataSet * vtkPartitionedDataSet::GetPartition

(

unsigned int

idx

)

Returns the partition at the given index.

GetPartitionAsDataObject()

vtkDataObject * vtkPartitionedDataSet::GetPartitionAsDataObject

(

unsigned int

idx

)

Returns the partition at the given index.

SetPartition()

void vtkPartitionedDataSet::SetPartition	(	unsigned int	idx,
		vtkDataObject *	partition
	)

Sets the data object as the given partition.

The total number of partitions will be resized to fit the requested partition no.

HasMetaData() [1/2]

vtkTypeBool vtkPartitionedDataSet::HasMetaData ( unsigned int  idx )

inline

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

Definition at line 81 of file vtkPartitionedDataSet.h.

GetMetaData() [1/2]

vtkInformation * vtkPartitionedDataSet::GetMetaData ( unsigned int  idx )

inline

Returns the meta-data for the partition.

If none is already present, a new vtkInformation object will be allocated. Use HasMetaData to avoid allocating vtkInformation objects.

Definition at line 88 of file vtkPartitionedDataSet.h.

GetData() [1/2]

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

static

Retrieve an instance of this class from an information object.

GetData() [2/2]

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

static

Retrieve an instance of this class from an information object.

GetMetaData() [2/2]

vtkInformation * vtkPartitionedDataSet::GetMetaData ( vtkCompositeDataIterator *  iter )

inlineoverridevirtual

Unhiding superclass method.

Reimplemented from vtkDataObjectTree.

Definition at line 101 of file vtkPartitionedDataSet.h.

HasMetaData() [2/2]

vtkTypeBool vtkPartitionedDataSet::HasMetaData ( vtkCompositeDataIterator *  iter )

inlineoverridevirtual

Unhiding superclass method.

Reimplemented from vtkDataObjectTree.

Definition at line 109 of file vtkPartitionedDataSet.h.

RemoveNullPartitions()

void vtkPartitionedDataSet::RemoveNullPartitions

(

)

Removes all partitions that have null datasets and resizes the dataset.

Note any meta data associated with the null datasets will get lost.

CreateForCopyStructure()

vtkDataObjectTree * vtkPartitionedDataSet::CreateForCopyStructure ( vtkDataObjectTree *  )

inlineoverrideprotectedvirtual

vtkPartitionedDataSet cannot contain non-leaf children.

This ensures that we don't accidentally create them in CopyStructure

Reimplemented from vtkDataObjectTree.

Definition at line 128 of file vtkPartitionedDataSet.h.

---

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

• Common/DataModel/vtkPartitionedDataSet.h