Composite dataset that groups datasets as a collection. More...

#include <vtkPartitionedDataSetCollection.h>

Inheritance diagram for vtkPartitionedDataSetCollection:

Collaboration diagram for vtkPartitionedDataSetCollection:

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.

vtkPartitionedDataSetCollection *	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	SetNumberOfPartitionedDataSets (unsigned int numDataSets)
	Set the number of blocks.

unsigned int	GetNumberOfPartitionedDataSets () const
	Returns the number of blocks.

vtkPartitionedDataSet *	GetPartitionedDataSet (unsigned int idx) const
	Returns the block at the given index.

void	SetPartitionedDataSet (unsigned int idx, vtkPartitionedDataSet *dataset)
	Sets the data object as the given block.

void	RemovePartitionedDataSet (unsigned int idx)
	Remove the given block from the dataset.

unsigned int	GetNumberOfPartitions (unsigned int idx) const
	Returns the number of partitions in a partitioned dataset at the given index.

void	SetNumberOfPartitions (unsigned int idx, unsigned int numPartitions)
	Set number of partitions at a given index.

vtkTypeBool	HasMetaData (unsigned int idx)
	Returns true if meta-data is available for a given block.

vtkInformation *	GetMetaData (unsigned int idx)
	Returns the meta-data for the block.

vtkInformation *	GetMetaData (vtkCompositeDataIterator *iter) override
	Unhiding superclass method.

vtkTypeBool	HasMetaData (vtkCompositeDataIterator *iter) override
	Unhiding superclass method.

vtkMTimeType	GetMTime () override
	Overridden to include DataAssembly MTime.


void	SetPartition (unsigned int idx, unsigned int partition, vtkDataObject *object)
	API to get/set partitions using a tuple index.

vtkDataSet *	GetPartition (unsigned int idx, unsigned int partition)
	API to get/set partitions using a tuple index.

vtkDataObject *	GetPartitionAsDataObject (unsigned int idx, unsigned int partition)
	API to get/set partitions using a tuple index.


virtual vtkDataAssembly *	GetDataAssembly ()
	DataAssembly provides a way to define hierarchical organization of partitioned-datasets.

void	SetDataAssembly (vtkDataAssembly *assembly)
	DataAssembly provides a way to define hierarchical organization of partitioned-datasets.


unsigned int	GetCompositeIndex (unsigned int idx) const
	Returns the composite index (sometimes referred to as the flat-index) for either a partitioned dataset or a specific partition in a partitioned dataset.

unsigned int	GetCompositeIndex (unsigned int idx, unsigned int partition) const
	Returns the composite index (sometimes referred to as the flat-index) for either a partitioned dataset or a specific partition in a partitioned dataset.


void	CompositeShallowCopy (vtkCompositeDataSet *src) override
	Overridden to handle vtkDataAssembly.

void	ShallowCopy (vtkDataObject *src) override
	Overridden to handle vtkDataAssembly.

void	DeepCopy (vtkDataObject *src) override
	Overridden to handle vtkDataAssembly.

void	CopyStructure (vtkCompositeDataSet *input) override
	Overridden to handle vtkDataAssembly.

void	Initialize () override
	Overridden to handle vtkDataAssembly.

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

void	RecursiveShallowCopy (vtkDataObject *src) override

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.

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 void	RecursiveShallowCopy (vtkDataObject *src)

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 vtkPartitionedDataSetCollection *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkPartitionedDataSetCollection *	SafeDownCast (vtkObjectBase *o)


static vtkPartitionedDataSetCollection *	GetData (vtkInformation *info)
	Retrieve an instance of this class from an information object.

static vtkPartitionedDataSetCollection *	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

	vtkPartitionedDataSetCollection ()

	~vtkPartitionedDataSetCollection () override

vtkDataObjectTree *	CreateForCopyStructure (vtkDataObjectTree *other) override
	Overridden to create a vtkPartitionedDataSet whenever a vtkMultiPieceDataSet is encountered.

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 that groups datasets as a collection.

vtkPartitionedDataSetCollection is a vtkCompositeDataSet that stores a collection of non-null vtkPartitionedDataSets. These items can represent different concepts depending on the context. For example, they can represent region of different materials in a simulation or parts in an assembly. It is not requires that items have anything in common. For example, they can have completely different point or cell arrays.

Tests:: vtkPartitionedDataSetCollection (Tests)

