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

abstract superclass for composite (multi-block or AMR) datasets More...

#include <vtkCompositeDataSet.h>

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

Public Types

typedef vtkDataObject Superclass
 
- Public Types inherited from vtkDataObject
typedef vtkObject Superclass
 
enum  FieldAssociations {
  FIELD_ASSOCIATION_POINTS, FIELD_ASSOCIATION_CELLS, FIELD_ASSOCIATION_NONE, FIELD_ASSOCIATION_POINTS_THEN_CELLS,
  FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, FIELD_ASSOCIATION_ROWS, NUMBER_OF_ASSOCIATIONS
}
 
enum  AttributeTypes {
  POINT, CELL, FIELD, POINT_THEN_CELL,
  VERTEX, EDGE, ROW, NUMBER_OF_ATTRIBUTE_TYPES
}
 
enum  FieldOperations { FIELD_OPERATION_PRESERVED, FIELD_OPERATION_REINTERPOLATED, FIELD_OPERATION_MODIFIED, FIELD_OPERATION_REMOVED }
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkCompositeDataSetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkCompositeDataIteratorNewIterator ()=0
 
virtual int GetDataObjectType ()
 
virtual void CopyStructure (vtkCompositeDataSet *input)=0
 
virtual void SetDataSet (vtkCompositeDataIterator *iter, vtkDataObject *dataObj)=0
 
virtual vtkDataObjectGetDataSet (vtkCompositeDataIterator *iter)=0
 
virtual unsigned long GetActualMemorySize ()
 
virtual void Initialize ()
 
virtual vtkIdType GetNumberOfPoints ()
 
virtual void ShallowCopy (vtkDataObject *src)
 
virtual void DeepCopy (vtkDataObject *src)
 
- Public Member Functions inherited from vtkDataObject
vtkDataObjectNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
unsigned long int GetMTime ()
 
void ReleaseData ()
 
unsigned long GetUpdateTime ()
 
void DataHasBeenGenerated ()
 
virtual void PrepareForNewData ()
 
virtual int GetExtentType ()
 
virtual void Crop (const int *updateExtent)
 
virtual vtkDataSetAttributes * GetAttributes (int type)
 
virtual vtkFieldData * GetAttributesAsFieldData (int type)
 
virtual int GetAttributeTypeForArray (vtkAbstractArray *arr)
 
virtual vtkIdType GetNumberOfElements (int type)
 
virtual vtkInformation * GetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual int GetDataReleased ()
 
virtual void SetFieldData (vtkFieldData *)
 
virtual vtkFieldData * GetFieldData ()
 
virtual void CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
 
void GlobalReleaseDataFlagOn ()
 
void GlobalReleaseDataFlagOff ()
 

Static Public Member Functions

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

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkCompositeDataSet ()
 
virtual ~vtkCompositeDataSet ()
 
- Protected Member Functions inherited from vtkDataObject
 vtkDataObject ()
 
 ~vtkDataObject ()
 

Additional Inherited Members

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

Detailed Description

abstract superclass for composite (multi-block or AMR) datasets

vtkCompositeDataSet is an abstract class that represents a collection of datasets (including other composite datasets). It provides an interface to access the datasets through iterators. vtkCompositeDataSet provides methods that are used by subclasses to store the datasets. vtkCompositeDataSet provides the datastructure for a full tree representation. Subclasses provide the semantics for it and control how this tree is built.

See Also
vtkCompositeDataIterator
Examples:
vtkCompositeDataSet (Examples)
Tests:
vtkCompositeDataSet (Tests)

Definition at line 49 of file vtkCompositeDataSet.h.

Member Typedef Documentation

Definition at line 52 of file vtkCompositeDataSet.h.

Constructor & Destructor Documentation

vtkCompositeDataSet::vtkCompositeDataSet ( )
protected
virtual vtkCompositeDataSet::~vtkCompositeDataSet ( )
protectedvirtual

Member Function Documentation

static int vtkCompositeDataSet::IsTypeOf ( const char *  type)
static
virtual int vtkCompositeDataSet::IsA ( const char *  type)
virtual
static vtkCompositeDataSet* vtkCompositeDataSet::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkCompositeDataSet::NewInstanceInternal ( ) const
protectedvirtual
vtkCompositeDataSet* vtkCompositeDataSet::NewInstance ( ) const
void vtkCompositeDataSet::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual vtkCompositeDataIterator* vtkCompositeDataSet::NewIterator ( )
pure virtual

Return a new iterator (the iterator has to be deleted by user).

Implemented in vtkDataObjectTree, vtkOverlappingAMR, vtkHierarchicalBoxDataSet, and vtkUniformGridAMR.

virtual int vtkCompositeDataSet::GetDataObjectType ( )
inlinevirtual

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

Reimplemented from vtkDataObject.

Reimplemented in vtkMultiBlockDataSet, vtkOverlappingAMR, vtkMultiPieceDataSet, vtkHierarchicalBoxDataSet, vtkUniformGridAMR, and vtkNonOverlappingAMR.

Definition at line 59 of file vtkCompositeDataSet.h.

virtual void vtkCompositeDataSet::CopyStructure ( vtkCompositeDataSet input)
pure virtual

Copies the tree structure from the input. All pointers to non-composite data objects are intialized to NULL. This also shallow copies the meta data associated with all the nodes.

Implemented in vtkUniformGridAMR, and vtkDataObjectTree.

virtual void vtkCompositeDataSet::SetDataSet ( vtkCompositeDataIterator iter,
vtkDataObject dataObj 
)
pure virtual

Sets the data set at the location pointed by the iterator. The iterator does not need to be iterating over this dataset itself. It can be any composite datasite with similar structure (achieved by using CopyStructure).

Implemented in vtkUniformGridAMR, and vtkDataObjectTree.

virtual vtkDataObject* vtkCompositeDataSet::GetDataSet ( vtkCompositeDataIterator iter)
pure virtual

Returns the dataset located at the positiong pointed by the iterator. The iterator does not need to be iterating over this dataset itself. It can be an iterator for composite dataset with similar structure (achieved by using CopyStructure).

Implemented in vtkUniformGridAMR, and vtkDataObjectTree.

virtual unsigned long vtkCompositeDataSet::GetActualMemorySize ( )
virtual

Return the actual size of the data in kilobytes. This number is valid only after the pipeline has updated.

Reimplemented from vtkDataObject.

Reimplemented in vtkDataObjectTree.

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

Retrieve an instance of this class from an information object.

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

Retrieve an instance of this class from an information object.

virtual void vtkCompositeDataSet::Initialize ( )
virtual

Restore data object to initial state,

Reimplemented from vtkDataObject.

Reimplemented in vtkDataObjectTree, and vtkUniformGridAMR.

virtual void vtkCompositeDataSet::ShallowCopy ( vtkDataObject src)
virtual

Shallow and Deep copy.

Reimplemented from vtkDataObject.

Reimplemented in vtkUniformGridAMR, and vtkDataObjectTree.

virtual void vtkCompositeDataSet::DeepCopy ( vtkDataObject src)
virtual

Shallow and Deep copy.

Reimplemented from vtkDataObject.

Reimplemented in vtkUniformGridAMR, and vtkDataObjectTree.

virtual vtkIdType vtkCompositeDataSet::GetNumberOfPoints ( )
virtual

Returns the total number of points of all blocks. This will iterate over all blocks and call GetNumberOfPoints() so it might be expansive.

Reimplemented in vtkDataObjectTree.

static vtkInformationStringKey* vtkCompositeDataSet::NAME ( )
static

Key used to put node name in the meta-data associated with a node.


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