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

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

#include <vtkPartitionedDataSetCollection.h>

Inheritance diagram for vtkPartitionedDataSetCollection:
[legend]
Collaboration diagram for vtkPartitionedDataSetCollection:
[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
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.
 
vtkPartitionedDataSetCollectionNewInstance () 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.
 
vtkPartitionedDataSetGetPartitionedDataSet (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.
 
int HasMetaData (unsigned int idx)
 Returns true if meta-data is available for a given block.
 
vtkInformationGetMetaData (unsigned int idx)
 Returns the meta-data for the block.
 
vtkInformationGetMetaData (vtkCompositeDataIterator *iter) override
 Unhiding superclass method.
 
int 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.
 
vtkDataSetGetPartition (unsigned int idx, unsigned int partition)
 API to get/set partitions using a tuple index.
 
vtkDataObjectGetPartitionAsDataObject (unsigned int idx, unsigned int partition)
 API to get/set partitions using a tuple index.
 
virtual vtkDataAssemblyGetDataAssembly ()
 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 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.
 
vtkDataObjectTreeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual vtkDataObjectTreeIteratorNewTreeIterator ()
 Return a new iterator (the iterator has to be deleted by user).
 
vtkCompositeDataIteratorNewIterator () 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.
 
vtkDataObjectGetDataSet (vtkCompositeDataIterator *iter) override
 Returns the dataset located at the positiong pointed by the iterator.
 
virtual vtkInformationGetMetaData (vtkCompositeDataIterator *iter)
 Returns the meta-data associated with the position pointed by the iterator.
 
virtual int 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.
 
int GetDataObjectType () override
 Overridden to return VTK_DATA_OBJECT_TREE.
 
void RecursiveShallowCopy (vtkDataObject *src) override
 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.
 
vtkCompositeDataSetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual vtkCompositeDataIteratorNewIterator ()=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 vtkDataObjectGetDataSet (vtkCompositeDataIterator *iter)=0
 Returns the dataset located at the positiong 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,.
 
virtual void RecursiveShallowCopy (vtkDataObject *src)=0
 For historical reasons, vtkCompositeDataSet::ShallowCopy simply pass pointers to the leaf non-composite datasets.
 
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).
 
- 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.
 
vtkDataObjectNewInstance () 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 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 vtkDataSetAttributesGetAttributes (int type)
 Returns the attributes of the data object of the specified attribute type.
 
virtual vtkDataArrayGetGhostArray (int type)
 Returns the ghost arrays of the data object of the specified atribute type.
 
virtual vtkFieldDataGetAttributesAsFieldData (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 vtkInformationGetInformation ()
 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 int 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 vtkFieldDataGetFieldData ()
 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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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.
 
vtkCommandGetCommand (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.
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
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.
 
virtual 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.
 

Static Public Member Functions

static vtkPartitionedDataSetCollectionNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPartitionedDataSetCollectionSafeDownCast (vtkObjectBase *o)
 
static vtkPartitionedDataSetCollectionGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object.
 
static vtkPartitionedDataSetCollectionGetData (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 vtkDataObjectTreeSafeDownCast (vtkObjectBase *o)
 
static vtkDataObjectTreeGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object.
 
static vtkDataObjectTreeGetData (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 vtkCompositeDataSetSafeDownCast (vtkObjectBase *o)
 
static vtkInformationStringKeyNAME ()
 Key used to put node name in the meta-data associated with a node.
 
static vtkInformationIntegerKeyCURRENT_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 vtkCompositeDataSetGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object.
 
static vtkCompositeDataSetGetData (vtkInformationVector *v, int i=0)
 Retrieve an instance of this class from an information object.
 
- Static Public Member Functions inherited from vtkDataObject
static vtkDataObjectNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataObjectSafeDownCast (vtkObjectBase *o)
 
static vtkInformationGetActiveFieldInformation (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 vtkInformationGetNamedFieldInformation (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 vtkInformationSetActiveAttribute (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 vtkInformationStringKeyDATA_TYPE_NAME ()
 
static vtkInformationDataObjectKeyDATA_OBJECT ()
 
static vtkInformationIntegerKeyDATA_EXTENT_TYPE ()
 
static vtkInformationIntegerPointerKeyDATA_EXTENT ()
 
static vtkInformationIntegerVectorKeyALL_PIECES_EXTENT ()
 
static vtkInformationIntegerKeyDATA_PIECE_NUMBER ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKeyDATA_NUMBER_OF_GHOST_LEVELS ()
 
static vtkInformationDoubleKeyDATA_TIME_STEP ()
 
static vtkInformationInformationVectorKeyPOINT_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyCELL_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyVERTEX_DATA_VECTOR ()
 
static vtkInformationInformationVectorKeyEDGE_DATA_VECTOR ()
 
static vtkInformationIntegerKeyFIELD_ARRAY_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ASSOCIATION ()
 
static vtkInformationIntegerKeyFIELD_ATTRIBUTE_TYPE ()
 
static vtkInformationIntegerKeyFIELD_ACTIVE_ATTRIBUTE ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_COMPONENTS ()
 
static vtkInformationIntegerKeyFIELD_NUMBER_OF_TUPLES ()
 
static vtkInformationIntegerKeyFIELD_OPERATION ()
 
static vtkInformationDoubleVectorKeyFIELD_RANGE ()
 
static vtkInformationIntegerVectorKeyPIECE_EXTENT ()
 
static vtkInformationStringKeyFIELD_NAME ()
 
static vtkInformationDoubleVectorKeyORIGIN ()
 
static vtkInformationDoubleVectorKeySPACING ()
 
static vtkInformationDoubleVectorKeyDIRECTION ()
 
static vtkInformationDoubleVectorKeyBOUNDING_BOX ()
 
static vtkInformationDataObjectKeySIL ()
 
static vtkDataObjectGetData (vtkInformation *info)
 Retrieve an instance of this class from an information object.
 
static vtkDataObjectGetData (vtkInformationVector *v, int i=0)
 Retrieve an instance of this class from an information object.
 
static void SetGlobalReleaseDataFlag (int val)
 Turn on/off flag to control whether every object releases its data after being used by a filter.
 
static int 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 vtkObjectNew ()
 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 (int 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 int 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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkPartitionedDataSetCollection ()
 
 ~vtkPartitionedDataSetCollection () override
 
vtkDataObjectTreeCreateForCopyStructure (vtkDataObjectTree *other) override
 Overridden to create a vtkPartitionedDataSet whenever a vtkMultiPieceDataSet is encountered.
 
- Protected Member Functions inherited from vtkDataObjectTree
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDataObjectTree ()
 
 ~vtkDataObjectTree () override
 
void SetNumberOfChildren (unsigned int num)
 Set the number of children.
 
unsigned int GetNumberOfChildren ()
 Get 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.
 
vtkDataObjectGetChild (unsigned int index)
 Returns a child dataset at a given index.
 
vtkInformationGetChildMetaData (unsigned int index)
 Returns the meta-data at a given index.
 
void SetChildMetaData (unsigned int index, vtkInformation *info)
 Sets the meta-data at a given index.
 
int HasChildMetaData (unsigned int index)
 Returns if meta-data information is available for the given child index.
 
virtual vtkDataObjectTreeCreateForCopyStructure (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 vtkObjectBaseNewInstanceInternal () const
 
 vtkCompositeDataSet ()
 
 ~vtkCompositeDataSet () override
 
- Protected Member Functions inherited from vtkDataObject
virtual vtkObjectBaseNewInstanceInternal () 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 *)
 
 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
vtkDataObjectTreeInternalsInternals
 
- Protected Attributes inherited from vtkDataObject
vtkFieldDataFieldData
 
int DataReleased
 
vtkTimeStamp UpdateTime
 
vtkInformationInformation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- 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.

Definition at line 37 of file vtkPartitionedDataSetCollection.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 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 48 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]

int vtkPartitionedDataSetCollection::HasMetaData ( unsigned int  idx)
inline

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

Definition at line 104 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 111 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 144 of file vtkPartitionedDataSetCollection.h.

◆ HasMetaData() [2/2]

int vtkPartitionedDataSetCollection::HasMetaData ( vtkCompositeDataIterator iter)
inlineoverridevirtual

Unhiding superclass method.

Reimplemented from vtkDataObjectTree.

Definition at line 152 of file vtkPartitionedDataSetCollection.h.

◆ GetMTime()

vtkMTimeType vtkPartitionedDataSetCollection::GetMTime ( )
overridevirtual

Overridden to include DataAssembly MTime.

Reimplemented from vtkDataObject.

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