Definition at line 29 of file vtkPartitionedDataSetCollection.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataObjectTree vtkPartitionedDataSetCollection::Superclass

Definition at line 33 of file vtkPartitionedDataSetCollection.h.

Constructor & Destructor Documentation

◆ vtkPartitionedDataSetCollection()

vtkPartitionedDataSetCollection::vtkPartitionedDataSetCollection ( )

protected

◆ ~vtkPartitionedDataSetCollection()

vtkPartitionedDataSetCollection::~vtkPartitionedDataSetCollection ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkPartitionedDataSetCollection * vtkPartitionedDataSetCollection::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkPartitionedDataSetCollection::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDataObjectTree.

◆ NewInstance()

vtkPartitionedDataSetCollection * vtkPartitionedDataSetCollection::NewInstance ( ) const

◆ PrintSelf()

void vtkPartitionedDataSetCollection::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 vtkPartitionedDataSetCollection::GetDataObjectType ( )

inlineoverridevirtual

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

Reimplemented from vtkDataObjectTree.

Definition at line 40 of file vtkPartitionedDataSetCollection.h.

◆ SetNumberOfPartitionedDataSets()

void vtkPartitionedDataSetCollection::SetNumberOfPartitionedDataSets ( unsigned int numDataSets )

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 with empty vtkPartitionedDataSetCollection instances.

◆ GetNumberOfPartitionedDataSets()

unsigned int vtkPartitionedDataSetCollection::GetNumberOfPartitionedDataSets ( ) const

Returns the number of blocks.

◆ GetPartitionedDataSet()

vtkPartitionedDataSet * vtkPartitionedDataSetCollection::GetPartitionedDataSet ( unsigned int idx ) const

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.

◆ SetPartitionedDataSet()

void vtkPartitionedDataSetCollection::SetPartitionedDataSet	(	unsigned int	idx,
		vtkPartitionedDataSet *	dataset
	)

Sets the data object as the given block.

The total number of blocks will be resized to fit the requested block no.

Remarks: dataset cannot be nullptr.

◆ RemovePartitionedDataSet()

void vtkPartitionedDataSetCollection::RemovePartitionedDataSet ( unsigned int idx )

Remove the given block from the dataset.

◆ SetPartition()

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

API to get/set partitions using a tuple index.

◆ GetPartition()

vtkDataSet * vtkPartitionedDataSetCollection::GetPartition	(	unsigned int	idx,
		unsigned int	partition
	)

API to get/set partitions using a tuple index.

◆ GetPartitionAsDataObject()

vtkDataObject * vtkPartitionedDataSetCollection::GetPartitionAsDataObject	(	unsigned int	idx,
		unsigned int	partition
	)

API to get/set partitions using a tuple index.

◆ GetNumberOfPartitions()

unsigned int vtkPartitionedDataSetCollection::GetNumberOfPartitions ( unsigned int idx ) const

Returns the number of partitions in a partitioned dataset at the given index.

◆ SetNumberOfPartitions()

void vtkPartitionedDataSetCollection::SetNumberOfPartitions	(	unsigned int	idx,
		unsigned int	numPartitions
	)

Set number of partitions at a given index.

Note, this will call SetNumberOfPartitionedDataSets if needed to grow the collection.

◆ HasMetaData() [1/2]

vtkTypeBool vtkPartitionedDataSetCollection::HasMetaData ( unsigned int idx )

inline

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

Definition at line 96 of file vtkPartitionedDataSetCollection.h.

◆ GetMetaData() [1/2]

vtkInformation * vtkPartitionedDataSetCollection::GetMetaData ( unsigned int idx )

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 103 of file vtkPartitionedDataSetCollection.h.

◆ GetDataAssembly()

virtual vtkDataAssembly * vtkPartitionedDataSetCollection::GetDataAssembly ( )

virtual

DataAssembly provides a way to define hierarchical organization of partitioned-datasets.

These methods provide access to the data assembly instances associated, if any.

◆ SetDataAssembly()

void vtkPartitionedDataSetCollection::SetDataAssembly ( vtkDataAssembly * assembly )

DataAssembly provides a way to define hierarchical organization of partitioned-datasets.

These methods provide access to the data assembly instances associated, if any.

◆ GetCompositeIndex() [1/2]

unsigned int vtkPartitionedDataSetCollection::GetCompositeIndex ( unsigned int idx ) const

Returns the composite index (sometimes referred to as the flat-index) for either a partitioned dataset or a specific partition in a partitioned dataset.

◆ GetCompositeIndex() [2/2]

unsigned int vtkPartitionedDataSetCollection::GetCompositeIndex	(	unsigned int	idx,
		unsigned int	partition
	)		const

Returns the composite index (sometimes referred to as the flat-index) for either a partitioned dataset or a specific partition in a partitioned dataset.

◆ GetData() [1/2]

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

static

Retrieve an instance of this class from an information object.

◆ GetData() [2/2]

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

static

Retrieve an instance of this class from an information object.

◆ GetMetaData() [2/2]

vtkInformation * vtkPartitionedDataSetCollection::GetMetaData ( vtkCompositeDataIterator * iter )

inlineoverridevirtual

Unhiding superclass method.

Reimplemented from vtkDataObjectTree.

Definition at line 136 of file vtkPartitionedDataSetCollection.h.

◆ HasMetaData() [2/2]

vtkTypeBool vtkPartitionedDataSetCollection::HasMetaData ( vtkCompositeDataIterator * iter )

inlineoverridevirtual

Unhiding superclass method.

Reimplemented from vtkDataObjectTree.

Definition at line 144 of file vtkPartitionedDataSetCollection.h.

◆ GetMTime()

vtkMTimeType vtkPartitionedDataSetCollection::GetMTime ( )

overridevirtual

Overridden to include DataAssembly MTime.

Reimplemented from vtkDataObject.

◆ CompositeShallowCopy()

void vtkPartitionedDataSetCollection::CompositeShallowCopy ( vtkCompositeDataSet * src )

overridevirtual

Overridden to handle vtkDataAssembly.

Reimplemented from vtkDataObjectTree.

◆ ShallowCopy()

void vtkPartitionedDataSetCollection::ShallowCopy ( vtkDataObject * src )

overridevirtual

Overridden to handle vtkDataAssembly.

Reimplemented from vtkDataObjectTree.

◆ DeepCopy()

void vtkPartitionedDataSetCollection::DeepCopy ( vtkDataObject * src )

overridevirtual

Overridden to handle vtkDataAssembly.

Reimplemented from vtkDataObjectTree.

◆ CopyStructure()

void vtkPartitionedDataSetCollection::CopyStructure ( vtkCompositeDataSet * input )

overridevirtual

Overridden to handle vtkDataAssembly.

Reimplemented from vtkDataObjectTree.

◆ Initialize()

void vtkPartitionedDataSetCollection::Initialize ( )

overridevirtual

Overridden to handle vtkDataAssembly.

Reimplemented from vtkDataObjectTree.

◆ CreateForCopyStructure()

vtkDataObjectTree * vtkPartitionedDataSetCollection::CreateForCopyStructure ( vtkDataObjectTree * other )

overrideprotectedvirtual

Overridden to create a vtkPartitionedDataSet whenever a vtkMultiPieceDataSet is encountered.

This is necessary since vtkPartitionedDataSetCollection cannot contain vtkMultiPieceDataSets

Reimplemented from vtkDataObjectTree.

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

Common/DataModel/vtkPartitionedDataSetCollection.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPartitionedDataSetCollection()

◆ ~vtkPartitionedDataSetCollection()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetDataObjectType()

◆ SetNumberOfPartitionedDataSets()

◆ GetNumberOfPartitionedDataSets()

◆ GetPartitionedDataSet()

◆ SetPartitionedDataSet()

◆ RemovePartitionedDataSet()

◆ SetPartition()

◆ GetPartition()

◆ GetPartitionAsDataObject()

◆ GetNumberOfPartitions()

◆ SetNumberOfPartitions()

◆ HasMetaData() [1/2]

◆ GetMetaData() [1/2]

◆ GetDataAssembly()

◆ SetDataAssembly()

◆ GetCompositeIndex() [1/2]

◆ GetCompositeIndex() [2/2]

◆ GetData() [1/2]

◆ GetData() [2/2]

◆ GetMetaData() [2/2]

◆ HasMetaData() [2/2]

◆ GetMTime()

◆ CompositeShallowCopy()

◆ ShallowCopy()

◆ DeepCopy()

◆ CopyStructure()

◆ Initialize()

◆ CreateForCopyStructure()